PUT
/
return
/
{id}
curl --request PUT \
  --url https://api.shipbob.com/2.0/return/{id} \
  --header 'Authorization: <api-key>' \
  --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

Provide your personal access token in the format 'Bearer {your_personal_access_token}'

Headers

​
shipbob_channel_id
string
required

Channel Id for Operation

Path Parameters

​
id
string
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 length: 50
Example:

"ShipBob_Return_123"

​
original_shipment_id
integer | null

Shipment from which the items in the return originated

Example:

123456

​
tracking_number
string | null

Tracking number for the return shipment

Maximum length: 500
Example:

"1Z9999999999999999"

Response

200
application/json
Success
​
channel
object

Created by channel metadata

​
completed_date
string | null

Completed date for a return order.

​
customer_name
string | null

Customer name from the related shipment.

​
fulfillment_center
object

Information about a fulfillment center

​
id
integer

Unique id of the Return Order

​
insert_date
string

Date this return order was created

​
inventory
object[] | null

List of inventory included in the return order

​
invoice_amount
number | null

Invoiced amount of return order (sum of transaction amounts)

​
original_shipment_id
integer | null

Id of the corresponding shipment that is the souce of the return

​
reference_id
string | null

Client-defined external unique id of the return order

​
return_type
enum<string>
Available options:
Regular,
ReturnToSender
​
status
enum<string>
Available options:
AwaitingArrival,
Arrived,
Processing,
Completed,
Cancelled
​
store_order_id
string | null

Store order for the related shipment.

​
tracking_number
string | null

Tracking number of the return shipment

Example:

"860C8CDC8F0B4FC7AB69AC86C20539EC"

​
transactions
object[] | null

Array of transactions affiliated with the return order

Was this page helpful?