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.

Consulta as informações de entregas

Consulta os dados de uma entrega seja pelo id de entrega ou id de referência.

GEThttps://api.shippify.co/v1/deliveries/{id}/complete

Authorization

Basic_Auth

Path parameters

id*string

Identificador do Id de referência da entrega consultada.

Response

200401

Operação bem sucedida

Body

application/json

idstring

Identificador da entrega na Shippify.

Example: "t-shiinc-27946"

routeobject

Informação da rota que a entrega pertence

recipientcontact (object)

Informação de contato da pessoa encarregada de entregar os pacotess no lugar de coleta.

pickupobject

dropoffobject

Informação da entrega

courierobject

Informações do motorista

itemsarray of array of package (object)

Pacotes da entrega

statusinteger

Código do estado da entrega

Example: 3

_statusstring

Nome do estado da entrega

Example: "assigned"

status_langstring

Nome do estado da entrega no idioma da conta

Example: "Designada"

distancenumber

Distância entre o ponto de coleta e de entrega

Example: 10.4

companystring

Nome da empresa da tarefa

Example: "TextLam"

referenceIdstring

Identificador externo da entrega, pode ser o número da ordem

Example: "PO-00012"

reasonIdinteger

Identificador do motivo da mudança de estado

Example: 1

reasonTextstring

Descrição do motivo da mudança de estado

Example: "DANGER ZONE"

problem_notestring

Comentário da mudança de estado

Example: "Área de perigo"

lastStatusDatestring

Data da última mudança de estado

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

tagsarray of string

Nomes das etiquetas digitais da entrega

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/deliveries/{id}/complete', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200401

{
  "id": "t-shiinc-27946",
  "route": {
    "id": "r-shiinc-2183891",
    "order": 2
  },
  "recipient": {
    "name": "Iliana Bolaños",
    "email": "[e-mail]",
    "phonenumber": "0998976565"
  },
  "pickup": {
    "date": "2023-10-27T18:24:11.000Z"
  },
  "courier": {
    "info": {
      "shipperId": 531597,
      "shipperDocId": "111000011123",
      "shipperName": "Juan Maroto",
      "shipperCapacity": "medium",
      "vehicleLicensePlate": "PO-1234",
      "vehicleType": "Suzuki",
      "vehicleModo": "Vitara"
    },
    "location": {
      "lat": -33.511333999,
      "lng": -70.6102933
    }
  },
  "items": [
    [
      {
        "id": "Product-001",
        "name": "Caja de colores",
        "qty": 4,
        "weight": 5.3,
        "size": "flex",
        "price": 5.3
      }
    ]
  ],
  "status": 3,
  "_status": "assigned",
  "status_lang": "Designada",
  "distance": 10.4,
  "company": "TextLam",
  "referenceId": "PO-00012",
  "reasonId": 1,
  "reasonText": "DANGER ZONE",
  "problem_note": "Área de perigo",
  "lastStatusDate": "2023-10-27T19:09:11.000Z",
  "tags": [
    "TBR09891"
  ]
}

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