Create a sales order

post

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

Creates a new sales order object.

Body Params

new sales order details

order_no

string

required

customer_id

integer

required

≤ 2147483647

sales_order_rows

array of objects

required

length ≥ 1

sales_order_rows*

quantity

number

required

≤ 100000000000000000

variant_id

integer

required

≤ 2147483647

tax_rate_id

integer

≤ 2147483647

location_id

integer

≤ 2147483647

attributes

array of objects

attributes

price_per_unit

number

≤ 1000000000000000000

total_discount

number

≤ 1000000000000000000

tracking_number

string | null

tracking_number_url

string | null

addresses

array of objects

addresses

order_created_date

string

delivery_date

string

currency

string

E.g. USD, EUR. All currently active currency codes in ISO 4217 format.

location_id

integer

≤ 2147483647

status

string

enum

When the status is omitted, NOT_SHIPPED is used as default. Use PENDING when you want to create sales order quotes.

Allowed:

additional_info

string

customer_ref

string | null

ecommerce_order_type

string

ecommerce_store_name

string

ecommerce_order_id

string

Responses

Language

Credentials

Bearer

Response

Choose an example:

application/json

200New sales order created

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

422Check the details property for a specific error message.

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

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