List Shipments
GET/api/magento2/integration-instances/:magento2IntegrationInstance/shipments
Paginated Magento 2 shipments for the instance, newest first (by magento_created_at, then id).
Response contract (matches the frontend Magento2Shipment type): shipment_number (shipment's own Magento increment), magento_order_id (internal magento2_orders.id — drives the order link + tooltip), magento_increment_id (ORDER increment — the user-facing reference), status (pushed | synced), carrier (alias of tracking_carrier), source_code (MSI source).
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.