Obter entrega

This endpoint provides you with a complete overview of a delivery. You can request this endpoint through the `delivery_id` or any other reference declared when creating the delivery.

Este ponto final fornece uma visão completa de uma entrega. Você pode solicitar este ponto final através do delivery_id ou qualquer outra referência declarada ao criar a entrega.

Endpoint

GET {{SHIPPIFY_API_URL}}/v1/deliveries/:deliveryId/complete

Request

Propriedade	Tipo	Descrição	Obrigatório	Constraints
deliveryId	string	ID da tarefa criada dentro do sistema, você também pode usar o ID de referência aqui.	SIM

Response

Propriedade	Tipo	Descrição
id	string	ID da tarefa criada dentro do sistema.
route	object	Dados da rota.
route.id	array	ID da rota atribuída à entrega.
route.order	number	Posição da entrega na rota.
recipient	Contato	Informações de contato da pessoa que fornecerá os pacotes no momento da coleta.
pickup	object	Preço para essa entrega específica.
pickup.date	string	Data estimada de retirada. Formato AAAA-MM-DDTHH:mm:ss.000Z
dropoff	object	Data de entrega.
dropoff.location	Localização	Dados da localização de entrega.
dropoff.date	string	Data estimada de entrega. Formato AAAA-MM-DDTHH:mm:ss.000Z
courier	object	Informações do motorista atribuído.
courier.info	number	Informações do motorista atribuído.
courier.info.shipperId	number	ID do motorista atribuído no sistema.
courier.info.shipperDocId	string	Documento de identificação do motorista atribuído no sistema.
courier.info.shipperName	string	Nome do motorista atribuído.
courier.info.vehicleLicensePlate	number	Placa do veículo do motorista atribuído.
courier.info.vehicleType	string	Tipo de veículo do motorista atribuído.
courier.info.vehicleModel	string	Modelo do veículo do motorista atribuído.
courier.location	object	Localização do motorista atribuído no último status.
courier.location.lat	number	Latitude do motorista atribuído no último status.
courier.location.lng	number	Longitude do motorista atribuído no último status.
items	array of Pacotes	Pacotes da tarefa.
status	number	ID do estado atual da tarefa.
_status	string	Nome do estado atual da tarefa.
status_lang	string	Tradução do nome do estado atual da tarefa.
distance	number	Distância entre o ponto de coleta e o ponto de entrega para esta tarefa.
company	string	Nome da empresa.
referenceId	string	ID de referência da tarefa.
metadata	object	Dados adicionais da tarefa.
groupId	string	ID do grupo de tarefas.
reasonId	number	Este campo é preenchido quando a tarefa apresenta um problema de coleta/entrega.
reasonText	string	Descrição do motivo.
lastStatusDate	string	Data da última atualização de status.
tags	array of string	Tags da tarefa.

Exemplo

Request

curl --location --request GET 'https://api.shippify.co/v1/deliveries/t-pruaas-4973/complete' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=' \
--header 'Cookie: locale=es'

200 Sucess

{
    "id": "t-pruaas-4973",
    "route": {
        "id": "r-shiinc-2183891",
        "order": 4
    },
    "recipient": {
        "name": "Mayger Rene Montero Saavedra",
        "email": "[e-mail]",
        "phonenumber": "777"
    },
    "pickup": {
        "date": "2023-10-27T18:24:11.000Z"
    },
    "dropoff": {
        "location": {
            "lat": -33.56751,
            "lng": -70.67549,
            "originalAddress": "Los Castaños 11989 Casa, EL BOSQUE, SANTIAGO, CL",
            "address": "los castaños 11989, 8010277 santiago, el bosque, región metropolitana, chile"
        },
        "date": "2023-10-27T19:09:11.000Z"
    },
    "courier": {
        "info": {
            "shipperId": 531597,
            "shipperDocId": "111000011123",
            "shipperName": "Juan Maroto",
            "shipperCapacity": "medium",
            "vehicleLicensePlate": "Test Placa",
            "vehicleType": "Test Marca",
            "vehicleModel": "Test Modelo"
        },
        "location": {}
    },
    "items": [
        {
            "name": "149123156552",
            "size": 1,
            "qty": 1,
            "price": 0,
            "weight": 0,
            "sid": "t-pruaas-4973_1",
            "uuid": "cbb09c5c-2209-428c-bc1e-d1cac8efb0f4"
        }
    ],
    "status": 3,
    "_status": "assigned",
    "status_lang": "Asignada",
    "distance": 23.5,
    "company": "TextLam",
    "referenceId": null,
    "metadata": {},
    "groupId": null,
    "reasonId": null,
    "reasonText": null,
    "lastStatusDate": "2023-10-27T20:00:30.000Z",
    "tags": ["prime"]
}