HomeTutorialsAPI ReferenceChangelog
Log In
Changelog
Added

2026-11 Purchase Order Deleted At

Starting from version 2026-04, the PurchaseOrder response returned by
GET /api/{version}/purchase_orders and
GET /api/{version}/purchase_orders/{purchase_order_id} now includes a deleted_at
field indicating whether, and when, a purchase order was deleted.

This is a backward-compatible addition, available in version 2026-04 and all later versions.

What's New

Updated Purchase Order Response

The following field is now always present on purchase order objects.

FieldTypeDescription
deleted_atstring (date-time) | nullThe time at which the purchase order was deleted, in UTC. null if the purchase order has not been deleted.

🔒 Requires: consignments:read scope

Deletion vs. Cancellation

deleted_at is separate from the purchase order status. A purchase order with a
CANCELLED status has not been deleted unless deleted_at is also set. To tell whether
a purchase order has been deleted, check deleted_at rather than status.