Skip to navigation
API ReferenceReceiving

Cancel Purchase Order

View as Markdown
Cancels the purchase order, freeing its external reference for reuse. Responds 409 when it is already cancelled.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

idlongRequired
Id of the purchase order

Response

OK
created_atdatetimeOptional

When the purchase order was created (UTC).

external_referencestring or nullOptional

The merchant’s own reference, unique among the merchant’s non-cancelled purchase orders.

line_itemslist of objects or nullOptional
The expected line items.
notesstring or nullOptional

Free-text notes.

purchase_order_idlongOptional
Unique id of the purchase order.
statusobjectOptional
A purchase order status.
supplierobject or nullOptional
The supplier, or null when none is set.
updated_atdatetimeOptional

When the purchase order was last changed (UTC).

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error