Create delivery

The new API v1.0 allows you to create deliveries through a unique endpoint. See also different ways you can connect our service to your internal systems.

Endpoint

POST {{SHIPPIFY_API_URL}}/v1/deliveries

Request

Property	Type	Description	Required	Constraints
companyId	string	In the case of having daughter companies, you can query each of them with the same auth but changing this field. In case of having only one associated company, this field is not necessary.	NO
deliveries	array of Delivery	Arrangement of deliveries which requires create	YES
type	string	Quote type	NO	Can be "slot", "flex", "express".

Response

Property	Type	Description
code	string	code description
message	string	Result details
payload	array	Arrangement of data deliveries which you created.
payload.id	string	Id of the task created within the system
payload.index	number	Position of the delivery in the sent payload.
payload.price	number	Price for that particular delivery.
payload.currencyCode	string	Currency in which the price is in.
payload.distance	number	Distance between the pickup point and the delivery point for this task.
payload.cityId	number	Id of the pickup city within the system
payload.destinationCityId	number	Id of the dropoff city within the system
payload.insurance	number	Insurance for that particular delivery.
payload.statusDelivery	string	Status of the delivery, it can be "processing" if the task is OK or "pending review" if the task fails to geolocate.
payload.vehicleCapacity	number	Type of vehicle to carry out this task, from bike to truck (1-5).
payload.deliveryDate	string	Estimated delivery date
payload.trackLink	string	Tracking link for the task
payload.referenceId	string	Reference Id for the task

Example

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: { }
}