Update a delivery

PATCH 
/standard/delivery

This endpoint is meant to be used to update delivery parameters, such as weight, height, length or depth

Request

Header Parameters

Authorization stringrequired

Default value: Bearer <token>

Content-Type stringrequired

Default value: application/json

application/json

Body

required

id stringrequired

Id of the delivery to be modified

modification objectrequired

At least on field should be present

depth number

Possible values: <= 9999

The depth in cm of the parcel

height number

Possible values: <= 9999

The height in cm of the parcel

length number

Possible values: <= 9999

The length in cm of the parcel

metadata string

Possible values: <= 255 characters

Arbitrary metadata that is either an object or a string

weight number

Possible values: <= 99999

The weight in kg of the parcel

Responses

200

OK

400

Bad Request

application/json

Schema

Schema

error booleanrequired
message stringrequired

Possible values: non-empty

Example (from schema)

{
  "error": true,
  "message": "string"
}

example-400

{
  "error": true,
  "message": "delivery is cancelled"
}

404

Delivery not found

application/json

Schema

Schema

error booleanrequired
message stringrequired

Possible values: non-empty

Example (from schema)

{
  "error": true,
  "message": "string"
}

example-404

{
  "error": true,
  "message": "no results found"
}

500

Internal Server Error

application/json

Schema

Schema

error booleanrequired
message stringrequired

Possible values: non-empty

Example (from schema)

{
  "error": true,
  "message": "string"
}

example-500

{
  "error": true,
  "message": "Internal error, please contact support@sendit.green"
}

Loading...