Skip to main content

List ShipHero Purchase Orders

GET 

/api/shiphero/integration-instances/:integration_instance/purchase-orders

Paginated list of the ShipHero purchase orders this connection created, held back or linked.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

display_status: held, failed, pending, sent, out_of_sync (the SKU.io PO changed since it was sent), receiving, canceled, closed or superseded.

Filters: filter[status] (comma list of stored statuses pending, sent, held, failed, canceled, closed, superseded, plus out_of_sync and receiving), filter[kind] (primary, supplementary, revision), filter[out_of_sync] (true/false), filter[sent_between] (from,to dates, Y-m-d), filter[search] (ID, PO number, ShipHero PO, last error), and advanced filters on id, po_number, shiphero_legacy_id, sent_at, created_at.

Allowed sorts: id, po_number, shiphero_legacy_id, kind, status, sent_at, last_pushed_at, last_synced_at, created_at, updated_at (prefix with - for descending; default -id). Pagination: page, per_page (default 10).

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type