curl --request PUT \
--url https://gateway-dev.shipbob.dev/2025-07/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"
}
]
}curl --request PUT \
--url https://gateway-dev.shipbob.dev/2025-07/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"
}
]
}Authentication using Personal Access Token (PAT) token
Channel Id for Operation
Id of the return order
Model defining the return
Information about a fulfillment center
Show child attributes
Array of inventory items being returned
Show child attributes
Client-defined external unique identifier for the return order
50"ShipBob_Return_123"
Shipment from which the items in the return originated
123456
Tracking number for the return shipment
500"1Z9999999999999999"
Success
Show child attributes
Show child attributes
Show child attributes
Regular
ReturnToSender
Regular, ReturnToSender AwaitingArrival
Arrived
Processing
Completed
Cancelled
AwaitingArrival, Arrived, Processing, Completed, Cancelled Show child attributes
Show child attributes