Orders
An order is a purchase by one of your customers that Paxon fulfils from your stock in our warehouses. You create the order, including its orderItems, delivery and billing address and any attachments, in a single POST v3/orders request. From then on Paxon takes over: as soon as stock is available, the order is planned into one or more shipments.
Use the endpoints in this section to:
- create orders and look them up by their Paxon
id, or list them with filters on order date,externalOrderNumberandreference - change an order with
PUT v3/orders/:id, for as long as it hasn't been shipped in full - cancel a complete order or a single order item. Paxon cancels whatever hasn't been shipped yet, and the response tells you what was actually cancelled.
- attach a PDF document to an order, which is printed and packed with the parcel. Contact your account manager to arrange this first.
To follow orders without polling, subscribe to the orderItem.cancelled.3 and shipment events using webhooks.
v3/orders
List your orders, with filters and pagination.
v3/orders
Create an order with its order items and addresses.
v3/orders/:id
Retrieve one order by its Paxon id.
v3/orders/:id
Cancel an order, or as much of it as has not shipped yet.
v3/orders/:id
Change an order that has not been fully shipped yet.
v3/orderItems/:id
Retrieve one order item.
v3/orderItems/:id
Cancel an order item, or as much of it as has not shipped yet.
v3/orderAttachments
Attach a PDF to an order, to be printed during picking.