v6

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-09153208467.0 KB
returns

Search for returns

ADD ENDPOINT DESCRIPTION HERE

get/returns

Query parameters

querystring

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

sortstring

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

pageinteger

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

searchAfterstring

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

pageSizeinteger

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

successful operation

warehouseIdinteger
returnShipmentIdentifierstring
sellerIdinteger
returnShipmentIdinteger
orderIdinteger
fulfillmentOrderIdinteger
returnAnnouncementIdinteger
receivedDatestring date-time
shipFromCountrystring
shipFromZipstring
shipFromCompanystring
shipFromName1string
shipFromName2string
trackingLinkstring
trackingNumberstring
carrierSlugstring
returnShipmentReferencestring
customerExaminedboolean