Criar uma entrega

A nova API v1.0 permite que você crie entregas através de um único ponto de extremidade. Veja também as diferentes formas pelas quais você pode conectar nosso serviço aos seus sistemas internos.

Endpoint

POST {{SHIPPIFY_API_URL}}/v1/deliveries

Request

Propriedade	Tipo	Descrição	Obrigatório	Constraints
companyId	string	No caso de ter filiais, você pode consultar cada uma delas com a mesma autenticação, mas alterando este campo. No caso de ter apenas uma empresa associada, este campo não é necessário.	NÃO
deliveries	array of Entrega	Arranjo de entregas que requer criação.	SIM
type	string	Tipo de cotação	NÃO	Pode ser "slot", "flex", "express".

Response

Propriedade	Tipo	Descrição
code	string	Descrição do código.
message	string	Detalhes do resultado.
payload	array	Arranjo das entregas de dados que você criou.
payload.id	string	ID da tarefa criada dentro do sistema.
payload.index	number	Posição da entrega na carga útil enviada.
payload.price	number	Preço para essa entrega específica.
payload.currencyCode	string	Moeda na qual o preço está expresso.
payload.distance	number	Distância entre o ponto de coleta e o ponto de entrega para esta tarefa.
payload.cityId	number	ID da cidade de coleta dentro do sistema.
payload.destinationCityId	number	ID da cidade de entrega dentro do sistema.
payload.insurance	number	Seguro para essa entrega específica.
payload.statusDelivery	string	Status da entrega, pode ser "processando" se a tarefa estiver OK ou "pendente de revisão" se a tarefa falhar na geolocalização.
payload.vehicleCapacity	number	Tipo de veículo para realizar esta tarefa, de bicicleta a caminhão (1-5).
payload.deliveryDate	string	Data estimada de entrega.
payload.trackLink	string	Link de rastreamento para a tarefa.
payload.referenceId	string	ID de referência para a tarefa.

Exemplo

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