Webhooks
Products
Inventory
Orders
- POSTCancel one Shipment by Shipment Id
- GETGet one Shipment's status timeline by Shipment Id
- GETGet Orders
- POSTCreate Order
- GETGet one Shipment by Order Id and Shipment Id
- GETGet logs for one Shipment by Shipment Id
- GETGet all Shipments for Order
- GETGet one Shipment's status timeline by Order Id and Shipment Id
- GETGet one Shipment by Shipment Id
- PUTUpdate a Shipment
- GETGet logs for one Shipment by Order Id and Shipment Id
- POSTCancel multiple Shipments by Shipment Id
- POSTEstimate Fulfillment Cost For Order
- GETGet shipping methods
- POSTCancel single Order by Order ID
- GETGet Order Store Json
- POSTSave the Store Order Json
- GETGet Order
- POSTCancel one Shipment by Order Id and Shipment Id
Locations
Receiving
- GETGet Fulfillment Centers
- GETGet Warehouse Receiving Order Box Labels (DEPRECATED)
- POSTCancel Warehouse Receiving Order (DEPRECATED)
- GETGet a Warehouse Receiving Order by Purchase Order Number (DEPRECATED)
- POSTCreate Warehouse Receiving Order (DEPRECATED)
- GETGet Warehouse Receiving Order (DEPRECATED)
Returns
Channels
Returns
Get Return Order
Returns
Get Return Order
GET
/
return
/
{id}
curl --request GET \
--url https://api.shipbob.com/1.0/return/{id} \
--header 'Authorization: Bearer <token>'
{
"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
Authentication using Personal Access Token (PAT) token
Headers
Channel Id for Operation
Path Parameters
Id of the return order
Response
200
application/json
Success
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.shipbob.com/1.0/return/{id} \
--header 'Authorization: Bearer <token>'
{
"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"
}
]
}