/returnnotices/

Retrieve ReturnNotice list including search & filters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number

Filter by Warehouse

string

Filter by Sender

string

Filter by Delivery Date %Y-%m-%d

boolean

Filter by Shipnotices that are Overdue

string

Filter by Date Received %Y-%m-%d

number

Filter by Status:

  • STATUS_IN_TRANSIT = 80
  • STATUS_ARRIVED = 90
  • STATUS_PROCESSING = 100
  • STATUS_COMPLETED = 200

Return Status:

  • STATUS_RETURN_NEW = 50
  • STATUS_RETURN_SENT_TO_CUSTOMER = 60
  • STATUS_RETURN_LABEL_PURCHASE_FAIL = 70

Projects:

  • STATUS_PROJECT = 20
string

Filter by Service Level

string

Cursor-based forward pagination. Returns only records with id strictly greater than the given value. Use the id of the last record in the previous page to fetch the next page.

string

Cursor-based backward pagination. Returns only records with id strictly less than the given value. Use the id of the first record in the current page to fetch the previous page.

string

Return records created on or after this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T00:00:00Z).

string

Return records created on or before this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T23:59:59Z).

string

Return records updated on or after this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T00:00:00Z).

string

Return records updated on or before this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T23:59:59Z).

string

Return ship notices received on or after this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

string

Return ship notices received on or before this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

string

Search from the following fields: sku, barcode, tracking_number, integration_id, po_number, bol_number, pro_number

string

Sort results by one or more fields. Allowed fields: created, updated, id, status, delivery_date, date_received. Prefix with - for descending order (e.g. -created). Default: -created.

integer

Number of results to return per page.

integer

The initial index from which to return the results.

Responses

400

Bad Request

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json