Retrieve List of Returns

get

https://api.shipmonk.com/v1/integrations/returns-list

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

rma

string | null

Defaults to null

Return only returns whose Return Merchandise Authorization (RMA) number matches this value.

return_status

Return Status | null

Defaults to null

Return only returns currently in this status (e.g., pending, processing, completed).

warehouse_id

integer | null

Defaults to null

Numeric identifier of the warehouse processing the return; use the value returned by the warehouses endpoint.

return_reason

Return Reason | null

Defaults to null

Return only returns flagged with this reason code (e.g., damaged, wrong_item, no_longer_needed).

created_at

date-time

Defaults to null

Return only returns created at or after this ISO 8601 timestamp.

updated_at

date-time

Defaults to null

Return only returns updated at or after this ISO 8601 timestamp.

desired_action

Return Item Status | null

Defaults to null

Return only returns whose items have this intended processing action (e.g., restock, dispose).

page

integer

Defaults to 1

1-based page number to return. Defaults to 1.

page_size

integer

1 to 100

Defaults to 100

Number of results per page (default and maximum values are documented at the endpoint level).

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success