Get Return Orders

View as Markdown

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Headers

shipbob_channel_idstringOptionalformat: "int32"
Channel Id for operation

Query parameters

IdsstringOptional

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

ReferenceIdsstringOptional

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

StatusstringOptional

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

FulfillmentCenterIdsstringOptional

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

TrackingNumbersstringOptional

Comma-separated list of tracking numbers to filter by.

OriginalShipmentIdsstringOptional

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

InventoryIdsstringOptional

Comma-separated list of inventory IDs to filter by.

StartDatedatetimeOptional

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

EndDatedatetimeOptional

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

ReturnTypesstringOptional

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

ReturnActionsstringOptional

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

StoreOrderIdsstringOptional

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

SortbystringOptional
Field to sort results by.
CompletedStartDatedatetimeOptional

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

CompletedEndDatedatetimeOptional

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

CursorintegerOptional1-2147483647
LimitstringOptionalformat: "int32"
SortOrderstringOptionalformat: "int32"

Response headers

Page-NumberstringOptional
Current page number
Total-PagesstringOptional
Total pages
Total-CountstringOptional
Total records
Page-SizestringOptional
Page size

Response

Success
firststring or nullOptionalformat: "uri"
itemslist of objects or nullOptional
laststring or nullOptionalformat: "uri"
nextstring or nullOptionalformat: "uri"
prevstring or nullOptionalformat: "uri"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error