Delivery creation

In this section you will learn how to create your first delivery with Shippify.

With this endpoint, you can create up to a maximum of 100 deliveries per request and 100 requests per minute.

Delivery creation

post

Create up to 100 deliveries within Shippify

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Cuerpo

application/json

companyIdinteger · mín: 1Opcional

Company identifier where the delivery will be created

Example: 2

typestring · enumOpcional

Delivery type

Default: slotValores posibles:

Respuestas

200

Successful operation

application/json

401

Unauthorized

application/json

post

/v1/deliveries

HTTPcURLJavaScriptPython

POST /v1/deliveries HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 754

{
  "companyId": 2,
  "type": "slot",
  "deliveries": [
    {
      "pickup": {
        "contact": {
          "name": "Juan Perez",
          "email": "[email protected]",
          "phonenumber": "9999999999"
        },
        "location": {
          "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
          "instructions": "Unit 1001",
          "lat": -33.511333999,
          "lng": -70.6102933
        }
      },
      "dropoff": {
        "contact": {
          "name": "Juan Perez",
          "email": "[email protected]",
          "phonenumber": "9999999999"
        },
        "location": {
          "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
          "instructions": "Unit 1001",
          "lat": -33.511333999,
          "lng": -70.6102933
        }
      },
      "packages": [
        {
          "id": "Product-001",
          "name": "Color box",
          "qty": 4,
          "weight": 5.3,
          "size": "xs",
          "price": 5.3
        }
      ],
      "referenceId": "PO-00012",
      "tags": [
        "Fragile"
      ],
      "extraData": [
        {
          "name": "Invoice",
          "value": "INV-000001"
        }
      ],
      "cod": 22.3
    }
  ]
}

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

Use cases

Delivery Creation with Reference ID

This is the most basic payload you can use with the API; however, the task may be created with a pending review status if the address cannot be geolocated.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "0976565643",
                    "email": "[email protected]",
                    "name": "Juan Perez"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "[email protected]"
                },
                "location": {
                    "address": "Malecón 2000, Simon Bolivar Palacios, Guayaquil 090313, Ecuador",
                    "instructions": "Local 890"
                }
            },
            "packages": [
                {
                    "name": "Box of pencils",
                    "qty": 1,
                    "size": 1
                }
            ],
            "referenceId": "FACT-000123"
        }
    ]
}

Delivery Creation with Latitude and Longitude Address

With this payload, you can create deliveries with precise pickup and delivery points, ensuring that the task is always created with a "processing" status.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "Juan Perez",
                    "phonenumber": "0999999999"
                },
                "location": {
                    "address": "Av. Echeñique 8861, 7860169 La Reina, Región Metropolitana, Chile",
                    "lat": "-33.44299381045172",
                    "lng": "-70.53898694556675"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "[email protected]",
                    "phonenumber": "09999999999"
                },
                "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"
                }
            ]
        }
    ]
}

Delivery creation with address by components

With this payload, you can create deliveries with a slightly more precise pickup or delivery point, reducing the likelihood of it being created as pending review. It involves breaking down the address into country, city, street, and zip code.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "Juan Perez",
                    "phonenumber": "0999999999"
                },
                "location": {
                    "address": "R. Dona Claudina, 401 - Méier, Rio de Janeiro - RJ, 20725-060, Brasil",
                    "lat": -22.906846699999996,
                    "lng": -43.28275978125001
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "[email protected]",
                    "phonenumber": "09999999999"
                },
                "location": {
                    "address": {
                        "zipcode": "60348450",
                        "neighborhood": "VILA VELHA",
                        "streetName": "RUA 24,656",
                        "state": "CE",
                        "country": "Brazil",
                        "city": "FORTALEZA"
                    },
                    "instructions": "CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA"
                }
            },
            "packages": [
                {
                    "name": "149123156552",
                    "size": "XS",
                    "qty": "1"
                }
            ]
        }
    ]
}

Delivery Creation from or to a Configured Warehouse

With this payload, you can create deliveries with a collection point previously saved in the "Pickup Locations" section.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "Juan Perez",
                    "phonenumber": "099999999999"
                },
                "location": {
                    "warehouse": 9
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "[email protected]",
                    "phonenumber": "099999999999"
                },
                "location": {
                    "address": {
                        "zipcode": "60348450",
                        "neighborhood": "VILA VELHA",
                        "streetName": "RUA 24,656",
                        "state": "CE",
                        "country": "Brazil",
                        "city": "FORTALEZA"
                    },
                    "instructions": "CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA"
                }
            },
            "packages": [
                {
                    "name": "149123156552",
                    "size": "XS",
                    "qty": "1"
                }
            ]
        }
    ]
}

Delivery creation with tags and extra data

With digital tags, you can add additional features to the task to later filter by them, for example: fragile.

With extra data, you can link additional information to the delivery.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "099999999999",
                    "email": "[email protected]",
                    "name": "Juan Perez"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "[email protected]"
                },
                "location": {
                    "address": "Malecón 2000, Simon Bolivar Palacios, Guayaquil 090313, Ecuador",
                    "instructions": "Local 890"
                }
            },
            "packages": [
                {
                    "name": "Caja de colores",
                    "qty": 1,
                    "size": 1
                }
            ],
            "tags" : [ 
                "fragil"
            ],
             "extraData": [
                {
                    "name": "GUIA DE REMISION",
                    "value": "0001-000344-2233",
                    "searchable": true
                }
            ],
            "referenceId": "FACT-000123"
        }
    ]
}

Delivery creation for a child company

With this payload, you can create deliveries for a child company with authorization from the parent company.

{
    "companyId":2,
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "09999999999",
                    "email": "[email protected]",
                    "name": "Juan Perez"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "[email protected]"
                },
                "location": {
                    "address": "Malecón 2000, Simon Bolivar Palacios, Guayaquil 090313, Ecuador",
                    "instructions": "Local 890"
                }
            },
            "packages": [
                {
                    "name": "Caja de colores",
                    "qty": 1,
                    "size": 1
                }
            ],
            "referenceId": "FACT-000123"
        }
    ]
}