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.

tracking_number and tracking_number_url pre-fill the next shipment’s tracking and are empty once a fulfillment has taken them. Read shipped tracking from /sales_order_fulfillments: each fulfillment carries its own.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of integers

Filters sales orders by an array of IDs

ids

order_no

string

Filters sales orders by an order number

source

string

Filters sales orders by a creation source

location_id

number

Filters sales orders by location

customer_id

number

Filters sales orders by customer

status

string

Filters sales orders by a status

currency

string

Filters sales orders by currency

invoicing_status

string

Filters sales orders by an invoicing status

product_availability

enum

Filters sales orders by product availability

Allowed:

ingredient_availability

enum

Filters sales orders by ingredient availability

Allowed:

production_status

enum

Filters sales orders by production status

Allowed:

ecommerce_order_type

string

Filters sales orders by an e-commerce order type

ecommerce_store_name

string

Filters sales orders by an e-commerce store name

ecommerce_order_id

string

Filters sales orders by an e-commerce order id

include_deleted

boolean

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

limit

string

Used for pagination (default is 50)

page

string

Used for pagination (default is 1)

created_at_min

string

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

created_at_max

string

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

updated_at_min

string

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

updated_at_max

string

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

Responses

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json

200List all sales orders

401Make sure you've entered your API token correctly.

429The rate limit has been reached. Please try again later.

500The server encountered an error. If this persists, please contact support