Criação de entregas

Nesta seção vamos aprender a criar sua primeira entrega na Shippify.

Com este endpoint, você poderá criar até um máximo de 100 entregas por request e 100 requests por minuto.

Criação de entregas

post

Cria até 100 entregas dentro da Shippify

Autorizaciones

Cuerpo

companyIdinteger · mín: 1Opcional

Identificador da empresa onde será criada a entrega

Example: 2

typestring · enumOpcional

Tipo de entrega

Default: slotValores posibles:

Respuestas

200

Operação bem sucedida

application/json

401

Não autorizado

application/json

post

HTTPcURLJavaScriptPython

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

{
  "companyId": 2,
  "type": "slot",
  "deliveries": [
    {
      "pickup": {
        "contact": {
          "name": "Iliana Bolaños",
          "email": "[e-mail]",
          "phonenumber": "0998976565"
        },
        "location": {
          "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
          "instructions": "Local 1001",
          "lat": -33.511333999,
          "lng": -70.6102933
        }
      },
      "dropoff": {
        "contact": {
          "name": "Iliana Bolaños",
          "email": "[e-mail]",
          "phonenumber": "0998976565"
        },
        "location": {
          "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
          "instructions": "Local 1001",
          "lat": -33.511333999,
          "lng": -70.6102933
        }
      },
      "packages": [
        {
          "id": "Product-001",
          "name": "Caja de colores",
          "qty": 4,
          "weight": 5.3,
          "size": "xs",
          "price": 15.6
        }
      ],
      "referenceId": "PO-00012",
      "tags": [
        "Delicado"
      ],
      "extraData": [
        {
          "name": "Factura",
          "value": "FA-000001"
        }
      ],
      "cod": 22.3
    }
  ]
}

{
  "code": "OK",
  "message": "Entrega criada com sucesso",
  "payload": [
    {
      "index": 0,
      "id": "t-shiinc-27946",
      "price": 10.4,
      "currencyCode": "BRL",
      "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

Criando entregas com referenceID

Esse é o payload mais básico que você pode usar na API, mas é provável que a tarefa seja criada com o estado "pendente de revisão" se o endereço não puder ser geolocalizado

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

Criando uma entrega com endereço e com latitude e longitude

Com esse payload, você poderá criar entregas com pontos de coleta e entrega precisos, garantindo que a tarefa sempre seja criada com o estado "processando".

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

Criando entregas com endereço por componentes

Com esse payload, você poderá criar entregas com um ponto de coleta ou entrega um pouco mais preciso e com menos probabilidades de ser criado como "pendente de revisão". Consiste em separar o endereço por país, cidade, rua e código postal.

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

Criando entrega com um galpão já configurado

Com esse payload, você poderá criar entregas com um ponto de coleta salvo anteriormente na seção de galpões/depósito.

{
    "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": "Brasil",
                        "city": "FORTALEZA"
                    },
                    "instructions": "CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA"
                }
            },
            "packages": [
                {
                    "name": "149123156552",
                    "size": "XS",
                    "qty": "1"
                }
            ]
        }
    ]
}

Criando entregas com tags e extradata

Com essas etiquetas digitais, você pode adicionar características adicionais à tarefa para depois poder filtrá-las, por exemplo: frágil.

Com os dados extras, você pode vincular informações adicionais à 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": "Caixa de lapís",
                    "qty": 1,
                    "size": 1
                }
            ],
            "tags" : [ 
                "fragil"
            ],
             "extraData": [
                {
                    "name": "GUIA DE REMISION",
                    "value": "0001-000344-2233",
                    "searchable": true
                }
            ],
            "referenceId": "FACT-000123"
        }
    ]
}

Criando entrega para uma empresa filha

Com esse payload, você pode criar entregas para uma empresa filha com a autorização da empresa matriz.

{
    
    "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": "Caixa de lapís",
                    "qty": 1,
                    "size": 1
                }
            ],
            "referenceId": "FACT-000123"
        }
    ]
}