Español

Log In Registro

Quotations

Regresa un arreglo con los servicios y tarifas. Genera una orden en el panel de eShip con los datos recibidos.

Quotation

Esquema del cuerpo de la solicitud

address_from

array

requerido

Dirección del remitente.

name

string(35)

requerido

Nombre del remitente.

company

string(35)

opcional

Empresa del remitente.

street1

string(35)

requerido

Línea de Dirección 1. Normalmente la calle y número (exterior e interior).

street2

string(35)

opcional

Línea de Dirección 2. Normalmente la colonia.

city

string(35)

requerido

Ciudad.

zip

string(35)

requerido

Código postal.

state

string(35)

requerido

Estado o Provincia.

country

string(2)

requerido

País (Formato ISO 2).

phone

string(35)

requerido

Teléfono del cliente.

email

string(35)

opcional

Correo electrónico del cliente.

address_to

array

requerido

Dirección de destino.

name

string(35)

requerido

Nombre del destinatario.

company

string(35)

opcional

Empresa del destinatario.

street1

string(35)

requerido

Línea de Dirección 1. Normalmente la calle y número.

street2

string(35)

opcional

Línea de Dirección 2. Normalmente la colonia.

city

string(35)

requerido

Ciudad del destinatario.

zip

string(35)

requerido

Código postal del destinatario.

state

string(35)

requerido

Estado o Provincia del destinatario.

country

string(2)

requerido

País del destinatario (formato ISO 2 dígitos).

phone

string(35)

requerido

Teléfono del destinatario.

email

string(35)

opcional

Email del destinatario.

parcels

array

requerido

Paquetes del envío.

[0...25 Max]

array

require (at least one)

No. de pieza.

length

float(10,2)

requerido

Largo de la pieza.

width

float(10,2)

requerido

Ancho de la pieza.

height

float(10,2)

requerido

Alto de la pieza.

distance_unit

"cm"

"in"

requerido

Unidad de distancia. Centimetros (cm) o Pulgadas (in).

weight

float(10,2)

requerido

Peso del paquete.

mass_unit

"kg"

"lb"

requerido

Unidad de peso: Kilogramos (kg) o Libras (lb).

reference

string(35)

opcional

Texto adicional de referencia para el paquete (aparecerá en algunas guías).

items

array

opcional

Productos en envío. Obligatorio para envíos internacionales. De referencia para envíos locales.

[0… 99 Max]

array

opcional

quantity

integer

requerido

Cantidad de productos.

description

string(35)

requerido

Descripción del producto.

SKU

string(35)

requerido

SKU del producto.

price

string(35)

requerido

Precio del producto.

weight

float

opcional

Peso del producto.

currency

'MXN'

'USD'

'EUR'

'NZD'

'GBP'

'BRL'

opcional

Moneda del precio del producto.

store_id

string(35)

opcional

ID del producto en la tienda para hacer el fulfillment.

insurance

array

opcional

Seguro adicional a los paquetes del envío.

amount

float(10,2)

requerido

Cantidad por asegurar.

currency

'MXN'

'USD'

'EUR'

'NZD'

'GBP'

requerido

Moneda del seguro.

order_id

integer

optional

En caso de que ya exista una órden, se puede tomar para generar la cotización sobre la misma.

order_info

array

opcional

El sistema creará una orden de manera automática. A continuación puedes especificar los detalles de la orden.

order_num

string(35)

opcional

Número de orden en la tienda.

status

integer

opcional

Indica alguno de los siguientes estatus:

0 - Unfulfilled

1 - Fulfilled

2 - Fulfilled Parcial

3 - Enviado

4 - Cancelado

5 - En Proceso

6 - En Espera

7 - Backorder

8 - Entregado

9 - Retorno Solicitado

paid

integer

opcional

Indica alguno de los siguientes estatus de pago:

0 - Pago Pendiente

1 - Pagado

2 - Parcialmente Pagado

3 - Reembolsado

store

string(35)

opcional

La plataforma de eCommerce donde se creó la orden.

shipment_type

string(35)

opcional

Tipo de envío seleccionado por el cliente.

total_price

float(10,2)

opcional

Precio total de la compra.

subtotal_price

float(10,2)

opcional

Subtotal de la compra.

total_tax

float

opcional

Impuestos en la compra.

total_shipment

float

opcional

Precio total del envío.

store_id

string(35)

opcional

ID de la orden en la plataforma de eCommerce. Es útil si se quiere hacer el fulfillment en la tienda.

custom_declaration

array

opcional

contents_type

'GIFT'

'DOCUMENTS'

'SAMPLE'

'MERCHANDISE'

'HUMANITARIAN_DONATION'

'RETURN_MERCHANDISE'

'OTHER'

requerido

inconterm

'DDP'

'DDU'

requerido

exporter_reference

string(35)

opcional

importer_reference

string(35)

opcional

contents_explanation

string(35)

opcional

invoice

string(35)

opcional

license

string(35)

opcional

certificate

string(35)

opcional

notes

string(35)

opcional

eel_pfc

'NOEEI_30_37_a'

'NOEEI_30_37_h'

'NOEEI_30_37_f'

'NOEEI_30_36'

'AES_ITN'

opcional

non_delivery_option

'ABANDON'

'RETURN'

opcional

certify

boolean

opcional

certify_signer

string(35)

opcional

save_order

boolean

opcional

FALSE para no guardar la orden en la plataforma.

cod

float

opcional

Cobro en efectivo a la entrega (Cash on Delivery). Solo disponible con los servicios de Segmail Express.

ship_date

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

opcional

Fecha para el envío.

notes

string(99)

opcional

Notas adicionales para el mensajero (Solo con Segmail Express).

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

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

Solicitud

JSON

Copiado

                                
    {
        "address_from": {
            "name":"Juan de la Barrera",
            "company": "Colegio Militar",
            "email":"[email protected]",
            "phone":"55 9135 0245",
            "street1":"Paseo de los Tamarindos 90",
            "street2":"Bosques de las Lomas",
            "city":"Cuajimalpa",
            "state": "CDMX",
            "country": "MX",
            "zip": "05120"
        },
        "address_to": {
            "name":"Juan Escutia",
            "company": "Colegio Militar",
            "email":"[email protected]",
            "phone":"55 9135 0245",
            "street1":"Jesús del Monte 42",
            "street2":"Hacienda de las Palmas",
            "city":"Huixquilucan",
            "state":"MEX",
            "country":"MX",
            "zip":"52763"
        },
        "parcels":[
            {
                "length":30,
                "height":20,
                "width":10,
                "distance_unit":"cm",
                "weight":1,
                "mass_unit":"kg",
                "reference":"Reference 1"
            }
        ],
        "order_info":{
            "order_num":"BA12041",
            "shipment_type":"Next Day",
            "status":0,
            "paid":1
        }
    }

Quotation Response

Esquema del cuerpo de la respuesta

quot_id

string

ID de la cotización.

Rates

array

Paquetes del envío.

[0… n]

array

No. de pieza.

rate_id

string

ID de la tarifa.

provider

string

Proveedor del servicio.

provider_image_75

string

URL del logo del proveedor del servicio.

currency

string

Moneda del precio.

days

integer

Tiempo estimado de entrega en días naturales.

amount

float(10,2)

Costo del envío.

servicelevel

array

name

string

Nombre del servicio.

token

string

Token del servicio.

tags

array

'BESTVALUE'

'CHEAPEST'

'FASTEST'

Atributos de la tarifa (mejor valor, más barata y/o más rápida).

messages

array

Mensaje del courier en la cotización.

[0… n]

array

source

string

Courier.

text

string

Cuerpo del mensaje.

Respuesta

JSON

                                
    {
        "object_id":"5b2a77f16b12a",
        "rates": [
            {
                "rate_id":"5b2a77f48b1d0",
                "provider":"DHL Express",
                "provider_image_75":"https://myeship.co/assets/img/dhl_75.png",
                "currency":"MXN",
                "days":"1",
                "amount":"181.40",
                "servicelevel": {
                    "name":"EXPRESS DOMESTIC",
                    "token":"N/N"
                },
                "tags": [
                    "BESTVALUE",
                    "FASTEST"
                ]
            },
            {
                "rate_id":"5b2a77f53e7a6",
                "provider":"Estafeta",
                "provider_image_75":"https://myeship.co/assets/img/estafeta_75.png",
                "currency":"MXN",
                "days":"3",
                "amount":"159.83",
                "servicelevel": {
                        "name":"Terrestre",
                        "token": "estafeta_3"
                },
                "tags": [
                    "CHEAPEST"
                ]
            }
        ],
        "messages": [],
        "address_from": {
            "name":"Juan de la Barrera",
            "company": "Colegio Militar",
            "email":"[email protected]",
            "phone":"55 9135 0245",
            "street1":"Paseo de losTamarindos 90",
            "street2":"Bosques de lasLomas",
            "city":"Cuajimalpa",
            "state": "CDMX",
            "country": "MX",
            "zip": "05120"
        },
        "address_to": {
            "name":"Juan Escutia",
            "company": "Colegio Militar",
            "email":"[email protected]",
            "phone":"55 9135 0245",
            "street1":"Jesús del Monte 39",
            "street2":"Hacienda de las Palmas",
            "city":"Huixquilucan",
            "state":"MEX",
            "country":"MX",
            "zip":"52763"
        },
        "parcels": [
            { 
                "length":30,
                "width":20,
                "height":10,
                "distance_unit":"cm",
                "weight":1,
                "mass_unit":"kg"
            }
        ],
        "insurance": {
            "amount":"0",
            "currency":"MXN"
        },
        "items": [
            {
                "quantity":"3",
                "description":"White Pants",
                "SKU":"S1025",
                "price":"100",
                "weight":"10",
                "currency":"1",
                "store_id":""
            }
        ],
        "customs_declaration": {
            "contents_type":"MERCHANDISE",
            "incoterm":"DDU",
            "exporter_reference":"",
            "importer_reference":"",
            "contents_explanation":"",
            "invoice":"",
            "license":"",
            "certificate":"",
            "notes":"",
            "eel_pfc":"NOEEI_30_36",
            "non_delivery_option":"RETURN",
            "certify":"1",
            "certify_signer":"Juan Escutia"
        }
    }

Quotation

Parámetros

quot_id

string

requerido

ID de la cotización a recuperar.

Respuesta

JSON

                                
{
    "object_id":"5ddd708511620",
    "rates": [
        {
            "rate_id":"5ddd708514e0f",
            "provider":"UPS",
            "provider_image_75":"https://app.myeship.co/assets/img/logo.png",
            "currency":"USD",
            "days":2,
            "amount":"124.00",
            "servicelevel": {
                "name":"Standard",
                "token":"UPS01"
            },
            "tags": [
                "CHEAPEST",
                "BESTVALUE"
            ]
            "status":"SUCCESS"
        },
        {
            "rate_id":"5ddd708516067",
            "provider":"UPS",
            "provider_image_75":"https://app.myeship.co/assets/img/logo.png",
            "currency":"USD",
            "days":1,
            "amount":"144.00",
            "servicelevel": {
                "name":"Express Saver",
                "token":"UPS02"
            },
            "tags": [
                "FASTEST",
            ]
            "status":"SUCCESS"
        },
        {
            "rate_id":"5ddd7085172b3",
            "provider":"FedEx",
            "provider_image_75":"https://app.myeship.co/assets/img/logo.png",
            "currency":"USD",
            "days":4,
            "amount":"179.00",
            "servicelevel": {
                "name":"Priority",
                "token":"FDX01"
            },
            "status":"SUCCESS"
        }
    ],
    "messages":[],
    "address_from": {
        "name":"Juan de la Barrera",
        "company": "Colegio Militar",
        "email":"[email protected]",
        "phone":"55 9135 0245",
        "street1":"Paseo de losTamarindos 90",
        "street2":"Bosques de lasLomas",
        "city":"Cuajimalpa",
        "state": "CDMX",
        "country": "MX",
        "zip": "05120"
    },
    "address_to": {
        "name":"Juan Escutia",
        "company": "Colegio Militar",
        "email":"[email protected]",
        "phone":"55 9135 0245",
        "street1":"Jesús del Monte 39",
        "street2":"Hacienda de las Palmas",
        "city":"Huixquilucan",
        "state":"MEX",
        "country":"MX",
        "zip":"52763"
    },
    "parcels": [
        {
            "length":30,
            "height":20,
            "width":10,
            "distance_unit":"cm",
            "weight":1,
            "mass_unit":"kg",
            "reference":"Reference 1"
        }
    ],
    "extras": {
        "amount":"0",
        "ship_date":"2023-07-12 10:15:00",
        "currency":"MXN",
        "notes":""
    },
    "items": [
        {
            "quantity":"1",
            "description":"White Pants",
            "SKU":"S1025",
            "price":"50",
            "weight":"0",
            "currency":"MXN",
            "store_id":""
        }
    ]
}

Shipment

Generar la guía para el envío con el servicio elegido.

Shipment

Esquema del cuerpo de la solicitud

rate_id

string

requerido

ID de la rate elegida.

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

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

Solicitud

JSON

Copiado

                                
{
    "rate_id":"5b182a90c3bb5"
}

Shipment Response

Esquema del cuerpo de la respuesta

object_id

string

ID de la transacción.

status

string

Estatus de la transacción.

label_url

string

URL donde se encuentra el PDF de la guía.

tracking_number

string

Número de rastreo del envío.

tracking_url_provider

string

Link de rastreo para el envío en la plataforma del proveedor.

tracking_url_custom

string

Link de rastreo del envío personalizado por eShip.

commercial_invoice

boolean

Si se generó el comercial invoice.

commercial_invoice_url

string

URL del PDF de comercial invoice.

fulfillment

array

Datos enviados de regreso a la plataforma de eCommerce.

status

string

Estatus del fulfillment.

store

string

Plataforma de eCommerce.

order_num

string

Número de orden en la plataforma.

piece_labels

array

En caso de multipiezas, cada una de las guías.

[0… 25]

array

price_id

string

ID de la pieza.

sequence_number

string

Número de la pieza en el envió.

label_url

string

URL donde se encuentra el PDF de la pieza.

tracking_number

string

Número de rastreo del envío.

status

string

Estatus de rastreo de la pieza.

substatus

string

Subestatus global del envío (ver lista de subestatus).

status_details

string

Detalle del status de rastreo de la pieza.

Respuesta

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

Parámetros

Al menos uno de los siguientes parámetros es requerido.

shipment_id

string(10)

opcional

ID del envío a recuperar.

tracking_number

string(99)

opcional

No. de rastreo del envío a recuperar.

order_number

string(99)

opcional

No. de orden del envío a recuperar.

base64

boolean

opcional

Devuelve el campo "file" que contiene la guía codificada en base64.

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

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

Solicitud

JSON

Copiado

                                
{
    "object_id":"6b72e5342c5b5",
    "status":"SUCCESS",
    "label_url":"https://api.myeship.co/label/5b72e5342c5b5.pdf",
    "provider": "FedEx",
    "service": "Express Saver",
    "tracking_number":"782291727586",
    "order_number": "102494742-A",
    "order_id": "7923344",
    "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",
        "substatus":"label_created",
        "status_details":"Shipment information sent to FedEx",
        "estimated_delivery":"2023-02-24 21:00:00",
        "location":"",
        "timestamp":"2023-02-31 04:30:21"
    }
}

Shipments

per_page

integer

opcional

Número de envíos a recuperar.

page

integer

opcional

Número de página a recuperar.

sort

'date_desc'

'date_asc'

opcional

'date_desc' - Envíos más recientes primero

'date_asc' - Envíos más antiguos= primero

status

string(99)

opcional

Indica alguno o algunos (valores separados por coma) de los siguientes estatus:

- UNKNOWN

- TRANSIT

- FAILURE

- DELIVERED

- RETURNED

PROD: https://api.myeship.co/rest/shipments?page=1&per_page=1

TEST / QA: https://api.myeship.co/rest/shipments?page=1&per_page=1

Respuesta

JSON

Copied!

                                      
[       
    {
        "object_id": "66f2014065ef538e6f699",
        "provider": "FedEx",
        "service": "Express Saver®",
        "tracking_number": "279838484785",
        "order_number": "1464080786997-01",
        "order_id": "11925452",
        "user_id": 9424,
        "commercial_invoice": false,
        "commercial_invoice_url": "",
        "tracking_url_provider": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=MX&trackingnumber=279838484785",
        "notes": "",
        "tracking": {
            "status": "UNKNOWN",
            "substatus": "label_created",
            "status_details": "Información del envío enviada a FedEx",
            "estimated_delivery": "2024-09-30 21:00:00",
            "timestamp": "2024-09-24 00:31:54"
        }
    }
]

Cancel Shipment

Parámetros

Al menos uno de los siguientes parámetros es requerido.

shipment_id

string(10)

opcional

ID del envío a cancelar.

tracking_number

string(99)

opcional

No. de rastreo del envío a cancelar.

order_number

string(99)

opcional

No. de orden del envío a cancelar.

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

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

Respuesta

JSON

Copiado

                                
{
    "object_id":"6b72e5342c5b5",
    "status":"SUCCESS"
}

Tracking Status

"UNKNOWN"

La guía fue creada pero el paquete aún no ha sido escaneado por la paquetería.

status
substatus
Descripción
Requiere acción
UNKNOWN
label_created
La información sobre la guía fue recibida.
no
UNKNOWN
cancelled
Guía cancelada por remitente.
no
UNKNOWN
other
Estatus no reconocido.
no

“TRANSIT”

El paquete fue escaneado y va en camino a su destino.

status
substatus
Descripción
Requiere acción
TRANSIT
picked_up
Paquete escaneado por paquetería.
no
TRANSIT
in_transit
Paquete entre ubicaciones intermediarias.
no
TRANSIT
processed
Paquete procesado en ubicación intermediaria.
no
TRANSIT
at_customs
Paquete en aduana.
no
TRANSIT
out_for_delivery
Paquete en ruta de entrega.
no
TRANSIT
pickup_available
Paquete necesita ser recolectado en sucursal.
si
TRANSIT
delayed
La entrega se ha retrasado.
no
TRANSIT
scheduled
La entrega del paquete ha sido agendada.
no
TRANSIT
package_held
Paquete detenido en ubicación intermediaria.
si

“FAILURE”

La paquetaría indica que hubo un problema con la entrega.

status
substatus
Descripción
Requiere acción
FAILURE
delivery_issue
Paquete no pudo ser entregado.
si
FAILURE
address_issue
Problema con la dirección de entrega.
si
FAILURE
package_lost
Paquete ha sido perdido por la paquetería.
si
FAILURE
package_damaged
Paquete dañado por la paquetería.
si
FAILURE
package_disposed
Paquete desechado por la paquetería.
no

“DELIVERED”

El paquete fue entregado exitosamente.

status
substatus
Descripción
Requiere acción
DELIVERED
delivered
Paquete entregado.
no

“RETURNED”

El paquete va de regreso o ya fue entregado en el origen.

status
substatus
Descripción
Requiere acción
RETURNED
returned
Paquete regresado a remitente.
no

Batch Shipment

Generar las guías para los envíos con los servicios elegidos. Se crea también un PDF con todas las guías juntas.

Batch Shipment

Esquema del cuerpo de la solicitud

Rates

array

requerido

[0.. 10]

array

requerido (1 minimo)

ID de la rate rate.

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

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

Solicitud

JSON

Copiado

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

Batch Shipment Response

Esquema del cuerpo de la respuesta

object_id

string

ID del batch.

batch_labels_url

string(35)

URL del PDF con las guías del batch.

Status

string

Estatus del batch.

batch_labels

array

Las transacciones de cada guía.

[0… 10]

array

object_id

string

ID de la transacción.

Status

string

Estatus de la transacción.

label_url

string

URL donde se encuentra el PDF de la guía.

tracking_number

string

Número de rastreo del envío.

tracking_url_provider

string

Link de rastreo del envío en la plataforma del proveedor.

tracking_url_custom

string

Link de rastreo del envío personalizado por eShip.

commercial_invoice

boolean

Si se generó el comercial invoice.

commercial_invoice_url

string

URL del PDF de comercial invoice.

fulfillment

array

Datos enviados de regreso a la plataforma de eCommerce.

status

string

Estatus del fulfillment.

store

string

Plataforma de eCommerce.

order_num

string

Número de orden en la plataforma.

label_results

array

Número de orden en la plataforma.

succeded

integer

Cuantas guías del batch se crearon exitosamente.

failed

integer

Cuantas guías del batch no se crearon.

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

TEST / QA: https://apiqa.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":false,
        "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":false,
        "commercial_invoice_url":null,
        "fulfillment": {
            "status":"not fulfilled",
            "store":"",
            "order_num":"1234"
            }
        }
    ]
    "label_results": {
    "succeeded":2,
    "failed":0
    }
}

Batch Shipment

Parámetros

object_id

string

ID del batch a recuperar.

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

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

Solicitud

JSON

Copiado

                                       
{
    "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",
                "substatus":"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":false,
            "commercial_invoice_url":"",
            "tracking_url_provider":"http://www.dhlusa.com/content/us/en/express/tracking.shtml?brand=DHL&AWB=7416868373",
            "tracking": {
                "status":"UNKNOWN",
                "substatus":"label_created",
                "status_details":"Shipment information received"
            }
        }            
    ]
}

Orders

The orders endpoint allows you to load orders from your system to the eShip's dashboard and to create, retrieve and list orders programmatically.

Order

address_from

array

required

Dirección del remitente.

name

string(35)

required

Nombre del remitente.

company

string(35)

opcional

Empresa del remitente.

street1

string(35)

required

Línea de Dirección 1. Normalmente la calle y número (exterior e interior).

street2

string(35)

opcional

Línea de Dirección 2. Normalmente la colonia.

city

string(35)

required

Ciudad del remitente.

zip

string(35)

required

Código Postal del remitente.

lat

string(35)

opcional

Latitud de la ubicación

lng

string(35)

opcional

Longitud de la ubicación

state

string(35)

required

Estado o provincia del remitente.

country

string(2)

required

País del remitente (Código ISO 2 dígitos).

phone

string(35)

required

Teléfono del remitente.

email

string(35)

opcional

Email del remitente.

address_to

array

required

Dirección de destino.

name

string(35)

required

Nombre del destinatario.

company

string(35)

opcional

Empresa del destinatario.

street1

string(35)

required

Línea de Dirección 1. Normalmente la calle y número.

street2

string(35)

opcional

Línea de Dirección 2. Normalmente la colonia.

city

string(35)

required

Ciudad del destinatario.

zip

string(35)

required

Código postal del destinatario.

state

string(35)

required

Estado o provincia del destinatario.

country

string(2)

required

País del remitente (Código ISO 2 dígitos).

phone

string(35)

required

Teléfono del remitente.

email

string(35)

opcional

Email del remitente.

lat

string(35)

opcional

Latitud de la ubicación

lng

string(35)

opcional

Longitud de la ubicación

order_info

array

opcional

Información adicional sobre la orden.

order_num

string(35)

opcional

Número de orden en la tienda.

status

integer

opcional

Indica alguno de los siguientes estatus:

0 - Unfulfilled

1 - Fulfilled

2 - Fulfilled Parcial

3 - Enviado

4 - Cancelado

5 - En Proceso

6 - En Espera

7 - Backorder

8 - Entregado

9 - Retorno Solicitado

paid

integer

opcional

Indica alguno de los siguientes estatus de pago:

0 - Pago Pendiente

1 - Pagado

2 - Parcialmente Pagado

3 - Reembolsado

store

string(35)

opcional

eCommerce platforms where the order is created.

shipment

string(35)

opcional

Type of shipment chosen by the client.

total_price

float(10,2)

opcional

Total price of the purchase.

subtotal_price

float(10,2)

opcional

Subtotal Price of the purchase.

total_tax

float

opcional

Taxes of the purchase.

total_shipment

float

opcional

Total price of the shipping.

store_id

string(35)

opcional

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

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

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

Solicitud

JSON

Copied!

                                 
                                    
{
    "address_from":{
        "name":"Not2 Fitness",
        "company":"Not2 Fitness",
        "street1":"2065 Progress St., Ste A",
        "street2":"",
        "city":"Vista",
        "state":"CA",
        "zip":"92081",
        "country":"US",
        "phone":"6559225181",
        "email":"[email protected]"
    },
    "address_to":{
        "name":"Jennifer Smith",
        "company":"Jennifer Smith",
        "street1":"125 Bartley Drive",
        "street2":"",
        "city":"Newark",
        "state":"DE",
        "zip":"19702",
        "country":"US",
        "phone":"3053326755",
        "email":"[email protected]"
    },
    "order_info":{
        "order_num":"40172",
        "paid":1,
        "fulfillment":0,
        "shipment_type":"Economy",
        "total_price":"1300.99",
        "total_shipment":"0.00",
        "total_tax":"0.00",
        "subtotal_price":"1300.99"
    },
    "items":[
        {
            "SKU":"BETP1125",
            "description":"Hex Elite TPR Dumbbell 125",
            "quantity":2,
            "price":"227.50",
            "weight":"125",
            "currency":"USD"
        },
        {
            "SKU":"RIGG1001",
            "description":"Power Rack",
            "quantity":1,
            "price":"845.99",
            "weight":"320",
            "currency":"USD"
        }
    ]
}
Respuesta

JSON

Copied!

                                             
{
    "object_id": "10596",
    "status": "SUCCESS"
}

Order

Al menos uno de los siguientes parámetros es requerido.

order_id

integer

opcional

ID de la orden a recuperar.

order_number

string(35)

opcional

Número de orden del objeto a recuperar.

PROD: https://api.myeship.co/rest/order?order_id=10596

TEST / QA: https://api.myeship.co/rest/order?order_id=10596

Respuesta

JSON

Copied!

                                                          
{
    "order_id": "10596",
    "order_num": "40172",
    "customer": "Jennifer Smith, Newark",
    "address_from":{
        "name":"Not2 Fitness",
        "company":"Not2 Fitness",
        "street1":"2065 Progress St., Ste A",
        "street2":"",
        "city":"Vista",
        "state":"CA",
        "zip":"92081",
        "country":"US",
        "phone":"6559225181",
        "email":"[email protected]"
        "lat": null,
        "lng": null,
        "created_at": "2023-02-14 11:04:45",
        "updated_at": "2023-02-14 11:04:45"
    },
    "address_to":{
        "name":"Jennifer Smith",
        "company":"Jennifer Smith",
        "street1":"125 Bartley Drive",
        "street2":"",
        "city":"Newark",
        "state":"DE",
        "zip":"19702",
        "country":"US",
        "phone":"3053326755",
        "email":"[email protected]",
        "lat": null,
        "lng": null,
        "created_at": "2023-02-14 11:04:45",
        "updated_at": "2023-02-14 11:04:45"
    },
    "paid": "1",
    "fulfillment": envío,
    "shipment_type": "Economy",
    "store": "API",
    "total_price": "1300.99",
    "subtotal_price": "1300.99",
    "total_tax": "0.00",
    "shopify_id": "",
    "total_shipment": "0.00",
    "tags": "",
    "note": "",
    "store_id": "",
    "created_at": "2023-02-14 11:04:45",
    "updated_at": "2023-02-14 11:04:45",
    "items": [
        {
            "SKU":"BETP1125",
            "description":"Hex Elite TPR Dumbbell 125",
            "quantity":2,
            "price":"227.50",
            "weight":"125",
            "currency":"USD",
            "store_id": null,
        },
        {
            "SKU":"RIGG1001",
            "description":"Power Rack",
            "quantity":1,
            "price":"845.99",
            "weight":"320",
            "currency":"USD",
            "store_id":null,
        }
    ]
}

Shipments

per_page

integer

opcional

Número de envíos a recuperar.

page

integer

opcional

Número de página a recuperar.

sort

'date_desc'

'date_asc'

opcional

'date_desc' - Órdenes más recientes primero

'date_asc' - Órdenes más antiguas= primero

status

string(99)

opcional

Indica alguno o algunos (valores separados por coma) de los siguientes estatus:

0 - Unfulfilled

1 - Fulfilled

2 - Fulfilled Parcial

3 - Enviado

4 - Cancelado

5 - En Proceso

6 - En Espera

7 - Backorder

8 - Entregado

9 - Retorno Solicitado

store

string(99)

opcional

Indica alguno o algunos (valores separados por coma) de las plataformas a recuperar.

PROD: https://api.myeship.co/rest/orders?page=1&per_page=1

TEST / QA: https://api.myeship.co/rest/orders?page=1&per_page=1

Respuesta

JSON

Copied!

                                             
[
    {
        "order_id":"10597",
        "order_num":"40172",
        "customer":"Jennifer Smith, Newark",
        "address_from":"6489f8cbdb090",
        "address_to":"6489f8cbdb85c",
        "paid":1,
        "fulfillment":0,
        "shipment":"Economy",
        "store":"API",
        "total_price":"1300.99",
        "subtotal_price":"1300.99",
        "total_tax":"0.00",
        "total_shipment":"0.00",
        "tags":"",
        "note":"",
        "store_id":"",
        "created_at":"2023-02-14 11:28:43",
        "updated_at":"2023-02-14 11:28:43"
    }
]

Label Settings

Configuración para generar el PDF de la guía.

Label Settings

Esquema del cuerpo de la solicitud

label_format

'PDF'

'PDF_4x6'

requerido

Formato del PDF de la guía.
Para impresora normal: “PDF”
Para impresora térmica: “PDF_4x6”

label_firstline

string(35)

requerido

Primera línea de texto en la guía.
Para utilizar siempre el número de orden, usar: “*Order_Number*”

label_secondline

string(35)

requerido

Segunda línea de texto en la guía.

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

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

Solicitud

JSON

Copiado

                                       

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

Label Settings

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

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

Solicitud

JSON

Copiado

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

Pickups

Programar una recolección para uno o más paquetes con la línea transportista deseada.

Pickups

Esquema del cuerpo de la solicitud

courier

string(35)

string(35)

requerido

Línea transportista con la que se generará la recolección..

weight

string(35)

requerido

Peso total de los paquetes.

mass_unit

"kg"

requerido

Unidad del peso total.

quantity

integer

requerido

Número de paquetes a recolectar.

date

date (yyyy-mm-dd)

requerido

Fecha en la que se desea hacer la recolección.

time

hour (hh:mm)

requerido

Primera hora para pasar por el paquete.

closetime

hour (hh:mm)

requerido

Última hora para pasar por el paquete.

street1

string(35)

requerido

Línea 1 de la dirección de recolección. Normalmente la calle y número.

street2

string(35)

opcional

Línea 2 de la dirección de recolección. Normalmente la colonia.

zip

string(35)

requerido

Código postal de la dirección de recolección.

city

string(35)

requerido

Ciudad de recolección..

state

string(35)

requerido

Estado de recolección.

country

string(35)

requerido

País de recolección.

name

string(35)

requerido

Nombre de la persona responsable de la recolección.

company

string(35)

opcional

Compañía responsable de la recolección.

phone

string(35)

requerido

Teléfono del responsable de la recolección.

notes

string(35)

opcional

Notas adicionales para la recolección.

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

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

Solicitud

JSON

Copiado

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

JSON

                                
{
    "status":"SUCCESS",
    "confirmation":"137848",
    "courier":"DHL",
    "date":"2023-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":"Cuajimalpa",
    "state":"CDMX",
    "country":"MX"
}

Users

Creación y consulta de usuarios en la plataforma. Para accesar a este endpoint, es necesario solictarlo a [email protected]

Users

Esquema del cuerpo de la solicitud

email

string(255)

requerido

Email único para el usuario.

name

string(255)

requerido

Nombre del usuario (Requerido para contacto de paquetarías).

phone

string(255)

requerido

Télefono del usuario.

vendor

string(255)

Atributo vendor para asignación de órdenes en Marketplace.

carrier_ids

array

Arreglo con los ids de cuenta de paquetería.

carrier_id

integer

ID de cuenta de paquetería

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

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

Solicitud

JSON

Copiado

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

JSON

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

Users

Parámetros

user_id

string

ID del usuario a recuperar.

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

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

Respuesta

JSON

Copiado

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

WEBHOOK

Recibe notificaciones de cambio de estatus de tus envíos a un URL personalizado. Puedes configurar este URL en la pestaña Configuración del app.

Tracking

Parámetros

object_id

string(35)

ID único del envío.

tracking_number

string(35)

Numero de rastreo del envío.

order_number

string(35)

Numero de ordern relacionado al envío.

status

string(35)

Estatus global del envío (ver lista de estatus).

substatus

string(35)

Subestatus global del envío (ver lista de subestatus).

status_details

string(35)

Estatus detallado del envío.

timestamp

datetime

Fecha de registro del evento (Zona Horaria del Centro México GMT-6)

estimated_delivery

datetime

Fecha estimada de entrega del envío.

location

string(35)

Ubicación del último registro.

Webhook Body:

Copiado

                                                                                
{
    "object_id":"60e37902e86e1",
    "tracking_number":"281115007045",
    "order_number":"#12241",
    "status":"TRANSIT",
    "substatus":"picked_up",
    "status_details":"Paquete recolectado exitosamente.",
    "timestamp":"2023-07-06 17:56:00",
    "estimated_delivery":"2023-07-08 21:00:00",
    "location":"CUAUTITLAN IZCALLI, MX"
}

Webhook ejemplo: