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 múltiplas entregas.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Cuerpo

application/json

deliveryIdsstring[]Requerido

List of delivery identifiers to be edited, up to 10 deliveries can be edited in a single request

Example: t-pruaas-4973

referenceIdsstring[]Opcional

List of reference identifiers of orders to be edited, up to 10 deliveries can be edited in a single request. If this property is used, do not include deliveryIds

Example: FACT-0001

recalculatePricebooleanOpcional

Indicates whether to recalculate the price after modification (recommended)

Example: true

reorderRoutebooleanOpcional

Indicates whether to reorder the route (if the delivery belongs to a route) after modification (recommended)

Example: true

recalculateCitybooleanOpcional

Indicates whether to recalculate the city after modification (recommended)

Example: true

Respuestas

200

Operação bem-sucedida

application/json

401

Não autorizado

application/json

patch

/v1/deliveries/dropoff

HTTPcURLJavaScriptPython

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

{
  "deliveryIds": [
    "t-pruaas-4973"
  ],
  "referenceIds": [
    "FACT-0001"
  ],
  "deliveryChanges": {
    "location": {
      "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
      "instructions": "Unit 1001",
      "lat": -33.511333999,
      "lng": -70.6102933
    },
    "contact": {
      "name": "Juan Perez",
      "email": "[email protected]",
      "phonenumber": "9999999999"
    },
    "packages": [
      {
        "id": "Product-001",
        "name": "Color box",
        "qty": 4,
        "weight": 5.3,
        "size": "xs",
        "price": 5.3
      }
    ],
    "cod": 10.4,
    "referenceId": "PO-00012",
    "addTags": [
      1003
    ],
    "removeTags": [
      1003
    ]
  },
  "recalculatePrice": true,
  "reorderRoute": true,
  "recalculateCity": true
}

{
  "code": "OK",
  "message": "Success",
  "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": "Juan Perez",
            "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": "Juan Perez",
            "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": "Juan Perez",
            "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
            }
        ]
    }
}