Skip to main content

Get Return

GET 

/api/shipbob/:instance/returns/:return

Retrieve a single ShipBob return by its SKU.io row id (falling back to the ShipBob return id), scoped to the instance.

Required scope: integrations:read

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

Authentication: Requires Bearer token.

The path id accepts EITHER the local record id (as returned by the list endpoint) OR the external ShipBob id, so both in-app links and external/deep links resolve.

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.

On this detail endpoint only, product_links gives each item's ShipBob product page and mapped SKU.io product: {inventory_id, shipbob_product: {id, sku, name, link_route}, sku_product: {id, sku, link_route} | null}.

Request​

Responses​

OK

Response Headers
    Content-Type