Links

Search

A comprehensive list of the search query keys and allowed fields values for the return resource
To perform a search query on the return resource send a POST request to the /returns/search endpoint specifying in the payload the query keys and filter parameters like in the generic example below:
{
"search": {
"limit": ...,
"sort": "...",
"sort_by": "...",
"interval": "...",
"fields": [ "...", "...", ... ],
"cursor": "..."
},
"filter": { ... }
}
Please find more information on how search queries work here.

Query keys

These are the keys you need to set when performing a search query:
Key
Type
Required
Description
Values
limit
Integer
The maximum number of records shown in the response.
Default is 50, max is 100.
sort
String
The way you want the results of the query to be sorted.
One of asc or desc (default is desc).
sort_by
String
The date field you want the results of the query sorted by.
Here the full list of valid values for this key. Default is return.current_date.
fields
Array
The list of fields you want to be returned for each record in the response.
Here the full list of valid values for this key. Cannot be empty. Use the .* syntax to request all the attribute for a specific field.
cursor
String
The cursor pointing to a specific page in the paginated search results.
Every time you perform a search query you get the cursor to the next page in the pagination object.

sort_by values

These are the valid values you can specify for the sort_by key of the search query:
  • return.approved_at
  • return.archived_at
  • return.cancelled_at
  • return.created_at
  • return.current_date
  • return.received_at
  • return.rejected_at
  • return.restocked_at
  • return.shipped_at
  • return.updated_at

field values

These are the valid values you can specify for the field key of the search query:
  • customer.*
  • customer.email
  • customer.group_name
  • customer.id
  • destination_address.*
  • destination_address.business
  • destination_address.city
  • destination_address.country_code
  • destination_address.geocoded
  • destination_address.localized
  • destination_address.state_code
  • destination_address.zip_code
  • market.*
  • market.id
  • market.name
  • market.number
  • origin_address.*
  • origin_address.business
  • origin_address.city
  • origin_address.country_code
  • origin_address.geocoded
  • origin_address.localized
  • origin_address.state_code
  • origin_address.zip_code
  • return.*
  • return.approved_at
  • return.archived_at
  • return.cancelled_at
  • return.created_at
  • return.current_date
  • return.id
  • return.number
  • return.order_id
  • return.received_at
  • return.reference
  • return.reference_origin
  • return.rejected_at
  • return.shipped_at
  • return.skus_count
  • return.status
  • return.updated_at
  • return_line_items.*
  • return_line_items.created_at
  • return_line_items.line_item_code
  • return_line_items.line_item_id
  • return_line_items.line_item_item_type
  • return_line_items.line_item_tax_amount
  • return_line_items.line_item_tax_rate
  • return_line_items.line_item_total_amount
  • return_line_items.line_item_updated_at
  • return_line_items.quantity
  • return_line_items.restocked_at
  • return_line_items.updated_at
  • stock_location.*
  • stock_location.id
  • stock_location.name
  • stock_location.reference
  • stock_location.reference_origin
  • tags.*
  • tags.id
  • tags.name
Last modified 9mo ago