Obtener información de una entrega

Este endpoint te proporciona una visión completa de una entrega, ya sea con el identificador de la entrega o con el id de referencia del mismo.

Consulta la información de entregas

get

Recuperar datos de una entrega por su ID o referencia.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Parámetros de ruta

idstringRequerido

Identificador o ID de referencia de la entrega a consultar.

Respuestas

200

Operación exitosa

application/json

idstringOpcional

Identificador de la entrega en Shippify.

Example: t-shiinc-27946

dropoffobjectOpcional

Información de entrega

statusinteger · mín: 1Opcional

Código de estado de la entrega

Example: 3

_statusstringOpcional

Nombre del estado de la entrega

Example: assigned

status_langstringOpcional

Nombre del estado de la entrega en el idioma de la cuenta

Example: Assigned

distancenumberOpcional

Distancia entre puntos de recolección y entrega

Example: 10.4

companystringOpcional

Nombre de la empresa de la tarea

Example: Company ABC

referenceIdstringOpcional

Identificador externo de la entrega, como número de orden

Example: PO-00012

reasonIdinteger · mín: 1Opcional

Identificador de la razón del cambio de estado

Example: 1

reasonTextstringOpcional

Descripción de la razón del cambio de estado

Example: DANGER ZONE

problem_notestringOpcional

Comentario del cambio de estado

Example: Dangerous zone

lastStatusDatestringOpcional

Fecha del último cambio de estado

Example: 2023-10-27T19:09:11.000Z

tagsstring[]Opcional

Nombres de etiquetas digitales de entrega.

Example: Fragile

401

No autorizado

application/json

get

/v1/deliveries/{id}/complete

HTTPcURLJavaScriptPython

GET /v1/deliveries/{id}/complete HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Accept: */*

{
  "id": "t-shiinc-27946",
  "route": {
    "id": "r-shiinc-2183891",
    "order": 2
  },
  "recipient": {
    "name": "Juan Perez",
    "email": "[email protected]",
    "phonenumber": "9999999999"
  },
  "pickup": {
    "date": "2023-10-27T18:24:11.000Z"
  },
  "dropoff": {},
  "courier": {
    "info": {
      "shipperId": 531597,
      "shipperDocId": "9999999999",
      "shipperName": "Juan Maroto",
      "shipperCapacity": "medium",
      "vehicleLicensePlate": "PO-1234",
      "vehicleType": "Suzuki",
      "vehicleModel": "Vitara"
    },
    "location": {
      "lat": -33.511333999,
      "lng": -70.6102933
    }
  },
  "items": [
    [
      {
        "id": "Product-001",
        "name": "Color box",
        "qty": 4,
        "weight": 5.3,
        "size": "xs",
        "price": 5.3
      }
    ]
  ],
  "status": 3,
  "_status": "assigned",
  "status_lang": "Assigned",
  "distance": 10.4,
  "company": "Company ABC",
  "referenceId": "PO-00012",
  "reasonId": 1,
  "reasonText": "DANGER ZONE",
  "problem_note": "Dangerous zone",
  "lastStatusDate": "2023-10-27T19:09:11.000Z",
  "tags": [
    "Fragile"
  ]
}

Casos de uso

Obtener información de una entrega por su id

Puedes utilizar el id de la entrega en la url de la petición para traer su información.

Obtener información de una entrega por su reference id

Puedes utilizar el reference id de la entrega en la url de la petición para traer su información.