Editar entrega

Neste endpoint, você pode corrigir ou alterar os dados de entrega e algumas propriedades de uma entrega.

Endpoint

PATCH {{SHIPPIFY_API_URL}}/v1/deliveries/dropoff

Request

Propriedade	Tipo	Descrição	Obrigatório	Restrições
deliveryIds	array of string	IDs das tarefas das quais você deseja alterar informações.	SIM
deliveryChanges	object	Novos dados de informações, podem incluir um contato, uma localização e pacotes.	SIM
deliveryChanges.location	Localização	Novos dados de localização.	NÃO	lat e lng são obrigatórios
deliveryChanges.contact	Contato	Novos dados de contato.	NÃO
deliveryChanges.packages	Pacotes	Novos dados de pacotes.	NÃO
deliveryChanges.cod	number	Use esta opção se o motorista precisar cobrar dinheiro do seu cliente.	NÃO
deliveryChanges.referenceId	string	ID externo.	NÃO
deliveryChanges.addTags	array of numbers	Lista de IDs das tags criadas no sistema que você deseja adicionar.	NÃO
deliveryChanges.removeTags	array of numbers	Lista de IDs das tags criadas no sistema que você deseja remover.	NÃO
deliveryChanges.extraData	array of objects	Lista de objetos com informações extras sobre a entrega.	NÃO
recalculatePrice	boolean	Após a mudança, o preço é alterado ou não.	SIM	verdadeiro/falso
reorderRoute	boolean	Após a mudança, a ordem da rota é alterada ou não.	SIM	verdadeiro/falso

Response

Propriedade	Tipo	Descrição
code	string	Código do resultado.
message	string	Descrição do resultado.

Exemplo

Request

curl --location --request PATCH 'https://api.shippify.co/v1/deliveries/dropoff' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXX=' \
--header 'Content-Type: application/json' \
--header 'Cookie: locale=es' \
--data-raw '{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "reorderRoute": true,
    "recalculatePrice": true,
    "recalculateCity": false,
    "deliveryChanges": {
        "location": {
            "address": "av. echeñique 8861, 7860169 la reina, región metropolitana, chile",
            "instructions": "CLIENTE RETIRA PRODUCTOS EN POLICENTRO 2",
            "lat": -23.557166,
            "lng": -46.664559
        },
        "contact": {
            "name": "iliana",
            "email": "[e-mail]"
        },
        "packages": [
            {
                "id": "SSSTP002",
                "name": "XIAOMI REDMI 10S",
                "size": 2,
                "price": 0,
                "weight": 5,
                "qty": 1
            }
        ],
        "cod": 10,
        "referenceId": "0987837468",
        "addTags":[1003],
        "removeTags": [],
        "extraData": [{"name":"Billing", "value":"0000-123-334"}]
    }
}'

200 Success

{
    "code": "OK",
    "message": "Success"
}