Get 2026 07 Return

Get Return Orders

GET/2026-07/return

Use it in a workflow

Add a step and choose the ShipBob connector.
Pick the Get 2026 07 Return action (under ShipBob).
Fill in the fields below, then reference the result from later steps as {{get202607Return.response.data}}.

Request

Query parameters

Idsstring

The IDs of the returns to fetch. Accepts a comma-separated list of return IDs (e.g., 123,456,789).

ReferenceIdsstring

Comma-separated list of return reference IDs (RMA numbers) to filter by.

Statusstring

Comma-separated list of return statuses to filter by (e.g., AwaitingArrival, Arrived, Processing, Completed, Cancelled).

FulfillmentCenterIdsstring

Comma-separated list of fulfillment center IDs to filter by.

TrackingNumbersstring

Comma-separated list of tracking numbers to filter by.

OriginalShipmentIdsstring

Comma-separated list of original shipment IDs to filter by.

InventoryIdsstring

Comma-separated list of inventory IDs to filter by.

StartDatestring (date-time)

Filter returns created on or after this date (ISO 8601 format).

EndDatestring (date-time)

Filter returns created on or before this date (ISO 8601 format).

ReturnTypesstring

Comma-separated list of return types to filter by (e.g., Regular, ReturnToSender).

ReturnActionsstring

Comma-separated list of return actions to filter by (e.g., Restock, Quarantine, Dispose).

StoreOrderIdsstring

Comma-separated list of store order IDs to filter by.

Sortbystring

Field to sort results by.

CompletedStartDatestring (date-time)

Filter returns completed on or after this date (ISO 8601 format).

CompletedEndDatestring (date-time)

Filter returns completed on or before this date (ISO 8601 format).

Cursorinteger (int32)

Page number to retrieve. Used for pagination through result sets.

Limitinteger (int32)

Maximum number of records to return per page.

SortOrderstring

Sort order for results. Desc = newest to oldest, Asc = oldest to newest, Desc is default

One ofAscDesc

Headers

shipbob_channel_idinteger (int32)

Channel Id for operation

Response

Returns 200 with an object. Read it in later steps with {{get202607Return.response.data.<field>}}.

firststring (uri)

Return url for first cursor

itemsarray<object>

Return records

arrived_datestring (date-time)

The date and time when the return arrived at the fulfillment center

awaiting_arrival_datestring (date-time)

The date and time when the return entered Awaiting Arrival status

cancelled_datestring (date-time)

The date and time when the return was cancelled, if applicable

channelobject2 fields

The details of a Channel

completed_datestring (date-time)

The date and time for when the return order was completely processed

customer_namestring

Name of merchant that return belongs to

fulfillment_centerobject2 fields

The details of a Fulfillment Center

idinteger (int32)

Unique id of the return order

insert_datestring (date-time)

The date and time for when the return order was created

inventoryarray<object>9 fields

List of inventory items in return order

invoiceobject2 fields

The invoice amount and curency

original_shipment_idinteger (int32)

ShipmentId for which return was created

processing_datestring (date-time)

The date and time when the return started processing

reference_idstring

Unique reference id of the return order. Created by merchant if a regular return.

return_typestring

Type of the return, i.e. Regular, RTS

shipment_tracking_numberstring

The tracking number of the original shipment

statusstring

Status of the return order, i.e. `Awaiting Arrival`, `Arrived`, `Processing`, `Completed` `Cancelled`

status_historyarray<object>2 fields

List of status history in return order

store_order_idstring

Reference to external order id

tracking_numberstring

The tracking number of the return shipping label

transactionsarray<object>2 fields

List of transactions that make up the billable amount to invoice a merchant

laststring (uri)

Return url for last cursor

nextstring (uri)

Return url for next cursor

prevstring (uri)

Return url for prev cursor

json

{
  "first": "string",
  "items": [
    {
      "arrived_date": "2025-01-01T00:00:00Z",
      "awaiting_arrival_date": "2025-01-01T00:00:00Z",
      "cancelled_date": "2025-01-01T00:00:00Z",
      "channel": {
        "id": 0,
        "name": "string"
      },
      "completed_date": "2025-01-01T00:00:00Z",
      "customer_name": "string",
      "fulfillment_center": {
        "id": 0,
        "name": "string"
      },
      "id": 0,
      "insert_date": "2025-01-01T00:00:00Z",
      "inventory": [
        {
          "action_requested": {
            "action": "string",
            "action_type": "string",
            "instructions": "string"
          },
          "action_taken": [
            {
              "action": null,
              "action_reason": null,
              "image_url": null,
              "quantity_processed": null
            }
          ],
          "barcodes": [
            "string"
          ],
          "bundle_parent_sku": "string",
          "id": 0,
          "lot_information": {
            "expiration": "2025-01-01T00:00:00Z",
            "minimumShelfLife": 0,
            "number": "string"
          },
          "name": "string",
          "quantity": 0,
          "sku": "string"
        }
      ],
      "invoice": {
        "amount": 0,
        "currency_code": "string"
      },
      "original_shipment_id": 0
    }
  ],
  "last": "string",
  "next": "string",
  "prev": "string"
}

Need more? See the ShipBob guide for connection setup and behaviour shared by every action.

Was this page helpful?