Modificar coleta

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

Editar coletas

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

PATCHhttps://api.shippify.co/v1/deliveries/pickup

Authorization

Basic_Auth

Body

application/json

Aqui vai a descrição

deliveryIds*string

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"

deliveryChanges*object

Alterações a serem feitas na entrega.

recalculatePrice*bool

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

Example: true

reorderRoute*bool

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

Example: true

Response

200401

Operação bem sucedida

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Sucesso"

dataobject

Informações dos processos adicionais criados (caso a entrega pertença a uma rota).

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/deliveries/pickup', {
    method: 'PATCH',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deliveryIds": "t-pruaas-4973",
      "reorderRoute": true,
      "recalculatePrice": true,
      "deliveryChanges": {
        "location": {
          "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile"
        }
      }
    }),
});
const data = await response.json();

Response

200401

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

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
}