v1

latestSwagger 2.02026-08-06115129197.7 KB
Purchase Orders

Returns purchase orders filtered by query parameters.

Returns purchase orders for the company authenticated by X-Api-Key, paginated. Without location_mytime_id, the list may include purchase orders for all locations the user may access; pass location_mytime_id to restrict results to a single location. Pass updated_after to return only purchase orders updated after that timestamp. Results are ordered newest-first by id by default; pass sort and sort_order to override this.

get/purchase_orders

Query parameters

location_mytime_idinteger

Location MyTime ID by which to filter results - Optional

updated_afterstring

Return only purchase orders with updated_at strictly after this value. ISO 8601 datetime (e.g. 2026-01-19 or 2026-01-19T00:00:00Z) is recommended.

pageinteger

Page number to return

per_pageinteger

row number to count as one page

sort'id' | 'updated_at'

Field to sort by. Default is 'id'. Allowed values: id, updated_at.

sort_order'asc' | 'desc'

Sort direction. Default is 'desc' (newest first). Allowed values: asc, desc.

vendorboolean

Whether to include vendor information

purchase_order_itemsboolean

Whether to include purchase order items

skuboolean

Whether to include sku information

vendor_skuboolean

Whether to include vendor sku information

shipment_itemsboolean

Whether to include shipment items

shipmentsboolean

Whether to include shipments

Headers

X-Subdomainstring

Merchant subdomain - Optional

X-Partnerstring

Partner key - Optional

Response

Purchase order list response