Shipment Booking

This service allows you to book a single shipment.

Do not forget to authenticate your request,

Request body Parameters

Shipment Parameters

Request Parameters

Parameter	Required	Type	Rules	Description
reference	No	String		Shipment reference
shipperName	Yes	String	Must be alphanumeric and must be between 3 and 32 characters long	Shipper Name
shipperPhone	Yes	String	Must be a valid phone number	Shipper phone Number
shipperCountry	Yes	String	Must be an iso 2 digit country code	Shipper country
shipperState	Yes	String	Must be alphanumeric	Shipper State/Province
shipperCity	Yes	String	Must be alphanumeric	Shipper City
shipperPostCode	Yes	String	Must be alphanumeric	Shipper Post Code
shipperAddress1	Yes	String	Must be alphanumeric and must be between 5 and 32 characters long	Shipper Address Line 1
shipperAddress2	No	String	Must be alphanumeric and must be between 5 and 32 characters long	Shipper Address Line 2
consigneeName	Yes	String	Must be alphanumeric and must be between 3 and 32 characters long	Consignee Name
consigneePhone	Yes	String	Must be a valid phone number	Consignee Phone Number
consigneeCountry	Yes	String	Must be an iso 2 digit country code	Consignee country
consigneeState	Yes	String	Must be alphanumeric	Consignee State/Province
consigneeCity	Yes	String	Must be alphanumeric	Consignee City
consigneePostCode	Yes	String	Must be alphanumeric	Consignee Post Code
consigneeAddress1	Yes	String	Must be alphanumeric and must be between 5 and 32 characters long	Consignee Address Line 1
consigneeAddress2	No	String	Must be alphanumeric and must be between 5 and 32 characters long	Consignee Address Line 2
packageType	Yes	String	Must be either 'PACKAGE' or 'DOCUMENT'	Shipment Package Type
serviceCode	No	String	If your account is set to direct booking, then this is required.	Shipment Service Code
currency	Yes	String	Must be a valid ISO 4217 currency code	Shipment deceleration currency
items	Yes	Array	Check Items Table	Shipment Product Information
boxes	Yes	Array	Check Boxes Table	Shipment Box Information

Items

Items Parameters

Items are the products that you would like to ship.

Parameter	Required	Type	Rules	Description
hs	Yes	String	Must be numerical and between 5 and 12 digits long	Product HS Code
description	Yes	String	Must be alphanumerical and between 3 and 32 characters long	Product Description
value	Yes	Number	Must be number	Product Value
quantity	Yes	Number	Must be number	Product Quantity
weight	Yes	Number	Must be number, Must be in KG	Product Weight

Boxes

Box Parameters

Boxes are considered the wrapping containers of your products. The total quantity of boxes will dictate how many labels you will get to print.

Parameter	Required	Type	Rules	Description
width	Yes	Number	Must be number, Must be in CM	Box Width
length	Yes	Number	Must be number, Must be in CM	Box Length
height	Yes	Number	Must be number, Must be in CM	Box Height
weight	Yes	Number	Must be number, Must be in KG	Box Weight
quantity	Yes	Number	Must be number	Box Quantity

Document

Documents Shipment

If your shipment is a document, make sure that you set the packageType as 'DOCUMENT', and use the bellow items and boxes as an example.
If you would like to ship all of your documents together, Use one box object and set the dimensions as the largest document dimensions. Use the total weight of all of your documents.

  "items": [
            {
                "hs": "48021000", // Use this HS code
                "description": "Certificate of birth", // Describe the document
                "value": 10.2, // Provide the appropriate value
                "quantity": 2, // Provide the number of documents
                "weight": 0.4 // Provide the appropriate weight
            }
        ],
        "boxes": [
            {
                "width": 20, // Provide the dimensions of your document
                "length": 15, // Provide the dimensions of your document
                "height": 15, // Provide the dimensions of your document
                "weight": 1, // Provide the appropriate weight
                "quantity": 1 // Provide the number of your documents
            }
        ]

Request

Request URL :

https://srv.eliexpress.com.tr/api/v2/client-integration/new-shipment

Request Method :

POST

Content-Type :

application/json

Request Body :

{
    "shipment": {
        "reference": "ABCD123456789",
        "shipperName": "John Doe",
        "shipperPhone": "902124703737",
        "shipperCountry": "TR",
        "shipperState": "Istanbul",
        "shipperCity": "Kucukcekmece",
        "shipperPostCode": "34303",
        "shipperAddress1": "Halkali Merkez Mahallesi",
        "shipperAddress2": "Tuna Caddesi, Hekim Sokak No:16",
        "consigneeName": "Jane Doe",
        "consigneePhone": "61212345678",
        "consigneeCountry": "AU",
        "consigneeState": "Queensland",
        "consigneeCity": "Pimpama",
        "consigneePostCode": "4209",
        "consigneeAddress1": "Mrs Smith 98 Shirley Street",
        "packageType": "PACKAGE",
        "currency": "USD",
        "items": [
            {
                "hs": "62171070",
                "description": "Socks",
                "value": 10.2,
                "quantity": 2,
                "weight": 0.4
            }
        ],
        "boxes": [
            {
                "width": 20,
                "length": 15,
                "height": 15,
                "weight": 1,
                "quantity": 1
            }
        ],
        serviceCode :"1"
    }
}

Response

Response Body :

✅

I your shipment booking was successful, the server will respond with a success true, and the tracking number of your shipment.

{
    "success": true,
    "message": "Shipment booking successful",
    "trackingNumber": "ELI1654937293642O"
}

❌

If you failed to authenticate the server will respond with a request unauthorized message.

{
  "success": false,
  "message": "Request Unauthorized"
}

If your shipment booking was unsuccessful, the server will response with a success false, and a list of errors.

{
    "success": false,
    "message": "Bad shipment data provided",
    "errors": [
        "Shipper name must be alphanumeric",
        "Shipper state must be alphanumeric",
        "Shipper city must be alphanumeric",
        "Shipper postcode must be alphanumeric",
        "Shipper address line 1 must be between 5 and 32 characters long",
        "If provided, shipper address line 2 must be between 5 and 32 characters long",
        "Consignee name must be between 3 and 32 characters long",
        "Consignee country must be an iso 2 digit country code",
        "Consignee state must be alphanumeric",
        "Consignee city must be alphanumeric",
        "Consignee postcode must be alphanumeric",
        "Shipment package type must be either PACKAGE or DOCUMENT",
        "Shipment deceleration currency must be a valid ISO 4217 currency code",
        "Shipment item 1 HS code must be numerical",
        "Shipment item 1 value must be a number",
        "Shipment item 1 quantity must be a number",
        "Shipment item 1 weight must be a number",
        "Shipment box 1 weight must be a number",
        "Shipment box 1 width must be a number",
        "Shipment box 1 length must be a number",
        "Shipment box 1 height must be a number",
        "Shipment box 1 quantity must be a number"
    ]
}

Depending on your account type the server might respond with a success false stating that you do not have access to ship to that country. In that case please contact Eli in order to resolve this issue.

{
    "success": false,
    "message": "You do not have access to ship to this country, please contact eli if this is a problem"
}

Shipment Booking

Request body Parameters​

Shipment Parameters​

Items​

Boxes​

Document​

Request​

Request URL :​

Request Method :​

Content-Type :​

Request Body :​

Response​

Response Body :​