eShip API Docs

Authentication

The api-key must be included the headers for all API requests. The api-key can be obtained inside the eShip dashboard on Settings > api-key

Key

Value

Content-Type

application/json

api-key

eship_test...

Create a new label flow

First, you must POST on the "quotation" endpoint with the shipping information. Then, after choosing a desired rate from the returned array, you can use that "rate_id" for the "shipment" endpoint POST.

Quotation

Returns an array with the rates and services. Creates an orden in the panel of eShip with the data received.

Quotation

Parameters

address_from

array

required

Sender address.

name

string(35)

required

Sender's name.

company

string(35)

optional

Sender's company (optional).

street1

string(35)

required

Sender Address Line 1. Typically street and number (also inner numbers).

street2

string(35)

optional

Sender Address Line 2. Typically the zone or neighborhood (optional).

city

string(35)

required

Sender's City.

zip

string(35)

required

Sender's Postal / Zip Code.

state

string(35)

required

State or Province.

country

string(2)

required

Country (ISO 2 Code).

phone

string(35)

required

Sender's phone.

email

string(35)

optional

Sender's email.

address_to

array

required

Destination address.

name

string(35)

required

Receiver's name.

company

string(35)

optional

Receiver's company (optional).

street1

string(35)

required

Receiver Address Line 1. Typically street and number (also inner numbers).

street2

string(35)

optional

Receiver Address Line 2. Typically the zone or neighborhood (optional).

city

string(35)

required

City.

zip

string(35)

required

Receiver Postal / Zip Code.

state

string(35)

required

State or Province.

country

string(2)

required

Country (ISO 2 Code).

phone

string(35)

required

Receiver's phone.

email

string(35)

optional

Receiver's email.

parcels

array

required

Shipping Packages.

[0...25 Max]

array

require (at least one)

# of pieces.

length

decimal(10,2)

required

Length of the package.

width

decimal(10,2)

required

Width of the package.

height

decimal(10,2)

required

Height of the package.

distance_unit

"cm"

"in"

required

Distance unit: Centimeters (cm) or Inches (in).

weight

decimal(10,2)

required

Weight of the package.

mass_unit

"kg"

"lb"

required

Mass unit: Kilograms (kg) or Pounds (lb).

reference

string(35)

optional

Reference text for the package (for some carriers it will appear on the label).

items

array

optional

Shippment Items. Required for international shipments. For reference purposes on local shipments.

[0… 99 Max]

array

optional

quantity

integer

required

Quantity of items.

description

string(35)

required

Item's description.

SKU

string(35)

required

Item's SKU.

price

string(35)

required

Item's price.

weight

float

optional

Item's weight.

currency

'USD'

'MXN'

'EUR'

'NZD'

'GBP'

'BRL'

optional

Item's currency.

store_id

string(35)

optional

ID of store's product for fulfillment.

insurance

array

optional

Additional shipment insurance. Reimburse senders whose parcels are lost, stolen, and/or damaged in transit.

amount

decimal(10,2)

required

Amount to insure.

currency

'USD'

'EUR'

'NZD'

'GBP'

required

Currency of insurance.

order_info

array

optional

Aditional information of the order.

order_num

string(35)

optional

Order number of the store.

paid

boolean

optional

If payment is done is TRUE.

fulfilled

boolean

optional

If the order is shipped is TRUE.

store

string(35)

optional

eCommerce platforms where the order is created.

shipment

string(35)

optional

Type of shipment chosen by the client.

total_price

decimal(10,2)

optional

Total price of the purchase.

subtotal_price

decimal(10,2)

optional

Subtotal Price of the purchase.

total_tax

float

optional

Taxes of the purchase.

total_shipment

float

optional

Total price of the shipping.

store_id

string(35)

optional

ID of the order in the eCommerce platform. It is useful if store fulfillment is requiered.

custom_declaration

array

optional

contents_type

'GIFT'

'DOCUMENTS'

'SAMPLE'

'MERCHANDISE'

'HUMANITARIAN_DONATION'

'RETURN_MERCHANDISE'

'OTHER'

required

inconterm

'DDP'

'DDU'

required

exporter_reference

string(35)

optional

importer_reference

string(35)

optional

contents_explanation

string(35)

optional

invoice

string(35)

optional

license

string(35)

optional

certificate

string(35)

optional

notes

string(35)

optional

eel_pfc

'NOEEI_30_37_a'

'NOEEI_30_37_h'

'NOEEI_30_37_f'

'NOEEI_30_36'

'AES_ITN'

optional

non_delivery_option

'ABANDON'

'RETURN'

optional

certify

boolean

optional

certify_signer

string(35)

optional

save_order

boolean

optional

FALSE for not keeping order on the platform.

cod

float

optional

Cash on Delivery. Only available with Segmail Express services.

ship_date

datetime (yyyy-mm-dd hh:mm:ss)

optional

The date the package will be shipped.

notes

string(99)

optional

Additional notes for the messenger (Only with Segmail Express).

PROD: https://api.myeship.co/rest/quotation

TEST / QA: https://apiqa.myeship.co/rest/quotation

Request

JSON

Copied!

                                
    {
        "address_from":{
            "name":"Eric Garcia",
            "phone":"0120120120",
            "street1":"Algo 01",
            "city":"Mexico",
            "state":"CDMX",
            "country":"MX",
            "zip":"01090"
        },
        "address_to":{
            "name":"absa",
            "phone":"0120120120",
            "street1":"aldama 100",
            "state":"Coahuila",
            "city":"Saltillo",
            "country":"MX",
            "zip":"05320"
        },
        "parcels":[
            {
                "length":"10",
                "height":"10",
                "width":"10",
                "distance_unit":"cm",
                "weight":"1",
                "mass_unit":"kg",
                "reference":"Reference 1"
            }
        ]
    }

Quotation Response

Parameters

object_id

string

ID of the quote to recover.

Rates

array

Shipping packages.

[0… n]

array

# of pieces.

rate_id

string

ID of the rate.

provider

string

Courier provider.

provider_image_75

string

URL of the logo of Courier provider.

currency

string

Shipping currency.

days

integer

Estimated days-in-transit (natural days).

amount

decimal(10,2)

Total rate.

servicelevel

array

name

string

Service name.

token

string

Service token.

Quotation

Parameters

object_id

string

required

ID of the quote to recover.

Response

JSON

                                
{
    "object_id":"5ddd708511620",
    "rates": [
        {
            "rate_id":"5ddd708514e0f",
            "provider":"Segmail",
            "provider_image_75":"../assets/img/logo.png",
            "currency":"USD",
            "days":"1",
            "amount":"12.00",
            "servicelevel": {
                "name":"Día Siguiente",
                "token":"SME01"
            },
            "status":"SUCCESS"
        },
        {
            "rate_id":"5ddd708516067",
            "provider":"Segmail",
            "provider_image_75":"../assets/img/logo.png",
            "currency":"USD",
            "days":"0",
            "amount":"14.00",
            "servicelevel": {
                "name":"Mismo Día",
                "token":"SME02"
            },
            "status":"SUCCESS"
        },
        {
            "rate_id":"5ddd7085172b3",
            "provider":"Segmail",
            "provider_image_75":"../assets/img/logo.png",
            "currency":"USD",
            "days":"0",
            "amount":"17.00",
            "servicelevel": {
                "name":"Express",
                "token":"SME03"
            },
            "status":"SUCCESS"
        }
    ],
    "messages":[],
    "address_from": {
        "name":"Grupo Romo",
        "phone":"0120120120",
        "street1":"Algo 01",
        "city":"Mexico",
        "state":"CDMX",
        "country":"MX",
        "zip":"01090",
        "email":"",
        "company":"",
        "street2":""
    },
    "address_to": {
        "name":"absa",
        "phone":"0120120120",
        "street1":"aldama 100",
        "state":"Coahuila",
        "city":"Saltillo",
        "country":"MX",
        "zip":"05320",
        "email":"",
        "company":"",
        "street2":""
    },
    "parcels": [
        {
            "length":"10",
            "height":"10",
            "width":"10",
            "distance_unit":"cm",
            "weight":"1",
            "mass_unit":"kg",
            "reference":"Reference 1"
        }
    ],
    "extras": {
        "amount":"0",
        "ship_date":"2022-07-12 10:15:00",
        "currency":"USD",
        "notes":""
    },
    "items": [
        {
            "quantity":"1",
            "description":"White Pants",
            "SKU":"S1025",
            "price":"50",
            "weight":"0",
            "currency":"USD",
            "store_id":""
        }
    ]
}

Shipment

Creates a new shipment with the chosen service.

Shipment

Parameters

rate_id

string

required

ID of the chosen rate.

PROD: https://api.myeship.co/rest/shipment

TEST / QA: https://apiqa.myeship.co/rest/shipment

Request

JSON

Copied!

                                
{
    "rate_id":"5b182a90c3bb5"
}

Shipment Response

Parameters

object_id

string

ID of the transaction.

status

string

Status of the transaction.

label_url

string

URL where the PDF label is located.

tracking_number

string

Tracking number.

tracking_url_provider

string

Tracking link provided by the carrier.

tracking_url_custom

string

Customized tracking link by eShip.

commercial_invoice

boolean

If comercial invoice created.

commercial_invoice_url

string

URL to PDF of commercial invoice.

fulfillment

array

Data sent back to eCommerce platform.

status

string

Status of fulfillment.

store

string

eCommerce platform.

order_num

string

Order number in the platform.

piece_labels

array

In case a multipackages, each label.

[0… 25]

array

price_id

string

ID of the piece.

sequence_number

string

Number of the piece of the shipping.

label_url

string

URL where is located the PDF of the piece.

tracking_number

string

Shipping tracking number.

status

string

Tracking status of the piece.

substatus

string

Shipment global substatus (see substatus list).

status_details

string

Detail of the tracking status of the piece.

Response

JSON

                                
{
    "object_id":"617ee9cae390f",
    "status":"SUCCESS",
    "label_url":"https://s3.us-east-2.amazonaws.com/eship-prod/label/617ee9cae390f.pdf",
    "tracking_number":"3875992260",
    "commercial_invoice":"0",
    "tracking_url_provider":"http://www.dhl-usa.com/content/us/en/express/tracking.shtml?brand=DHL&AWB=3875992260",
    "tracking_url_custom":"https://track.myeship.co/track?no=3875992260",
    "commercial_invoice_url":"null",
    "fulfillment": {
        "status":"not fulfilled",
        "store":"",
        "order_num":"1234"
    }
}

Shipment

Parameters

object_id

string(10)

optional

Shipment ID to retrieve.

tracking_number

string(99)

optional

Estatus de la transacción.

order_number

string(99)

optional

Order number of the shipment.

PROD: https://api.myeship.co/rest/shipment?object_id=5b72e5342c5b5

TEST / QA: https://apiqa.myeship.co/rest/shipment?object_id=5b72e5342c5b5

Request

JSON

Copied!

                                
{
    "object_id":"6b72e5342c5b5",
    "status":"SUCCESS",
    "label_url":"https://api.myeship.co/label/5b72e5342c5b5.pdf",
    "provider": "FedEx",
    "service": "Express Saver",
    "tracking_number":"782291727586",
    "commercial_invoice":"0",
    "commercial_invoice_url":"",
    "tracking_url_provider":"https://www.fedex.com/apps/fedextrack/?trackingnumber=782291727586" ,
    "tracking_url_custom":"https://track.myeship.co/track?no=782291727586",
    "tracking": {
        "status":"UNKNOWN",
        "subestatus":"label_created",
        "status_details":"Shipment information sent to FedEx",
        "estimated_delivery":"2020-02-2421:00:00",
        "location":"",
        "timestamp":"2020-02-3104:30:21"
    }
}

Tracking Status

"UNKNOWN"

The label is created but before the package is dropped off or picked up by the carrier.

status

substatus

Description

Action Required

UNKNOWN

label_created

Information about the package received.

no

UNKNOWN

cancelled

Shipping label cancelled by sender.

no

UNKNOWN

other

Unrecognized carrier status.

no

“TRANSIT”

The package has been scanned by the carrier and is in transit.

status

substatus

Description

Action Required

TRANSIT

picked_up

The package has been scanned by the carrier.

no

TRANSIT

in_transit

Package between intermediate locations.

no

TRANSIT

processed

Package proccessed at intermediate location.

no

TRANSIT

at_customs

Package at customs location.

no

TRANSIT

out_for_delivery

Package is out for delivery.

no

TRANSIT

pickup_available

Package is available for pickup at carrier location.

yes

TRANSIT

delayed

Package delivery is delayed.

no

TRANSIT

scheduled

Package delivery has been scheduled.

no

TRANSIT

package_held

Package held at carrier location.

yes

“FAILURE”

The carrier indicated that there has been an issue with the delivery.

status

substatus

description

Action Required

FAILURE

delivery_issue

Package is not able to be delivered.

yes

FAILURE

address_issue

Address information is incorrect.

yes

FAILURE

package_lost

Package has been lost.

yes

FAILURE

package_damaged

Package has been damaged.

yes

FAILURE

package_disposed

Package has been disposed.

no

“DELIVERED”

The package has been successfully delivered.

status

substatus

Description

Action Requiered

DELIVERED

delivered

Package has been delivered.

no

“RETURNED”

The package is on route to be returned to the sender, or has been returned successfully.

status

substatus

Description

Action Requiered

RETURNED

returned

Package is to be returned to sender.

no

Batch Shipment

Creates label for the shipmentes with the chosen services. A PDF with all the labels is created.

Batch Shipment

Parameters

Rates

array

required

[0.. 10]

array

1 mimimum

ID of the rate.

PROD: https://api.myeship.co/rest/batch_shipment

TEST / QA: https://apiqa.myeship.co/rest/batch_shipment

Request

JSON

Copied!

                                
{
    "rates":[
    "5b2a77f48b1d0",
    "5b2a77f53e7a6" 
    ]
}

Batch Shipment Response

Parameters

object_id

string

ID of the batch.

batch_labels_url

string(35)

URL of PDF with the labels of the batch.

Status

string

Status of batch.

batch_labels

array

Transactions of every label.

[0… 10]

array

object_id

string

ID of the transaction.

Status

string

Status of the transaction.

label_url

string

URL of label's PDF.

tracking_number

string

Tracking number of the label.

tracking_url_provider

string

Tracking link provided by the carrier.

tracking_url_custom

string

Customized tracking link by eShip.

commercial_invoice

boolean

If commercial invoice.

commercial_invoice_url

string

URL of PDF of commercial invoice.

fulfillment

array

Data sent back to eCommerce platform.

status

string

Fulfillment status.

store

string

eCommerce platform.

order_num

string

Order number in the plataform.

label_results

array

Batch label generation results.

succeded

integer

How many labels were created succesfully.

failed

integer

How many lables were not created.

PROD: https://api.myeship.co/rest/batch_shipment

TEST / QA: https://api.myeship.co/rest/batch_shipment

                                
{
    "object_id":"5b2aadcf95852",
    "batch_labels_url":"https://s3.us-east-2.amazonaws.com/eship-prod/label/617ee9ca4390f.pdf",
    "status":"SUCCESS",
    "batch_labels": [
        {
        "object_id":"5b2aadd489139.pdf",
        "status":"SUCCESS",
        "label_url":"https://s3.us-east-2.amazonaws.com/eship-prod/label/627e2412ae2f.pdf",
        "tracking_number":"7628786384",
        "commercial_invoice":"0",
        "tracking_url_provider":"http://www.dhlusa.com/content/us/en/express/tracking.shtml?brand=DHL&AWB=7628786384",
        "commercial_invoice_url":"null",
        "fulfillment": {
            "status":"not fulfilled",
            "store":"",
            "order_num":"1234"
            }
        },
        {
        "object_id":"5b2aadd55e845.pdf",
        "status":"SUCCESS",
        "label_url":"https://s3.us-east-2.amazonaws.com/eship-prod/label/637fe9ca41901.pdf",
        "tracking_number":"4058675937537700626990",
        "tracking_url_provider":"http://estafeta.azurewebsites.net/Tracking/searchByGet/?wayBillType=1wayBill=4058675937537700626990",
        "commercial_invoice":"0",
        "commercial_invoice_url":"null",
        "fulfillment": {
            "status":"not fulfilled",
            "store":"",
            "order_num":"1234"
            }
        }
    ]
    "label_results": {
    "succeeded":"2",
    "failed":"0"
    }
}

Batch Shipment

Parameters

object_id

string

required

ID of batch to recover.

PROD: https://api.myeship.co/rest/batch_shipment?object_id=5b72e5342c5b5

TEST / QA: https://apiqa.myeship.co/rest/batch_shipment?object_id=5b72e5342c5b5

Request

JSON

Copied!

                                       
{
    "object_id":"5b73a0a3c18ce",
    "status":"SUCCESS",
    "batch_labels_url":"https://s3.us-east-2.amazonaws.com/eship-prod/label/617ee9ca4390f.pdf",
    "batch_shipments":"null",
    "label_results": {
        "succeeded":"2",
        "failed":"0"
    },
    "batch_labels": [
        {
            "object_id":"5b73a0a9cff7b"
            "status":"SUCCESS",
            "label_url":"https://s3.us-east-2.amazonaws.com/eship-prod/label/627e2412ae2f.pdf",
            "tracking_number":"7416867920",
            "commercial_invoice":"0",
            "commercial_invoice_url":"",
            "tracking_url_provider":"http://www.dhlusa.com/content/us/en/express/tracking.shtml?brand=DHL&AWB=7416867920",
            "tracking": {
                "status":"UNKNOWN",
                "subestatus":"label_created",
                "status_details":"Shipment information received"
            }
        },
        {
            "object_id":"5b73a0b3f3704",
            "status":"SUCCESS",
            "label_url":"https://s3.us-east-2.amazonaws.com/eship-prod/label/637fe9ca41901.pdf",
            "tracking_number":"7416868373",
            "commercial_invoice":"0",
            "commercial_invoice_url":"",
            "tracking_url_provider":"http://www.dhlusa.com/content/us/en/express/tracking.shtml?brand=DHL&AWB=7416868373",
            "tracking": {
                "status":"UNKNOWN",
                "subestatus":"label_created",
                "status_details":"Shipment information received"
            }
        }            
    ]
}

Label Settings

Settings to create the PDF label.

Label Settings

Parameters

label_format

'PDF'

'PDF_4x6'

required

PDF format of the label
For regular printers: “PDF”
For termal printers: “PDF_4x6”

label_firstline

string(35)

required

First text line on the label.
Use it for the order number, use: “*Order_Number*”

label_secondline

string(35)

required

Second text line on the label.

PROD: https://api.myeship.co/rest/label_settings

TEST / QA: https://apiqa.myeship.co/rest/label_settings

Request

JSON

Copied!

                                       

{
    "label_format":"PDF",
    "label_firstline":"*Order_Number*",
    "label_secondline":"Example"
}

Label Settings

PROD: https://api.myeship.co/rest/label_settings

TEST / QA: https://api.myeship.co/rest/label_settings

Request

JSON

Copied!

                                             
{
    "label_format":"PDF",
    "label_firstline":"*Order_Number*",
    "label_secondline":"Example"
}

Pickups

Schedule a pickup for one or more packages with the Courier desired.

Pickups

Parameters

courier

string(35)

required

Courier who will do the pickup.

weight

string(35)

required

Total weight of the packages.

mass_unit

string(2)

required

Unit of the total weight.

quantity

integer

required

Number of packages to pick up.

date

date (yyyy-mm-dd)

required

Date in which the pick up should be schedule.

time

hour (hh:mm)

required

First hour avalaible for the pick up.

closetime

hour (hh:mm)

required

Last hour avalaible for the pick up.

street1

string(35)

required

Line 1 of the address to pick up. Typically Street and number.

street2

string(35)

optional

Line 2 of the address to pick up. Typically colony (optional).

zip

string(35)

required

Zip code of the address to pick up.

city

string(35)

required

City of the pick up.

state

string(35)

required

State of the pick up.

country

string(35)

required

Country of the pick up.

name

string(35)

required

Name of the person responsable of the pick up.

company

string(35)

optional

Company responsable of the pick up.

phone

string(35)

required

Phone number of the person responsable of the pick up.

notes

string(35)

optional

Additional notes of the pick up.

PROD:https://api.myeship.co/rest/pickup

TEST / QA:https://apiqa.myeship.co/rest/pickup

Request

JSON

Copied!

                               
{
    "courier":"DHL",
    "weight":"5",
    "mass_unit":"kg",
    "quantity":"2",
    "date":"2019-05-02",
    "time":"10:00",
    "closetime":"16:00",
    "street1":"Paseo de los Tamarindos 90",
    "street2":"Bosques de las Lomas",
    "zip":"05120",
    "city":"CDMX",
    "state":"CDMX",
    "country":"MX",
    "name":"Alan Sanchez",
    "company":"Segmail",
    "phone":"5591350245",
    "notes":"En sotano 1, zona de proveedores"
}

Response

JSON

                                
{
    "status":"SUCCESS",
    "confirmation":"137848",
    "courier":"DHL",
    "date":"2019-05-02",
    "time":"10:00",
    "closetime":"CDMX",
    "weight":"5",
    "mass_unit":"kg",
    "quantity":"2",
    "street1":"Paseo de los Tamarindos 90",
    "street2":"Bosques de las Lomas",
    "zip":"05120",
    "city":"CDMX",
    "state":"CDMX",
    "country":"MX"
}

Users

Create and retrieve user information. To acccess this endpoint, you need to first request access to [email protected]

Users

Parameters

email

string(255)

requerido

Unique email for user.

name

string(255)

requerido

User's name.

phone

string(255)

requerido

User's mobile phone (required for carriers contact phone).

vendor

string(255)

Vendor attribute for Marketplace order assign.

carrier_ids

array

Array containing carrier IDs to assign

carrier_id

integer

Carrier ID for account to assign

PROD: https://api.myeship.co/rest/users

TEST / QA: https://apiqa.myeship.co/rest/users

Request

JSON

Copied

                                  
                                    
{
    "email":"[email protected]",
    "name":"John Doe",
    "phone":"5530706846",
    "vendor":"TEST",
    "carrier_ids": [
        1,
        2,
        3,
    ]
}

Response

JSON

                                
{
    "user_id": "9402",
    "email": "[email protected]",
    "phone": "5530706846",
    "company": "Tests",
    "vendor": "TEST"
}

Users

Parameters

user_id

string

User ID to recover.

PROD: https://api.myeship.co/rest/users

TEST / QA: https://apiqa.myeship.co/rest/users

Response

JSON

Copied

                                
{
    "user_id": "9402",
    "email": "[email protected]",
    "phone": "5530706846",
    "company": "Tests",
    "vendor": "TEST"
}

WEBHOOK

Recieve tracking status updates through post method to a custom URL. You can set this URL on the app Settings tab.

Tracking

Parameters

object_id

string(35)

Shipment unique id.

tracking_number

string(35)

Shipment tracking number.

order_number

string(35)

Order number associated with the shipmen.

status

string(35)

Shipment global status (see status list).

substatus

string(35)

Shipment global substatus (see substatus list).

status_details

string(35)

Shipment status details text.

timestamp

datetime

Date in which the checkpoint was created.

estimated_delivery

datetime

Shipment estimated delivery date.

location

string(35)

Last checkpoint location.

Webhook Body:

Copied!

                                                                                
{
    "object_id":"60e37902e86e1",
    "tracking_number":"281115007045",
    "order_number":"#12241",
    "status":"TRANSIT",
    "substatus":"picked_up",
    "status_details":"Package picked up.",
    "timestamp":"2021-07-06 17:56:00",
    "estimated_delivery":"2021-07-08 21:00:00",
    "location":"SAN DIEGO, US"
}

Webhook ejemplo: