Modificar entrega

Endpoint para atualizar dados da entrega, isso inclui o endereço e as informações de contato do ponto de entrega, assim como também propriedades como pacotes, etiquetas, pacotes, cod, identificador de referência, entre outros.

Editar dados da entrega

patch

Endpoint que permite editar os dados de uma ou várias entregas.

Autorizaciones

Cuerpo

deliveryIdsstring[]Requerido

Lista dos identificadores das entregas que vão ser editadas (é possível editar em um mesmo request até 10 entregas).

Example: t-pruaas-4973

referenceIdsstring[]Opcional

Lista dos ids de referência dos pedidos que vão ser editados (é possível editar em um mesmo request até 10 entregas). Se colocae esta propiedade, não colocar deliveryIds.

Example: FACT-0001

recalculatePriceboolOpcional

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

Example: true

reorderRouteboolOpcional

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

Example: true

recalculateCityboolOpcional

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

Example: true

Respuestas

200

Operação bem sucedida

application/json

401

Não autorizado

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "deliveryIds": [
    "t-pruaas-4973"
  ],
  "referenceIds": [
    "FACT-0001"
  ],
  "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": "[email protected]",
      "phonenumber": "0998976565"
    },
    "packages": [
      {
        "id": "Product-001",
        "name": "Caja de colores",
        "qty": 4,
        "weight": 5.3,
        "size": "slot",
        "price": 5.3
      }
    ],
    "cod": 10.4,
    "referenceId": "PO-00012",
    "addTags": [
      1003
    ],
    "removeTags": [
      1003
    ]
  },
  "recalculatePrice": true,
  "reorderRoute": true,
  "recalculateCity": true
}

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

Casos de uso

Modificar entrega por deliveryId

{
    "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 PRODUTOS NO POLICENTRO 2",
            "lat": -23.557166,
            "lng": -46.664559
        },
        "contact": {
            "name": "iliana",
            "email": "[email protected]"
        },
        "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"}]
    }
}

Modificar entrega por referenceId

{
    "referenceIds": [
        "0987837468"
    ],
    "reorderRoute": true,
    "recalculatePrice": true,
    "recalculateCity": false,
    "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": "[email protected]"
        },
        "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"}]
    }
}

Modificar dados do destinatário

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "deliveryChanges": {
        "contact": {
            "name": "iliana",
            "email": "[email protected]"
        }
    }
}

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

Modificar etiquetas

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "deliveryChanges": {
        "addTags":[1003],
        "removeTags": []
    }
}

Modificar referenceId

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "deliveryChanges": {
        "referenceId": "0987837468"
    }
}

Modificar pacotes da entrega

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "deliveryChanges": {
       "packages": [
            {
                "id": "SSSTP002",
                "name": "XIAOMI REDMI 10S",
                "size": 2,
                "price": 0,
                "weight": 5,
                "qty": 1
            }
        ]
    }
}