Creación de entregas

En esta sección aprenderás a crear tu primera entrega dendro de Shippify

Con este endpoint podrás crear hasta un máximo de 100 entregas por request y 100 request por minuto.

Creación de entregas

Crea hasta 100 entregas dentro de Shippify

POSThttps://api.shippify.co/v1/deliveries

Authorization

Basic_Auth

Body

application/json

Aqui va la descripción

companyIdinteger

Identificador de la compañia donde se va a crear la entrega

Example: 2

typeenum

Tipo de entrega

flexexpressslot

deliveries*array of delivery (object)

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Delivery created successfully"

payloadarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/deliveries', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deliveries": [
        {
          "pickup": {
            "contact": {
              "name": "Iliana Bolaños",
              "email": "[e-mail]"
            },
            "location": {
              "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile"
            }
          },
          "dropoff": {
            "contact": {
              "name": "Iliana Bolaños",
              "email": "[e-mail]"
            },
            "location": {
              "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile"
            }
          },
          "packages": [
            {
              "name": "Caja de colores"
            }
          ]
        }
      ]
    }),
});
const data = await response.json();

Response

200401

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

Casos de uso

Creación de entrega con reference id

Este es el payload mas básico con el que puedes usar el API, sin embargo es probable que la tarea se cree con estado pendiente de revisión si la dirección no se puede geolocalizar.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "0976565643",
                    "email": "[e-mail]",
                    "name": "Iliana Bolaños"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Estefanía Fajardo",
                    "email": "[e-mail]"
                },
                "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"
        }
    ]
}

Creación de entrega con dirección con lat y long

Con este payload podrás crear entregas con un punto de recolección y entrega preciso, de esta manera la tarea siempre se creará con estado procesando.

{
    "deliveries": [
        {
            "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"
                }
            },
            "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"
                }
            ]
        }
    ]
}

Creación de entrega con dirección por componentes

Con este payload podrás crear entregas con un punto de recolección o entrega un poco más preciso y con menos probabilidades que se cree como pendiente de revisión. Consiste en separar la dirección en pais, ciudad, calle, zip code.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "Emilio Benavides",
                    "phonenumber": "12345"
                },
                "location": {
                    "address": "R. Dona Claudina, 401 - Méier, Rio de Janeiro - RJ, 20725-060, Brasil",
                    "lat": -22.906846699999996,
                    "lng": -43.28275978125001
                }
            },
            "dropoff": {
                "contact": {
                    "name": "MAYGER RENE MONTERO SAAVEDRA",
                    "email": "[e-mail]",
                    "phonenumber": "777"
                },
                "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"
                }
            ]
        }
    ]
}

Creación de entrega desde o hasta una bodega configurada

Con este payload podrás crear entregas con un punto de recolección guardado previamente en la sección de bodegas.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "Emilio Benavides",
                    "phonenumber": "12345"
                },
                "location": {
                    "warehouse": 9
                }
            },
            "dropoff": {
                "contact": {
                    "name": "MAYGER RENE MONTERO SAAVEDRA",
                    "email": "[e-mail]",
                    "phonenumber": "777"
                },
                "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"
                }
            ]
        }
    ]
}

Creación de entrega con tags y extradata

Con las etiquetas digitales podrás agregar caracteristicas adicionales a la tarea para posteriormente poder filtrar por ellas por ejemplo: frágil.

Con la extradata podrás enlazar información adicional a la entrega.

{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "0976565643",
                    "email": "[e-mail]",
                    "name": "Iliana Bolaños"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Estefanía Fajardo",
                    "email": "[e-mail]"
                },
                "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"
        }
    ]
}

Creación de entrega para una compañia hija

Con este payload podrás crear entregas a una compañia hija con la autorización de la compañía padre.

{
    
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "0976565643",
                    "email": "[e-mail]",
                    "name": "Iliana Bolaños"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Estefanía Fajardo",
                    "email": "[e-mail]"
                },
                "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"
        }
    ]
}