Update Shipment

patch

https://api.paqato.com/v3/shipments/{orderNumber}/{trackingCode}

Update an existing Shipment

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orderNumber

string

required

length between 1 and 255

^((?!/).)*$

Public/customer-facing order number in urlencoded form

trackingCode

string

required

length between 1 and 255

Shipment's tracking code in urlencoded form

Query Params

shopToken

string

length between 1 and 16

Internal PAQATO shop token in urlencoded form

Body Params

packingDate

date-time

Date of packaging. Must not be after shippingDate. On a partial update the shipping date is taken from the stored shipment. RFC3339 format without milliseconds.

shippingDate

date-time

Date of ship-out. Must not be before packingDate. On a partial update the packing date is taken from the stored shipment. RFC3339 format without milliseconds.

type

string

enum

Shipment type. Omitting it leaves the stored type unchanged.

Allowed:

product

string

The shipment product type as determined by the warehouse of the sender

picker

string

length between 1 and 255

Warehouse picker

packer

string

length between 1 and 255

Packer

warehouse

string

length between 1 and 255

Shipment's originating warehouse

warehousePostalCode

string

length between 1 and 255

Originating warehouse's postal code

weight

double

≥ 0.001

Weight in kg

items

object

Map (object) with line item numbers as keys and quantities as values

data

object

Additional data

shippingChannel

string

length between 1 and 255

The shipping channel type, i.e. warehouse, route supplier or drop shipping.

supplier

string

length between 1 and 255

Additional shippingChannel information, i.e. the warehouse location or the specific route supplier.

routeNumber

string

length between 1 and 255

Optional route number of a shipment.

Responses

404

Order or Shipment not found

202OK, Shipment queued for update

400Bad Request, Shipment not updated

409Conflict with existing shipment