For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sales Orders

Sales Orders

post
Body
customerstringRequired
pick_locationstring · nullableOptionalDefault: null
shipping_locationstring · nullableOptionalDefault: null
delivery_datestring · date · nullableOptional

In your local timezone.

Default: null
shipping_namestring · nullableOptionalDefault: null
shipping_feenumber · nullableOptionalDefault: null
shipping_fee_taxnumber · nullableOptionalDefault: null
invoice_due_atstring · date · nullableOptional

In your local timezone. If this is not provided, then a date will be calculated based on your customer's payment terms.

Default: null
payment_methodstring · nullableOptional

This must be one of the methods available to your customer, eg Credit Card, Invoice, etc.

Default: null
referencestring · nullableOptionalDefault: null
notesstring · nullableOptionalDefault: null
statusstring · enumOptional

Whether to create this Sales Order in draft status, or to proceed with placing the order.

Default: DRAFTPossible values:
Responses
201

Created

application/json
idstringOptional
typestring · enumOptionalPossible values:
supplier_idintegerOptional
order_numberstring · nullableOptional
sourcestring · nullableOptional
statusstring · nullableOptional
referencestring · nullableOptional
created_atstring · datetimeOptional
modified_atstring · datetimeOptional
invoice_due_atstring · datetime · nullableOptional
shipped_atstring · datetime · nullableOptional
paid_atstring · datetime · nullableOptional
completed_atstring · datetime · nullableOptional
pick_location_idstring · nullableOptional
pick_location_namestring · nullableOptional
delivery_datestring · datetime · nullableOptional
currencystringOptional
amountnumberOptional
amount_notaxnumberOptional
amount_taxnumberOptional
amount_paidnumber · nullableOptional
payment_methodstring · nullableOptional
shipping_namestring · nullableOptional
shipping_feenumber · nullableOptional
shipping_fee_notaxnumber · nullableOptional
shipping_fee_taxnumber · nullableOptional
credit_card_feenumber · nullableOptional
credit_card_fee_notaxnumber · nullableOptional
credit_card_fee_taxnumber · nullableOptional
creditnumber · nullableOptional
credit_notaxnumber · nullableOptional
credit_taxnumber · nullableOptional
notesstringOptional
last_modified_atstring · nullableOptional
post/v1/sales-orders/
201

Created

get

Fetch the latest Fulfilments from all Sales Orders

Query parameters
pageintegerOptional
Responses
200

OK

application/json
get/v1/sales-orders/fulfilments/latest
200

OK

get

Fetch the Fulfilments for the given Sales Order ID

Query parameters
idstringRequired
Responses
200

OK

application/json

If you only want "confirmed" fulfilments then check whether shipped_at has been set.

idstringOptional
fulfilment_numberstring · nullableOptional
created_atstring · datetimeOptional
modified_atstring · datetimeOptional
sales_order_idstringOptional
sales_order_numberstringOptional
shipping_typestringOptional
shipping_rule_idnumber · nullableOptional
shipping_namestring · nullableOptional
pick_start_atstring · datetime · nullableOptional
pick_end_atstring · datetime · nullableOptional
pack_start_atstring · datetime · nullableOptional
pack_end_atstring · datetime · nullableOptional
delivery_datestring · datetime · nullableOptional
shipped_atstring · datetime · nullableOptional
get/v1/sales-orders/get/fulfilments
200

OK

get
Query parameters
idstringRequired
Responses
200

OK

application/json
idstringOptional
typestring · enumOptionalPossible values:
supplier_idintegerOptional
order_numberstring · nullableOptional
sourcestring · nullableOptional
statusstring · nullableOptional
referencestring · nullableOptional
created_atstring · datetimeOptional
modified_atstring · datetimeOptional
invoice_due_atstring · datetime · nullableOptional
shipped_atstring · datetime · nullableOptional
paid_atstring · datetime · nullableOptional
completed_atstring · datetime · nullableOptional
pick_location_idstring · nullableOptional
pick_location_namestring · nullableOptional
delivery_datestring · datetime · nullableOptional
currencystringOptional
amountnumberOptional
amount_notaxnumberOptional
amount_taxnumberOptional
amount_paidnumber · nullableOptional
payment_methodstring · nullableOptional
shipping_namestring · nullableOptional
shipping_feenumber · nullableOptional
shipping_fee_notaxnumber · nullableOptional
shipping_fee_taxnumber · nullableOptional
credit_card_feenumber · nullableOptional
credit_card_fee_notaxnumber · nullableOptional
credit_card_fee_taxnumber · nullableOptional
creditnumber · nullableOptional
credit_notaxnumber · nullableOptional
credit_taxnumber · nullableOptional
notesstringOptional
last_modified_atstring · nullableOptional
get/v1/sales-orders/get
200

OK

get

Fetch the latest Invoices from all Sales Orders

Query parameters
pageintegerOptional
Responses
200

OK

application/json
get/v1/sales-orders/invoices/latest
200

OK

get

Fetch the Invoices for the given Sales Order ID

Query parameters
idstringRequired
Responses
200

OK

application/json

If you only want "sent" or "issued" invoices then check whether invoice_sent_at has been set.

idstringOptional
invoice_numberstring · nullableOptional
referencestring · nullableOptional
created_atstring · datetimeOptional
modified_atstring · datetimeOptional
sales_order_idstringOptional
sales_order_numberstringOptional
amountnumberOptional
amount_notaxnumberOptional
amount_taxnumberOptional
currencystringOptional
conversion_ratenumberOptional
payment_methodstringOptional
invoice_sent_atstring · datetime · nullableOptional
invoice_due_atstring · datetime · nullableOptional
paid_atstring · datetime · nullableOptional
paid_amountnumber · nullableOptional
get/v1/sales-orders/get/invoices
200

OK

get
Query parameters
pageintegerOptional
Responses
200

OK

application/json
get/v1/sales-orders/latest
200

OK

put
Query parameters
idstringRequired
Body
shipping_locationstring · nullableOptionalDefault: null
delivery_datestring · date · nullableOptional

In your local timezone.

Default: null
shipping_namestring · nullableOptionalDefault: null
shipping_feenumber · nullableOptionalDefault: null
shipping_fee_taxnumber · nullableOptionalDefault: null
invoice_due_atstring · date · nullableOptional

In your local timezone. If this is not provided, then a date will be calculated based on your customer's payment terms.

Default: null
payment_methodstring · nullableOptional

This must be one of the methods available to your customer, eg Credit Card, Invoice, etc.

Default: null
notesstring · nullableOptionalDefault: null
statusstring · enum · nullableOptional

Whether to put this Sales Order into draft status, or to proceed with placing the order.

Default: nullPossible values:
Responses
202

Accepted

application/json
idstringOptional
typestring · enumOptionalPossible values:
supplier_idintegerOptional
order_numberstring · nullableOptional
sourcestring · nullableOptional
statusstring · nullableOptional
referencestring · nullableOptional
created_atstring · datetimeOptional
modified_atstring · datetimeOptional
invoice_due_atstring · datetime · nullableOptional
shipped_atstring · datetime · nullableOptional
paid_atstring · datetime · nullableOptional
completed_atstring · datetime · nullableOptional
pick_location_idstring · nullableOptional
pick_location_namestring · nullableOptional
delivery_datestring · datetime · nullableOptional
currencystringOptional
amountnumberOptional
amount_notaxnumberOptional
amount_taxnumberOptional
amount_paidnumber · nullableOptional
payment_methodstring · nullableOptional
shipping_namestring · nullableOptional
shipping_feenumber · nullableOptional
shipping_fee_notaxnumber · nullableOptional
shipping_fee_taxnumber · nullableOptional
credit_card_feenumber · nullableOptional
credit_card_fee_notaxnumber · nullableOptional
credit_card_fee_taxnumber · nullableOptional
creditnumber · nullableOptional
credit_notaxnumber · nullableOptional
credit_taxnumber · nullableOptional
notesstringOptional
last_modified_atstring · nullableOptional
put/v1/sales-orders/modify
202

Accepted

delete
Query parameters
idstringRequired
Responses
202

Accepted

No content

delete/v1/sales-orders/modify
202

Accepted

No content

Last updated