Administrar envíos

Obtener envíos

Los endpoints de búsqueda y obtención de envíos y tracking utilizan rate limiting 🟡Bajo Ver más sobre límites de requests

Listado/búsqueda de envíos

Buscar envíos

GET /v2/shipments

Obtiene un listado de envíos. Se pueden aplicar filtros sobre distintos campos.

Query Parameters

Name

Type

Description

account_id

int

Filtrar envíos de una cuenta por ID.

Ejemplo: account_id=2

external_id

string

Filtrar envíos por su ID Externo

Ejemplo: external_id=DJDSJCMR

service_type

string

Filtrar envíos por su tipo de servicio.

Ejemplo: service_type=standard_delivery

status

string

Filtrar envíos por su estado actual.

Ejemplo: status=delivered

Ver estados posibles

origin_id

int

Filtrar envíos de un origen por ID.

Ejemplo: origin_id=32

order_id

string

Filtrar envíos por el ID visible de una venta relacionada de un canal integrada. Ejemplo: order_id=200000334445566

{
    "data": [
        {
            "id": 103169,
            "external_id": "teste210119",
            "delivery_id": "0099-00222134",
       "created_at": "2019-01-18T04:05:22+0000",
            "account_id": 34,
            "parent_shipment_id": null,
            "service_type": "standard_delivery",
            "logistic_type": "crossdock",
            "status": "new",
            "status_name": "Nuevo",
            "tracking": "http://zipnova.com.x/tracking/103169/34",
            "tracking_external": "http://zipnova.com.x/tracking/teste210119/34/external_id",
            "destination": {
                "name": "eee",
                "city": "Capital Federal",
                "state": "Capital Federal",
                "zipcode": "1425"
            },
            "origin": {
                "id": 25,
                "name": "Origen Demo",
                "city": "Capital Federal",
                "state": "Capital Federal",
                "zipcode": "1005"
            },
            "declared_value": 1425,
            "price": 111.57,
            "price_incl_tax": 135,
            "total_weight": 10000,
            "total_volume": 8000,
            "total_packages": 1
        },
        (...)
    ],
    "links": {
        "first": "http://api.zipnova.com.ar/v2/shipments?page=1",
        "last": "http://api.zipnova.com.ar/v2/shipments?page=4",
        "prev": null,
        "next": "http://api.zipnova.com.ar/v2/shipments?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 4,
        "path": "http://api.zipnova.com.ar/v2/shipments",
        "per_page": 15,
        "to": 15,
        "total": 54
    }
}

Detalle de un envío

GET /v2/shipments/{shipment_id}

Obtiene el detalle de un envío determinado

Path Parameters

Name

Type

Description

shipment_id*

int

ID del envío.

{
    "id": 101981,
    "external_id": "414311",
    "delivery_id": "0999-00101915",
    "created_at": "2019-01-18T04:05:22+0000",
    "account_id": 7,
    "parent_shipment_id": 101793,
    "service_type": "standard_delivery",
    "logistic_type": "crossdock",
    "status": "delivered",
    "status_name": "Entregado",
    "tracking": "http://zipnova.com.x/tracking/101981/7",
    "tracking_external": "http://zipnova.com.x/tracking/414311/7/external_id",
    "destination": {
        "name": "Pablo",
        "document": "34353917",
        "street": "Ruta 7 km",
        "street_number": "259",
        "street_extras": null,
        "city": "Junin",
        "state": "Buenos Aires",
        "zipcode": "6000",
        "phone": "0236154503837",
        "email": "[email protected]"
    },
    "origin": {
        "id": 32,
        "name": "Zipnova - Tortuguitas",
        "document": "30-70835592-1",
        "street": "Brasil",
        "street_number": "2990",
        "street_extras": "",
        "city": "Tortuguitas",
        "state": "Buenos Aires",
        "zipcode": "1667",
        "phone": "000000",
        "email": "[email protected]"
    },
    "declared_value": 27140,
    "price": 1950.41,
    "price_incl_tax": 2360,
    "total_weight": 56000,
    "total_volume": 97020,
    "packages": [
        {
            "internal_id": 67188,
            "sku_id": null,
            "weight": 28000,
            "height": 33,
            "width": 30,
            "length": 49,
            "volume": 48510,
            "description_1": "1910811535",
            "description_2": "Aire Acondicionado Inverter 5000fc",
            "description_3": "",
            "classification": {
                "id": 1,
                "name": "General"
            }
        },
        {
            "internal_id": 67189,
            "sku_id": null,
            "weight": 28000,
            "height": 33,
            "width": 30,
            "length": 49,
            "volume": 48510,
            "description_1": "1910811535",
            "description_2": "Aire Acondicionado Inverter 5000fc",
            "description_3": "",
            "classification": {
                "id": 1,
                "name": "General"
            }
        }
    ]
}

Ubicaciones disponibles para despacho

En los envíos con despacho en un punto (cuando el logistic_type es xd_dropoff, carrier_dropoff, o point_dropoff), o con recolección unificada (crossdock), se puede obtener un listado de ubicaciones cercanas al origen donde se puede ir a despachar el envío.

La ubicaciones ofrecidas sólo muestran aquellas que pueden recibir el envío en función de su peso y dimensiones.

Ubicaciones para despacho de un envío

GET /v2/shipments/{shipment_id}/dropoff_locations

Path Parameters

Name

Type

Description

shipment_id*

int

ID del envío a despachar

{
    "data": [
        {
            "carrier": {
                "id": 208,
                "name": "OCA"
            },
            "name": "Sucursal OCA - QUILMES",
            "address": {
                "street": "Lavalle",
                "street_number": "663",
                "street_extras": "  ",
                "city": "Quilmes",
                "state": "Buenos Aires",
                "zipcode": "1878",
                "lat": "-34.7231545",
                "lng": "-58.2566685",
                "phone": "4224-7481",
                "open_hours": "LUN A VIE 8:30 A 18 HS."
            }
        },
        {
            "carrier": {
                "id": 208,
                "name": "OCA"
            },
            "name": "Agente Oficial - RACZ ROBERTO RUBEN",
            "address": {
                "street": "Aristovulo Del Valle",
                "street_number": "4295",
                "street_extras": "  ",
                "city": "Claypole",
                "state": "Buenos Aires",
                "zipcode": "1849",
                "lat": "-34.80522",
                "lng": "-58.338937",
                "phone": "4219-3163",
                "open_hours": "A Confirmar"
            }
        }
    ]
}

Edición de envíos

Podrás actualizar algunos aspectos del envío luego de creado.

Actualmente solo es posible editar el atributo de external_id, siempre y cuando el envío aun no haya sido despachado.

Al hacer la modificación, se reseteará el estado del envío a Pendiente de Preparación y habrá que volver a descargar la documentación de despacho, si ya se hubiera hecho.

Editar un envío

PUT /v2/shipments/{shipment_id}

Path Parameters

Name

Type

Description

shipment_id*

int

ID del envío

external_id

string

ID externo del envío. Solo admite letras, números y guiones.

{
        "shipment_id": 123456,
        "success": true,
        "result": {
                "external_id": "new_external-id"
                }
    }

Documentación de despacho

La documentación de despacho está compuesta de una etiqueta por cada paquete del envío, y dependiendo del transporte, una guía de despacho.

Para despachar un envío es obligatorio pegar cada etiqueta a un paquete distinto, e imprimir la guía de despacho, si estuviera disponible, la cual se debe adherir a la factura de venta o remito legal.

Obtener documentación

GET /v2/shipments/{shipment_id}/documentation?what={what}&format={format}

Obtiene los archivos de etiquetas o la guia de despacho.

En cualquier caso el contenido del archivo se devuelve encodeado en base64.

Path Parameters

Name

Type

Description

shipment_id*

int

ID del envío

Query Parameters

Name

Type

Description

what*

string

Tipo de archivo a obtener:

document para la guía (solo disponible en PDF)

label para las etiquetas de cada paquete (en PDF o ZPL)

format

string

Formato de las etiquetas:

pdf (por defecto)

zpl

{
    "format": "zpl",
    "body": "XlhBflRBMDAwfkpTTl5MVDBeTU5XXk1UVF5QT05eUE1OXkxIMCwwXkpNQV5QUjQsNH5TRDE1XkpVU15MUk5eQ0kwXlhaXlhBXk1NVF5QVzgzMV5MTDEyMzleTFMwXkZPRk81ODAsMjBeR0ZBLDIxNjAsMjE2MCwyNywsOjpMMDc4LEwwRkMsSzAxRkUsSzAxRkYsSzAzRkY4LEswM0kZIXF5GRDMgLyAzXkZTXkZPMjAsOTQwXkdCNzcxLDAsOF5GU15GVDE4MCw5OD15CWTIsMywxNDBeRlQxODAsMTE2MF5CQ04sLFksTl5GRD46MDk5OS0wMDEwMTQ3NC0wMzAzXkZTXlBRMSwwLDEsWV5YWg=="
}

Tracking

En este endpoint podrás obtener un detalle de los movimientos de un envío.

Obtener historial de estados

GET /v2/shipments/{shipment_id}/tracking

Path Parameters

Name

Type

Description

shipment_id*

int

ID del envío

Query Parameters

Name

Type

Description

sort

string

Ordenamiento de los movimientos

oldest ordena desde los movimientos mas antiguos a los mas recientes (por defecto)

newest ordena desde los movimientos mas recientes a los mas antiguos

[
    {
        "created_at": "2019-04-12T00:10:29+00:00",
        "status": {
            "code": "delivered",
            "name": "Entregado",
            "visible_name": "Entregado",
            "substatus": null
        }
    },
    {
        "created_at": "2019-04-11T19:14:48+00:00",
        "status": {
            "code": "in_transit",
            "name": "En Camino",
            "visible_name": "Envio en distribucion",
            "substatus": null
        }
    },
    {
        "created_at": "2019-04-11T19:14:48+00:00",
        "status": {
            "code": "shipped",
            "name": "Despachado de Origen",
            "visible_name": "El vendedor ha despachado el pedido",
            "substatus": null
        }
    },
    {
        "created_at": "2019-04-11T14:31:02+00:00",
        "status": {
            "code": "documentation_ready",
            "name": "Remito Generado",
            "visible_name": "El vendedor esta preparando el pedido",
            "substatus": null
        }
    },
    {
        "created_at": "2019-04-11T14:31:00+00:00",
        "status": {
            "code": "new",
            "name": "Nuevo",
            "visible_name": "Nuevo",
            "substatus": null
        }
    }
]

Anular envíos

Este endpoint te permitirá cancelar envíos.

Solo se puede cancelar envíos que no hayan sido despachados. Cuando se solicite cancelar un envío no despachado su estado pasará a Anulación Confirmada.

Si el envío ya fue despachado, se generará una Solicitud de Rescate. Con esa solicitud se notificará al transporte para que no haga la entrega, aunque no siempre se puede garantizar que se cumpla la solicitud.

Cancelar o solicitar rescate de un envío

POST /v2/shipments/{shipment_id}/cancel

Path Parameters

Name

Type

Description

shipment_id*

int

ID del envío

{
        "shipment_id": 123456,
        "success": true,
        "result": "canceled"
    }

Actualizar estados de envíos de Flota Propia

POST /v2/shipments/{shipment_id}/tracking

Si deseas actualizar los estados de tus envíos de flota propia, podrás usar este endpoint. Ten en cuenta que solo podrás definir algunos estados.

Estados permitidos

Estado

Código

Subestados

Listo para Despacho

ready_to_ship

Anulacion Confirmada

cancelled

Despachado de Origen

shipped

En Transito a Transporte

in_transit_to_carrier

Recibido Transporte

received_by_carrier

En Camino

in_transit

Entregado

delivered

No Entregado

not_delivered

Se debe indicar alguno de estos subestados:

Path Parameters

Name

Type

Description

shipment_id*

int

ID del envío

Body

Name

Type

Description

status*

string

Código del estado

substatus

string

Código del subestado (solo si es necesario)

comment

string

Comentario opcional. Máximo 150 caracteres.

Response

{
  // Detalle del envío recién actualizado
}

AnteriorCrear Envíos SiguienteDevoluciones

Última actualización hace 12 meses

hashtagObtener envíos

hashtagListado/búsqueda de envíos

hashtagBuscar envíos

hashtagQuery Parameters

hashtagDetalle de un envío

hashtagDetalle de un envío

hashtagPath Parameters

hashtagUbicaciones disponibles para despacho

hashtagUbicaciones para despacho de un envío

hashtagPath Parameters

hashtagEdición de envíos

hashtagEditar un envío

hashtagPath Parameters

hashtagDocumentación de despacho

hashtagObtener documentación

hashtagPath Parameters

hashtagQuery Parameters

hashtagTracking

hashtagObtener historial de estados

hashtagPath Parameters

hashtagQuery Parameters

hashtagAnular envíos

hashtagCancelar o solicitar rescate de un envío

hashtagPath Parameters

hashtagActualizar estados de envíos de Flota Propia

hashtagEstados permitidos

hashtagPath Parameters

Obtener envíos

Listado/búsqueda de envíos

Buscar envíos

Query Parameters

Detalle de un envío

Detalle de un envío

Path Parameters

Ubicaciones disponibles para despacho

Ubicaciones para despacho de un envío

Path Parameters

Edición de envíos

Editar un envío

Path Parameters

Documentación de despacho

Obtener documentación

Path Parameters

Query Parameters

Tracking

Obtener historial de estados

Path Parameters

Query Parameters

Anular envíos

Cancelar o solicitar rescate de un envío

Path Parameters

Actualizar estados de envíos de Flota Propia

Estados permitidos

Path Parameters