List Returns
GET/api/shipbob/:instance/returns
Paginated, filterable, sortable list of ShipBob returns for the instance.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Free-text search covers reference_id and tracking_number. Default page size is 10.
Filter filter[return_type] (and return_type.is / .is_not / .is_one_of / .is_not_one_of) matches every spelling of a type: ReturnToSender and RTS both select return-to-sender returns.
Each return carries cross-links: original_shipment (the synced ShipBob shipment, matched by ShipBob shipment id within this instance), original_order (its ShipBob order) and sales_order (the SKU.io sales order that shipment fulfilled) — each null when not resolvable. return_type_label is the display name; ShipBob sends return-to-sender as either "RTS" or "ReturnToSender" and both read "Return to Sender". items[] lists each returned inventory item with requested_action (+ requested_action_type, instructions) and what the warehouse did: action_taken (comma-joined actions), action_taken_quantity, action_taken_reason — null until processed.
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.