Get Return Orders | ShipBob Developer API

curl -G https://sandbox-api.shipbob.com/1.0/return \
     -H "Authorization: Bearer <token>" \
     -d SortOrder=Newest \
     --data-urlencode StartDate=2019-08-24T14:15:22+00:00 \
     --data-urlencode EndDate=2019-08-24T14:15:22+00:00 \
     -d IDs=0 \
     -d ReferenceIds=string \
     -d Status=AwaitingArrival \
     -d FulfillmentCenterIds=0 \
     -d TrackingNumbers=string \
     -d OriginalShipmentIds=0 \
     -d InventoryIds=0

[
  {
    "channel": {
      "id": 0,
      "name": "ShipBobs-Shopify-Store"
    },
    "completed_date": "2019-08-24T14:15:22+00:00",
    "customer_name": "string",
    "fulfillment_center": {
      "id": 0,
      "name": "Cicero (IL)"
    },
    "id": 0,
    "insert_date": "2019-08-24T14:15:22+00:00",
    "inventory": [
      {
        "action_requested": {
          "action": 0,
          "action_type": "InventoryDefault",
          "instructions": "string"
        },
        "action_taken": [
          {
            "action": 0,
            "action_reason": "string",
            "lot_information": [
              {
                "expiration_date": "2019-08-24T14:15:22+00:00",
                "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

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

PageintegerOptional

Page of return orders to get

LimitintegerOptional

Amount of return orders per page to request

SortOrderenumOptional

Order to sort results by

Allowed values:

StartDatedatetimeOptional

Start date to filter orders inserted later than

EndDatedatetimeOptional

End date to filter orders inserted earlier than

IDslist of integersOptional

Comma separated list of return orders ids to filter by

ReferenceIdslist of stringsOptional

Comma separated list of reference ids to filter by

Statuslist of enumsOptional

Comma separated list of statuses to filter by

Allowed values:

FulfillmentCenterIdslist of integersOptional

Comma separated list of destination fulfillment center IDs to filter by

TrackingNumberslist of stringsOptional

Comma separated list of tracking numbers to filter by

OriginalShipmentIdslist of integersOptional

Comma separated list of original shipment IDs to filter by

InventoryIdslist of integersOptional

Comma separated list of inventory IDs contained in return to filter by

Response headers

Page-NumberstringOptional

Number of the current page

Total-PagesstringOptional

Total number of pages of results

Total-CountstringOptional

Total number of results

Page-SizestringOptional

Number of results per page

Response

Success

channelobjectOptional

Created by channel metadata

completed_datedatetime or nullOptional

Completed date for a return order.

customer_namestring or nullOptional

Customer name from the related shipment.

fulfillment_centerobjectOptional

Information about a fulfillment center

idintegerOptional

Unique id of the Return Order

insert_datedatetimeOptional

Date this return order was created

inventorylist of objects or nullOptional

List of inventory included in the return order

invoice_amountdouble or nullOptional

Invoiced amount of return order (sum of transaction amounts)

original_shipment_idinteger or nullOptional

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

reference_idstring or nullOptional

Client-defined external unique id of the return order

return_typeenumOptional

Allowed values:

statusenumOptional

Allowed values:

store_order_idstring or nullOptional

Store order for the related shipment.

tracking_numberstring or nullOptional

Tracking number of the return shipment

transactionslist of objects or nullOptional

Array of transactions affiliated with the return order

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Headers

Query parameters

Response headers

Response

Errors