Creación de una entrega

La nueva API v1.0 le permite crear entregas a través de un endpoint único. Vea también diferentes formas de conectar nuestro servicio a sus sistemas internos.

Endpoint

POST {{SHIPPIFY_API_URL}}/v1/deliveries

Request

Propiedad	Tipo	Descripción	Obligatorio	Restricciones
companyId	string	En el caso de tener empresas hijas, puedes consultar cada una de ellas con el mismo auth pero cambiando este campo. En caso de tener una sola empresa asociada, este campo no es necesario.	NO
deliveries	arreglo Entrega	Arreglo de entregas que se requiere crear.	SI
type	string	Tipo de cuota.	NO	Puede ser "slot", "flex", "express"

Response

Propiedad	Tipo	Descripción
code	string	Descripción del código.
message	string	Detalles de los resultados.
payload	arreglo	Arreglo de las entregas que ha creado.
payload.id	string	Id de la tarea creada en el sistema.
payload.index	número	Posición de la entrega en el payload enviado.
payload.price	número	Precio para esa entrega concreta.
payload.currencyCode	string	Divisa en la que está el precio.
payload.distance	número	Distancia entre el punto de recogida y el punto de entrega para esta tarea.
payload.cityId	número	Id de la ciudad de recogida dentro del sistema.
payload.destinationCityId	número	Id de la ciudad de entrega dentro del sistema.
payload.insurance	número	Seguro para esa entrega en concreto.
payload.statusDelivery	string	Estado de la entrega, puede ser "procesando" si la tarea está bien o "pendiente de revisión" si la tarea no consigue geolocalizarse.
payload.vehicleCapacity	número	Tipo de vehículo para realizar esta tarea, desde bicicleta hasta camión (1-5).
payload.deliveryDate	string	Fecha estimada de entrega.
payload.trackLink	string	Enlace de seguimiento de la tarea.
payload.referenceId	string	Id de referencia de la tarea.

Ejemplo

Request

curl --location --request POST 'https://api.shippify.co/v1/deliveries/' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=' \
--header 'Content-Type: application/json' \
--header 'Cookie: locale=es' \
--data-raw '{
      "companyId":9065,
      "deliveries": [
        {
          "dropoff": {
            "contact": {
              "name": "MAYGER RENE MONTERO SAAVEDRA",
              "email": "[e-mail]",
              "phonenumber": "777"
            },
            "location": {
              "address": "Los Castaños 11989, 8010277 Santiago, El Bosque, Región Metropolitana, Chile",
              "lat": "-33.56751",
              "lng": "-70.67549"
            }
          },
          "packages": [
            {
              "name": "149123156552",
              "size": "XS",
              "qty": "1"
            }
          ],
          "pickup": {
            "contact": {
              "name": "Emilio Benavides",
              "phonenumber": "12345"
            },
            "location": {
              "address": "Av. Echeñique 8861, 7860169 La Reina, Región Metropolitana, Chile",
              "lat": "-33.44299381045172",
              "lng": "-70.53898694556675"
            }
          }
        }
      ]
    }'

200 Success

{
    "code": "OK",
    "message": "Delivery created successfully",
    "payload": [
        {
            "id": "t-pruaas-4973",
            "index": 0,
            "price": 10000,
            "currencyCode": "CLP",
            "distance": 23.5,
            "cityId": 3,
            "destinationCityId": 3,
            "insurance": 0,
            "statusDelivery": "processing",
            "vehicleCapacity": 1,
            "deliveryDate": "2023-10-27 19:09:11",
            "trackLink": "https://api.shippify.co/track/t-pruaas-4973?token=XXXXXXXXXXXXX",
            "referenceId": null
        }
    ]
}

400 Bad request

{
  message: "Bad Request",
  payload: { }
}

500 Internal Server Error

{
  message: "Error while retrieving the quote",
  payload: { }
}