API Reference
Knowledge Base

Create a sales order

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

Creates a new sales order object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

new sales order details

string
integer
required
≤ 2147483647
sales_order_rows
array of objects
required
length ≥ 1
sales_order_rows*
number
required
≤ 100000000000000000
integer
required
≤ 2147483647
integer
≤ 2147483647
integer
≤ 2147483647
attributes
array of objects
attributes
number
≤ 1000000000000000000
number
≤ 1000000000000000000
string | null
string | null
addresses
array of objects
addresses
string
string
string

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

integer
≤ 2147483647
string
enum

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

Allowed:
string
string | null
string
string
string
custom_fields
object | null

Behind feature flag — contact [email protected] to enable. Custom field values keyed by custom field definition ID (UUID). Each value matches the definition’s field_type — string for shortText/url, number for number, boolean for boolean, YYYY-MM-DD string for date, or the integer choice id for singleSelect.

Responses

Updated 20 days ago

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

Updated 20 days ago