Skip to main content
PUT
/
2.0
/
return
/
{id}
Modify Return Order 
curl --request PUT \
  --url https://api.shipbob.com/2.0/return/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'shipbob_channel_id: <shipbob_channel_id>' \
  --data '
{
  "fulfillment_center": {
    "id": 0,
    "name": "Cicero (IL)"
  },
  "inventory": [
    {
      "id": 111222,
      "quantity": 1,
      "requested_action": "Default"
    }
  ],
  "original_shipment_id": 123456,
  "reference_id": "ShipBob_Return_123",
  "tracking_number": "1Z9999999999999999"
}
'
{
  "channel": {
    "id": 0,
    "name": "ShipBobs-Shopify-Store"
  },
  "completed_date": "2019-08-24T14:15:22Z",
  "customer_name": "string",
  "fulfillment_center": {
    "id": 0,
    "name": "Cicero (IL)"
  },
  "id": 0,
  "insert_date": "2019-08-24T14:15:22Z",
  "inventory": [
    {
      "action_requested": {
        "action": "Default",
        "action_type": "InventoryDefault",
        "instructions": "string"
      },
      "action_taken": [
        {
          "action": "Default",
          "action_reason": "string",
          "lot_information": [
            {
              "expiration_date": "2019-08-24T14:15:22Z",
              "lot_number": "string",
              "quantity_processed": 0
            }
          ],
          "quantity_processed": 1
        }
      ],
      "id": 0,
      "name": "string",
      "quantity": 0
    }
  ],
  "invoice_amount": 0.1,
  "original_shipment_id": 0,
  "reference_id": "string",
  "return_type": "Regular",
  "status": "AwaitingArrival",
  "store_order_id": "string",
  "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
  "transactions": [
    {
      "amount": 2.5,
      "transaction_type": "ReturnLabelInvoice"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

​
shipbob_channel_id
string<int32>
required

Channel Id for Operation

Path Parameters

​
id
string<int32>
required

Id of the return order

Body

application/json

Model defining the return

​
fulfillment_center
object
required

Information about a fulfillment center

​
inventory
object[] | null
required

Array of inventory items being returned

​
reference_id
string | null
required

Client-defined external unique identifier for the return order

Maximum string length: 50
Example:

"ShipBob_Return_123"

​
original_shipment_id
integer<int32> | null

Shipment from which the items in the return originated

Example:

123456

​
tracking_number
string | null

Tracking number for the return shipment

Maximum string length: 500
Example:

"1Z9999999999999999"

Response

Success

​
channel
object
​
completed_date
string<date-time> | null
​
customer_name
string | null
​
fulfillment_center
object
​
id
integer<int32>
​
insert_date
string<date-time>
​
inventory
object[] | null
​
invoice_amount
number<double> | null
​
original_shipment_id
integer<int32> | null
​
reference_id
string | null
​
return_type
enum<string>

Regular

ReturnToSender

Available options:
Regular,
ReturnToSender
​
status
enum<string>

AwaitingArrival

Arrived

Processing

Completed

Cancelled

Available options:
AwaitingArrival,
Arrived,
Processing,
Completed,
Cancelled
​
store_order_id
string | null
​
tags
object[] | null
​
tracking_number
string | null
​
transactions
object[] | null