Información de una entrega

Este endpoint te proporciona una visión completa de una entrega. Puedes solicitar este endpoint a través de "delivery_id" o cualquier otra referencia declarada al crear la entrega.

Los Ids de referencia son identificadores de tu sistema que se pueden ligar a una entrega de Shippify para que más tarde puedas recuperarla a través de él.

Endpoint

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

Request

Propiedad	Tipo	Descripción	Required	Constraints
deliveryId	string	Id de la tarea creada dentro del sistema, también puede utilizar el id de referencia aquí.	YES

Response

Propiedad	Tipo	Descripción
id	string	Id de la tarea creada en el sistema.
route	objeto	Datos de la ruta.
route.id	arreglo	Id de la ruta asignada en la entrega.
route.order	número	Posición de la entrega en la ruta.
recipient	Contacto	Información de contacto de la persona que proporcionará los paquetes en el momento de la recogida.
pickup	objeto	Precio para esa entrega concreta.
pickup.date	string	Fecha estimada de recogida. Formato AAAA-MM-DDTHH:mm:ss.000Z
dropoff	objeto	Datos de la entrega.
dropoff.location	Localización	Datos de ubicación de la entrega.
dropoff.date	string	Fecha estimada de entrega. Formato AAAA-MM-DDTHH:mm:ss.000Z
courier	objeto	Información asignada al conductor.
courier.info	número	Información asignada al conductor.
courier.info.shipperId	número	Id del conductor asignado en el sistema.
courier.info.shipperDocId	string	Documento identificador del conductor asignado en el sistema.
courier.info.shipperName	string	Nombre del conductor asignado.
courier.info.vehicleLicensePlate	número	Matrícula del vehículo del conductor asignado.
courier.info.vehicleType	string	Tipo de vehículo del conductor asignado.
courier.info.vehicleModel	string	Modelo de vehículo del conductor asignado.
courier.location	objeto	Ubicación del conductor asignado en el último estado.
courier.location.lat	número	Latitud del conductor asignado en el último estado.
courier.location.lng	número	Longitud del conductor asignado en el último estado.
items	arreglo de Paquete	Paquetes de la tarea.
status	number	Id del estado actual de la tarea.
_status	string	Nombre del estado actual de la tarea.
status_lang	string	Traducción del nombre del estado actual de la tarea.
distance	número	Distancia entre el punto de recogida y el punto de entrega para esta tarea.
company	string	Nombre de la empresa.
referenceId	string	Id de referencia de la tarea.
metadata	objeto	Datos adicionales de la tarea.
groupId	string	Id del grupo de tareas.
reasonId	número	Este campo se rellena cuando la tarea tiene un problema de recogida/entrega.
reasonText	string	Descripción del motivo.
lastStatusDate	string	Fecha de la última actualización del estado.
tags	arreglo de string	Etiquetas de la tarea.

Ejemplo

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"]
}