Remove a delivery

With this endpoint, you can remove deliveries from a created route.

Route Modification

Endpoint that allows removing one or multiple deliveries from a route.

PATCHhttps://api.shippify.co/v1/routes/remove

Authorization

Basic_Auth

Body

application/json

Description goes here

routeId*string

Identifier of the route from which deliveries will be removed

Example: "r-shiinc-345879"

deliveries*array of string

List of identifiers of the deliveries to be removed from the route

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Process created successfully"

dataobject

Information of additional processes created.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/routes/remove', {
    method: 'PATCH',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "routeId": "r-shiinc-345879",
      "deliveries": [
        "t-pruaas-4973"
      ]
    }),
});
const data = await response.json();

Response

200401

{
  "code": "OK",
  "message": "Process created successfully",
  "data": {
    "jobs": "JOB-1234"
  }
}