Skip to main content
POST
/
2026-01
/
return
Create Return Order 
curl --request POST \
  --url https://sandbox-api.shipbob.com/2026-01/return \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'shipbob_channel_id: <shipbob_channel_id>' \
  --data '
{
  "fulfillment_center": {
    "id": 0,
    "name": "string"
  },
  "inventory": [
    {
      "id": 0,
      "lot_date": "2019-08-24T14:15:22Z",
      "lot_number": "string",
      "quantity": 0,
      "requested_action": 0
    }
  ],
  "original_shipment_id": 0,
  "reference_id": "string",
  "tracking_number": "string"
}
'
{
  "channel": {
    "id": 0,
    "name": "string"
  },
  "completed_date": "2019-08-24T14:15:22Z",
  "customer_name": "string",
  "fulfillment_center": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "insert_date": "2019-08-24T14:15:22Z",
  "inventory": [
    {
      "action_requested": {
        "action": "string",
        "action_type": "string",
        "instructions": "string"
      },
      "action_taken": [
        {
          "action": "string",
          "action_reason": "string",
          "image_url": "http://example.com",
          "quantity_processed": 0
        }
      ],
      "id": 0,
      "name": "string",
      "quantity": 0
    }
  ],
  "invoice_amount": 0.1,
  "original_shipment_id": 0,
  "reference_id": "string",
  "return_type": "string",
  "status": "string",
  "store_order_id": "string",
  "tracking_number": "string",
  "transactions": [
    {
      "amount": 0.1,
      "transaction_type": "string"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

​
shipbob_channel_id
string<int32>
required

Channel Id for operation

Body

application/json

The return order creation request containing return details, items, and configuration.

The request payload for creating a Return of inventory.

​
fulfillment_center
object
required

A Facility to process Returns.

​
inventory
object[]
required

Array of inventory items being returned

Minimum array length: 1
​
reference_id
string
required

Client-defined external unique identifier for the return order. If tracking id is not provided, this value must appear on the box label as RMA. Example: ShipBob_Return_123

Required string length: 1 - 50
​
original_shipment_id
integer<int32> | null

Shipment from which the items in the return originated 123456

​
tracking_number
string | null

Tracking number for the return shipment 1Z9999999999999999

Maximum string length: 500

Response

Created

The details of a public return order (V1), including the transactions and inventory items

​
channel
object

The details of a Channel

​
completed_date
string<date-time> | null

The date and time for when the return order was completely processed

​
customer_name
string | null

Name of merchant that return belongs to

​
fulfillment_center
object

The details of a Fulfillment Center

​
id
integer<int32>

Unique id of the return order

​
insert_date
string<date-time>

The date and time for when the return order was created

​
inventory
object[] | null

List of inventory items in return order

​
invoice_amount
number<double> | null

Amount merchant was invoiced for processing the return

​
original_shipment_id
integer<int32> | null

ShipmentId for which return was created

​
reference_id
string | null

Unique reference id of the return order. Created by merchant if a regular return.

​
return_type
string | null

Type of the return, i.e. Regular, RTS

​
status
string | null

Status of the return order, i.e. Awaiting Arrival, Arrived, Processing, Completed Cancelled

​
store_order_id
string | null

Reference to external order id

​
tracking_number
string | null

The tracking number of the return shipping label

​
transactions
object[] | null

List of transactions that make up the billable amount to invoice a merchant