Modificar coleta

Endpoint para atualizar dados da coleta, isso inclui o endereço e as informações de contato no armazém.

Editar coletas

patch

Endpoint que permite editar os dados de coleta de uma entrega.

Authorizations

Body

deliveryIdsstringrequired

Identificadores das entregas que vão ser editadas separados por vírgulas, em um mesmo request se recebe até 10 entregas.

Example: t-pruaas-4973

deliveryChangesobjectrequired

Alterações a serem feitas na entrega.

recalculatePriceboolrequired

Indica se vai recalcular o preço após as alterações (recomendável).

Example: true

reorderRouteboolrequired

Indica se vai reorndenar a rota (caso a entrega pertença a uma rota) após as alterações (recomendável).

Example: true

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.shippify.co/v1/deliveries/pickup' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "deliveryIds": "t-pruaas-4973",
    "deliveryChanges": {
      "location": {
        "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
        "instructions": "Local 1001",
        "lat": -33.511333999,
        "lng": -70.6102933
      },
      "contact": {
        "name": "Iliana Bolaños",
        "email": "[e-mail]",
        "phonenumber": "0998976565"
      }
    },
    "recalculatePrice": true,
    "reorderRoute": true
  }'

application/json

200

401

200

{
  "code": "OK",
  "message": "Sucesso",
  "data": {
    "jobs": "JOB-1234"
  }
}

Operação bem sucedida

Casos de uso

Modificar dados do remetente

{
    "deliveryIds": "t-pruaas-4973",
    "deliveryChanges": {
        "location": {
            "address": "av. echeñique 8861, 7860169 la reina, región metropolitana, chile",
            "instructions": "CLIENTE RETIRA PRODUTOS NO POLICENTRO 2",
            "lat": -23.557166,
            "lng": -46.664559
        },
        "contact": {
            "name": "iliana",
            "email": "[e-mail]"
        }
    },
    "recalculatePrice": true,
    "reorderRoute": true
}

Modificar endereço de entrega

{
    "deliveryIds": "t-pruaas-4973",
    "deliveryChanges": {
        "location": {
            "address": "av. echeñique 8861, 7860169 la reina, región metropolitana, chile",
            "instructions": "CLIENTE RETIRA PRODUTOS NO POLICENTRO 2",
            "lat": -23.557166,
            "lng": -46.664559
        }
    },
    "recalculatePrice": true,
    "reorderRoute": true
}