Skip to main content

List Merged Shipments

GET 
/api/v2/merged-shipments

Returns a paginated list of merged shipments (sales-order merge groups).

Required scope: orders:read

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

Authentication: Requires Bearer token.

Query Parameters:

  • page (integer): Page number (default 1)
  • per_page (integer): Items per page (default 10)
  • sort (string): One of id, merged_shipment_number, status, created_at, shipped_at. Prefix with - for descending. Default -id.
  • filter[id]: Exact match
  • filter[status]: Exact match on status enum (awaiting_pack, awaiting_label, awaiting_ship, shipped, cancelled, unmerged)
  • filter[warehouse_id]: Exact match
  • filter[merged_shipment_number]: Partial match
  • filter[open_only]: Boolean — restricts to in-progress merge groups (excludes cancelled/unmerged/shipped)

Request​

Responses​

OK