Returns purchase orders filtered by query parameters.
Changed onReturns 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 and/or updated_before to filter by when the purchase order was last updated, received_after and/or received_before to filter by when it was received, and statuses to filter by status. Results are ordered newest-first by id by default; pass sort and sort_order to override this.
Request
- Base URLhttps://partners-api.mytime.com/api
- AuthAPI key in header X-Api-Key
Query parameters
Location MyTime ID by which to filter results - Optional
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.
Return only purchase orders with updated_at strictly before this value. ISO 8601 datetime (e.g. 2026-01-19 or 2026-01-19T00:00:00Z).
Return only purchase orders received strictly after this value. The received time is the first receive event, or the first complete event when the order was never received; orders with neither are excluded. ISO 8601 datetime.
Return only purchase orders received strictly before this value. Same received time rules as received_after. ISO 8601 datetime.
Comma-separated statuses to include. Allowed values: draft, ordered, received, checking_in, completed, canceled, disputed, requested.
Page number to return
row number to count as one page
Field to sort by. Default is 'id'. Allowed values: id, updated_at.
Sort direction. Default is 'desc' (newest first). Allowed values: asc, desc.
Whether to include vendor information
Whether to include purchase order items
Whether to include sku information
Whether to include vendor sku information
Whether to include shipment items
Whether to include shipments
Headers
Merchant subdomain - Optional
Partner key - Optional
Response
Purchase order list response
Changes
- info
added the new optional
queryrequest parameterreceived_after - info
added the new optional
queryrequest parameterreceived_before - info
added the new optional
queryrequest parameterstatuses - info
added the new optional
queryrequest parameterupdated_before
- info
- info
added the new optional
queryrequest parameterlocation_mytime_id - info
added the new optional
queryrequest parametersku - info
added the new optional
queryrequest parametersort - info
added the new optional
queryrequest parametersort_order - info
added the new optional
queryrequest parameterupdated_after - info
added the new optional
queryrequest parametervendor_sku
- info