API Reference
Knowledge Base

List all sales returns

get
https://api.katanamrp.com/v1/sales_returns

Returns a list of sales returns you've previously created.
The sales returns are returned in a sorted order,
with the most recent sales return appearing first.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of integers

Filters sales returns by an array of IDs

ids
string

Filters sales returns by an order number

integer

Filters sales returns by a sales order id

enum

Filters sales returns by a (return) status

Allowed:
enum

Filters sales returns by a refund status

Allowed:
string

Minimum value for return_date range. Must be compatible with ISO 8601 format

string

Maximum value for return_date range. Must be compatible with ISO 8601 format

string

Minimum value for order_created_date range. Must be compatible with ISO 8601 format

string

Maximum value for order_created_date range. Must be compatible with ISO 8601 format

boolean

Soft-deleted data is excluded from result set by default. Set to true to include it.

string

Used for pagination (default is 50)

string

Used for pagination (default is 1)

string

Minimum value for created_at range. Must be compatible with ISO 8601 format

string

Maximum value for created_at range. Must be compatible with ISO 8601 format

string

Minimum value for updated_at range. Must be compatible with ISO 8601 format

string

Maximum value for updated_at range. Must be compatible with ISO 8601 format

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago