API Reference
Knowledge Base

List all sales orders

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

Returns a list of sales orders you’ve previously created. The sales orders are returned in a sorted order, with the most recent sales orders 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 orders by an array of IDs

ids
string

Filters sales orders by an order number

string

Filters sales orders by a creation source

number

Filters sales orders by location

number

Filters sales orders by customer

string

Filters sales orders by a status

string

Filters sales orders by currency

string

Filters sales orders by an invoicing status

enum

Filters sales orders by product availability

Allowed:
enum

Filters sales orders by ingredient availability

Allowed:
enum

Filters sales orders by production status

Allowed:
string

Filters sales orders by an e-commerce order type

string

Filters sales orders by an e-commerce store name

string

Filters sales orders by an e-commerce order id

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 8 months ago

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

Updated 8 months ago