Get Return Order

GET /1.0/return/{id}

Get Return Order

cURL

curl --request GET \
  --url https://api.shipbob.com/1.0/return/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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"
    }
  ]
}

API 1.0 is deprecated and will be sunset on July 31, 2026. Please migrate to the latest API version. See our Versioning Policy for details.

Authorizations

Authorization · string · header · required

Authentication using Personal Access Token (PAT) token

Headers

shipbob_channel_id · string<int32>

Channel Id for Operation

Path Parameters

id · string<int32> · required

Id of the return order

Response

200

application/json

Success

channel · object

Created by channel metadata

Show child attributes

completed_date · string<date-time> | 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

Show child attributes

id · integer<int32>

Unique id of the Return Order

insert_date · string<date-time>

Date this return order was created

inventory · object[] | null

List of inventory included in the return order

Show child attributes

invoice_amount · number<double> | null

Invoiced amount of return order (sum of transaction amounts)

original_shipment_id · integer<int32> | 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

Show child attributes