Obter informação de uma entrega

Este endpoint fornece uma visão completa de uma entrega, seja com o identificador da entrega ou com o ID de referência da mesma.

Verificar informações da entrega

get

Retrieve data for a delivery by its ID or reference.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Parámetros de ruta

idstringRequerido

Identifier or reference ID of the delivery to query.

Respuestas

200

Operação bem-sucedida

application/json

idstringOpcional

Identificador da entrega no Shippify.

Example: t-shiinc-27946

dropoffobjectOpcional

Informações de entrega

statusinteger · mín: 1Opcional

Código de status da entrega

Example: 3

_statusstringOpcional

Nome do status da entrega

Example: assigned

status_langstringOpcional

Nome do status da entrega no idioma da conta

Example: Assigned

distancenumberOpcional

Distância entre pontos de coleta e entrega

Example: 10.4

companystringOpcional

Nome da empresa da tarefa

Example: Company ABC

referenceIdstringOpcional

Identificador externo da entrega, como número do pedido

Example: PO-00012

reasonIdinteger · mín: 1Opcional

Identificador da razão para a mudança de status

Example: 1

reasonTextstringOpcional

Descrição da razão para a mudança de status

Example: DANGER ZONE

problem_notestringOpcional

Comentário da mudança de status

Example: Dangerous zone

lastStatusDatestringOpcional

Data da última mudança de status

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

tagsstring[]Opcional

Nomes das etiquetas digitais da entrega.

Example: Fragile

401

Não 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

Obter informação de uma entrega por seu id

Você pode usar o ID da entrega na URL da solicitação para trazer suas informações

Obter informação de uma entrega por seu referenceid

Você pode usar o referenceid da entrega na URL da solicitação para trazer suas informações