Obtener envíos

Listado de shipments

En este endpoint podrás obtener un listado de envíos a los que tu usuario tiene acceso, junto con un resumen de sus atributos más importantes.

GET /shipments
Parámetros GET disponibles:
account_id int Filtrar por cuenta account_id=50
external_id string Filtro por external_id external_id=3232323
service_type string Filtro por tipo de servicio service_type=standard_delivery
status string Filtro por estado status=delivered. Ver estados
origin_id int Filtro por origen guardado Ver más origin_id=345
page int Página de resultados page=2

Atención: Ver detalle de un shipment para una explicación de cada atributo de un envío.

Ejemplo:

GET https://api.zippin.com.ar/v2/shipments

RESPONSE 200

{
    "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://zippin.local/tracking/103169/34",
            "tracking_external": "http://zippin.local/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.zippin.com.ar/v2/shipments?page=1",
        "last": "http://api.zippin.com.ar/v2/shipments?page=4",
        "prev": null,
        "next": "http://api.zippin.com.ar/v2/shipments?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 4,
        "path": "http://api.zippin.com.ar/v2/shipments",
        "per_page": 15,
        "to": 15,
        "total": 54
    }
}

Detalle de un shipment

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

GET /shipments/{id}
id int Número de envío
Descripción de los atributos del shipment.
id int Número de envío
delivery_id string Número de guía
external_id string ID provisto por el seller
created_at datetime Hora de creación del envío
status string Estado actual en Zippin (código). Ver estados
status_name string Estado actual (nombre). Ver estados
service_type string Código del tipo de servicio
logistic_type string Código del tipo de imposición o recolección
tracking string URL de página de seguimiento
declared_value decimal Valor declarado del envío
price decimal Precio sin IVA a pagar
price_incl_tax decimal Precio con IVA a pagar
crossdock_notified boolean Cuando el crossdock hace cualquier cambio de estado se modifica a true.
parent_delivery_id int Si se trata de un redespacho, se indica el id del delivery original.
total_weight int Peso total del envío en gramos.
total_volume int Volumen total del envío en cm cúbicos.
origin object Datos de donde se hace una recolección.

Ver abajo
destination object Datos de donde se hace la entrega (si corresponde).

Ver abajo
packages array de object Conjunto de paquetes. Ver abajo
origin
id int ID del origen. Siempre se mantendrá el mismo id para la misma ubicación.
name string

...Ver ejemplo para más
destination
name string

...Ver ejemplo para mas
packages
Es un Array. El peso se indica en gramos, y las medidas en centímetros. Solo se usan números enteros. Ver atributos en ejemplo

Ejemplo:

GET https://api.zippin.com.ar/v2/shipments/101981

RESPONSE 200

{
    "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://zippin.local/tracking/101981/7",
    "tracking_external": "http://zippin.local/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": "pgiaeytknzq@mail.mercadolibre.com"
    },
    "origin": {
        "id": 32,
        "name": "Zippin - Tortuguitas",
        "document": "30-70835592-1",
        "street": "Brasil",
        "street_number": "2990",
        "street_extras": "LESET",
        "city": "Tortuguitas",
        "state": "Buenos Aires",
        "zipcode": "1667",
        "phone": "000000",
        "email": "operaciones@zippin.com.ar"
    },
    "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"
            }
        }
    ]
}

Estados de envío

En esta tabla podrás ver los estados que puede tener un envío.

Estado Código Seteable Descripción
Nuevo new No Estado inicial del envío.
Remito Generado documentation_ready No A partir de este estado se genera el número de guía (delivery) y se puede obtener la documentación. Este estado es seteado automáticamente instantes luego de la creación, salvo que el cliente no tenga saldo suficiente en su cuenta.
Listo Para Despacho ready_to_ship Si Este estado habilita el envío para ser recolectado. Se setea automáticamente cuando se obtiene la documentación.
Anulación Confirmada cancelled Si Estado final. Lo puede marcar el seller a mano, solo antes del despacho
Despachado de Origen shipped Si Cuando el envio es recolectado
Crossdock crossdock No El envío se encuentra en el centro de distribución.
Siniestrado En Crossdock lost_in_crossdock No Estado final. El envío se siniestró en el crossdock.
En Tránsito a transporte in_transit_to_carrier No El envío se encuentra en camino al transporte.
Recibido Transporte received_by_carrier No El envío fue recibido por el transporte.
Redespachado reshipped No Estado final. El envío fue rechazado por el transporte y ha sido redespachado en otro transporte. Se genera un nuevo envío con otro id y el mismo external_id
En Camino in_transit No El envío está en camino hacia el destinatario.
Entregado delivered No Estado Final. El envío fue entregado.
Entregado Parcialmente Dañado delivered_with_damage No Estado Final. El envío fue entregado y se dejó constancia de que el empaque estaba dañado.
Siniestrado En Transporte lost_in_carrier No Estado Final. El envío fue siniestrado por el transporte.
No Entregado not_delivered No El envío no fue entregado.
En transporte listo para devolución in_carrier_ready_to_return No El envío se encuentra en el transporte aguardando ser retirado.
En tránsito a Crossdock in_transit_to_crossdock No El envío está en camino a volver al centro de distribución.
En Guarda on_hold_crossdock No El envío está en el centro de distribución aguardando devolución al remitente.
En tránsito al remitente in_transit_to_seller No El envío está en camino al remitente.
Devuelto a Remitente returned_to_seller No Estado Final. El envío fue devuelto al remitente.

Ubicaciones para imposición de envíos

Cuando un envío tenga logistic_type: carrier_dropoff o xd_dropoff, el vendedor deberá llevar el envío a alguna de las sucursales admitidas para su imposición.

Este endpoint ofrece las ubicaciones más cercanas al origen del envío o a un Código Postal determinado.

GET /shipments/{id}/dropoff_locations
Filtros en el query string:
zipcode int Código postal para obtener locaciones cercanas (opcional, si no se indica se usa el del origen del envío)

Ejemplo:

GET https://api.zippin.com.ar/v2/shipments/111222/dropoff_locations

RESPONSE 200
{
    "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"
            }
        }
    ]
}