Sales Orders
Sales Orders
nullnullIn your local timezone.
nullnullnullnullIn your local timezone. If this is not provided, then a date will be calculated based on your customer's payment terms.
nullThis must be one of the methods available to your customer, eg Credit Card, Invoice, etc.
nullnullnullWhether to create this Sales Order in draft status, or to proceed with placing the order.
DRAFTPossible values: Created
Deprecated: Use 'paid_at' on invoices instead
Deprecated: Use 'paid_amount' on invoices instead
POST /v1/sales-orders/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 336
{
"customer": "text",
"pick_location": "text",
"shipping_location": "text",
"delivery_date": "2026-01-01",
"shipping_name": "text",
"shipping_fee": 1,
"shipping_fee_tax": 1,
"invoice_due_at": "2026-01-01",
"payment_method": "text",
"reference": "text",
"notes": "text",
"status": "DRAFT",
"line_items": [
{
"product_id": 1,
"qty": 1,
"carton_qty": 1,
"carton_price": 1
}
]
}Created
{
"id": "text",
"type": "Internal",
"supplier_id": 1,
"order_number": "text",
"source": "text",
"status": "text",
"reference": "text",
"created_at": "text",
"modified_at": "text",
"invoice_due_at": "text",
"shipped_at": "text",
"completed_at": "text",
"pick_location_id": "text",
"pick_location_name": "text",
"delivery_date": "text",
"currency": "text",
"amount": 1,
"amount_notax": 1,
"amount_tax": 1,
"payment_method": "text",
"shipping_name": "text",
"shipping_fee": 1,
"shipping_fee_notax": 1,
"shipping_fee_tax": 1,
"credit_card_fee": 1,
"credit_card_fee_notax": 1,
"credit_card_fee_tax": 1,
"credit": 1,
"credit_notax": 1,
"credit_tax": 1,
"notes": "text",
"last_modified_at": "text",
"line_items": [
{
"id": 1,
"order_id": 1,
"product_id": 1,
"sku": "text",
"barcode": "text",
"gtin": "text",
"name": "text",
"qty": 1,
"carton_qty": 1,
"carton_price": 1,
"amount": 1,
"amount_notax": 1,
"amount_tax": 1
}
],
"customer": {
"id": "text",
"type": "Internal",
"name": "text",
"abn": "text",
"account_number": "text",
"website": "text",
"logo_url": "text",
"payment_terms": 1,
"payment_terms_period": "text",
"credit_hold": true,
"notes": "text",
"last_modified_at": "text",
"contacts": [
{
"first_name": "text",
"last_name": "text",
"email": "text",
"phone": "text",
"mobile_area": "text",
"mobile_number": "text",
"role": "text"
}
],
"locations": [
{
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
}
],
"groups": [
{
"id": 1,
"name": "text"
}
],
"billing_location": {
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
},
"shipping_location": {
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
}
}
}Fetch the latest Fulfilments from all Sales Orders
OK
GET /v1/sales-orders/fulfilments/latest HTTP/1.1
Accept: */*
OK
[
{
"id": "text",
"fulfilment_number": "text",
"created_at": "text",
"modified_at": "text",
"sales_order_id": "text",
"sales_order_number": "text",
"pick_location": {
"id": "text",
"name": "text"
},
"shipping_type": "text",
"shipping_rule_id": 1,
"shipping_name": "text",
"pick_start_at": "text",
"pick_end_at": "text",
"pack_start_at": "text",
"pack_end_at": "text",
"delivery_date": "text",
"shipped_at": "text",
"line_items": [
{
"id": 1,
"sales_order_line_id": 1,
"product_id": 1,
"sku": "text",
"barcode": "text",
"gtin": "text",
"name": "text",
"qty": 1,
"carton_qty": 1,
"qty_picked": 1,
"qty_packed": 1
}
],
"cartons": [
{
"id": 1,
"carton_number": "text",
"sscc": "text",
"width": 1,
"height": 1,
"depth": 1,
"weight": 1,
"contents": [
{
"sales_order_line_id": 1,
"fulfilment_line_id": 1,
"product_id": 1,
"sku": "text",
"barcode": "text",
"gtin": "text",
"name": "text",
"qty": 1
}
]
}
]
}
]Fetch the Fulfilments for the given Sales Order ID
OK
If you only want "confirmed" fulfilments then check whether shipped_at has been set.
GET /v1/sales-orders/get/fulfilments?id=text HTTP/1.1
Accept: */*
OK
[
{
"id": "text",
"fulfilment_number": "text",
"created_at": "text",
"modified_at": "text",
"sales_order_id": "text",
"sales_order_number": "text",
"pick_location": {
"id": "text",
"name": "text"
},
"shipping_type": "text",
"shipping_rule_id": 1,
"shipping_name": "text",
"pick_start_at": "text",
"pick_end_at": "text",
"pack_start_at": "text",
"pack_end_at": "text",
"delivery_date": "text",
"shipped_at": "text",
"line_items": [
{
"id": 1,
"sales_order_line_id": 1,
"product_id": 1,
"sku": "text",
"barcode": "text",
"gtin": "text",
"name": "text",
"qty": 1,
"carton_qty": 1,
"qty_picked": 1,
"qty_packed": 1
}
],
"cartons": [
{
"id": 1,
"carton_number": "text",
"sscc": "text",
"width": 1,
"height": 1,
"depth": 1,
"weight": 1,
"contents": [
{
"sales_order_line_id": 1,
"fulfilment_line_id": 1,
"product_id": 1,
"sku": "text",
"barcode": "text",
"gtin": "text",
"name": "text",
"qty": 1
}
]
}
]
}
]OK
Deprecated: Use 'paid_at' on invoices instead
Deprecated: Use 'paid_amount' on invoices instead
GET /v1/sales-orders/get?id=text HTTP/1.1
Accept: */*
OK
{
"id": "text",
"type": "Internal",
"supplier_id": 1,
"order_number": "text",
"source": "text",
"status": "text",
"reference": "text",
"created_at": "text",
"modified_at": "text",
"invoice_due_at": "text",
"shipped_at": "text",
"completed_at": "text",
"pick_location_id": "text",
"pick_location_name": "text",
"delivery_date": "text",
"currency": "text",
"amount": 1,
"amount_notax": 1,
"amount_tax": 1,
"payment_method": "text",
"shipping_name": "text",
"shipping_fee": 1,
"shipping_fee_notax": 1,
"shipping_fee_tax": 1,
"credit_card_fee": 1,
"credit_card_fee_notax": 1,
"credit_card_fee_tax": 1,
"credit": 1,
"credit_notax": 1,
"credit_tax": 1,
"notes": "text",
"last_modified_at": "text",
"line_items": [
{
"id": 1,
"order_id": 1,
"product_id": 1,
"sku": "text",
"barcode": "text",
"gtin": "text",
"name": "text",
"qty": 1,
"carton_qty": 1,
"carton_price": 1,
"amount": 1,
"amount_notax": 1,
"amount_tax": 1
}
],
"customer": {
"id": "text",
"type": "Internal",
"name": "text",
"abn": "text",
"account_number": "text",
"website": "text",
"logo_url": "text",
"payment_terms": 1,
"payment_terms_period": "text",
"credit_hold": true,
"notes": "text",
"last_modified_at": "text",
"contacts": [
{
"first_name": "text",
"last_name": "text",
"email": "text",
"phone": "text",
"mobile_area": "text",
"mobile_number": "text",
"role": "text"
}
],
"locations": [
{
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
}
],
"groups": [
{
"id": 1,
"name": "text"
}
],
"billing_location": {
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
},
"shipping_location": {
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
}
}
}Fetch the latest Invoices from all Sales Orders
OK
GET /v1/sales-orders/invoices/latest HTTP/1.1
Accept: */*
OK
[
{
"id": "text",
"invoice_number": "text",
"type": "Standard",
"reference": "text",
"created_at": "text",
"modified_at": "text",
"sales_order_id": "text",
"sales_order_number": "text",
"amount": 1,
"amount_notax": 1,
"amount_tax": 1,
"currency": "text",
"conversion_rate": 1,
"payment_method": "text",
"invoice_sent_at": "text",
"invoice_due_at": "text",
"cancelled_at": "text",
"paid_at": "text",
"paid_amount": 1,
"line_items": [
{
"id": 1,
"type": "LineItem",
"product_id": 1,
"brand": "text",
"name": "text",
"size_units": 1,
"size_measure": "text",
"sku": "text",
"barcode": "text",
"gtin": "text",
"carton_qty": 1,
"carton_price": 1,
"qty": 1,
"amount": 1,
"amount_notax": 1,
"amount_tax": 1
}
]
}
]Fetch the Invoices for the given Sales Order ID
OK
If you only want "sent" or "issued" invoices then check whether invoice_sent_at has been set.
GET /v1/sales-orders/get/invoices?id=text HTTP/1.1
Accept: */*
OK
[
{
"id": "text",
"invoice_number": "text",
"type": "Standard",
"reference": "text",
"created_at": "text",
"modified_at": "text",
"sales_order_id": "text",
"sales_order_number": "text",
"amount": 1,
"amount_notax": 1,
"amount_tax": 1,
"currency": "text",
"conversion_rate": 1,
"payment_method": "text",
"invoice_sent_at": "text",
"invoice_due_at": "text",
"cancelled_at": "text",
"paid_at": "text",
"paid_amount": 1,
"line_items": [
{
"id": 1,
"type": "LineItem",
"product_id": 1,
"brand": "text",
"name": "text",
"size_units": 1,
"size_measure": "text",
"sku": "text",
"barcode": "text",
"gtin": "text",
"carton_qty": 1,
"carton_price": 1,
"qty": 1,
"amount": 1,
"amount_notax": 1,
"amount_tax": 1
}
]
}
]OK
GET /v1/sales-orders/latest HTTP/1.1
Accept: */*
OK
[
{
"id": "text",
"type": "Internal",
"supplier_id": 1,
"order_number": "text",
"source": "text",
"status": "text",
"reference": "text",
"created_at": "text",
"modified_at": "text",
"invoice_due_at": "text",
"shipped_at": "text",
"completed_at": "text",
"pick_location_id": "text",
"pick_location_name": "text",
"delivery_date": "text",
"currency": "text",
"amount": 1,
"amount_notax": 1,
"amount_tax": 1,
"payment_method": "text",
"shipping_name": "text",
"shipping_fee": 1,
"shipping_fee_notax": 1,
"shipping_fee_tax": 1,
"credit_card_fee": 1,
"credit_card_fee_notax": 1,
"credit_card_fee_tax": 1,
"credit": 1,
"credit_notax": 1,
"credit_tax": 1,
"notes": "text",
"last_modified_at": "text",
"line_items": [
{
"id": 1,
"order_id": 1,
"product_id": 1,
"sku": "text",
"barcode": "text",
"gtin": "text",
"name": "text",
"qty": 1,
"carton_qty": 1,
"carton_price": 1,
"amount": 1,
"amount_notax": 1,
"amount_tax": 1
}
],
"customer": {
"id": "text",
"type": "Internal",
"name": "text",
"abn": "text",
"account_number": "text",
"website": "text",
"logo_url": "text",
"payment_terms": 1,
"payment_terms_period": "text",
"credit_hold": true,
"notes": "text",
"last_modified_at": "text",
"contacts": [
{
"first_name": "text",
"last_name": "text",
"email": "text",
"phone": "text",
"mobile_area": "text",
"mobile_number": "text",
"role": "text"
}
],
"locations": [
{
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
}
],
"groups": [
{
"id": 1,
"name": "text"
}
],
"billing_location": {
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
},
"shipping_location": {
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
}
}
}
]nullIn your local timezone.
nullnullnullnullIn your local timezone. If this is not provided, then a date will be calculated based on your customer's payment terms.
nullThis must be one of the methods available to your customer, eg Credit Card, Invoice, etc.
nullnullWhether to put this Sales Order into draft status, or to proceed with placing the order.
nullPossible values: Accepted
Deprecated: Use 'paid_at' on invoices instead
Deprecated: Use 'paid_amount' on invoices instead
PUT /v1/sales-orders/modify?id=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"shipping_location": "text",
"delivery_date": "2026-01-01",
"shipping_name": "text",
"shipping_fee": 1,
"shipping_fee_tax": 1,
"invoice_due_at": "2026-01-01",
"payment_method": "text",
"notes": "text",
"status": "DRAFT",
"line_items": [
{
"id": 1,
"qty": 1,
"carton_qty": 1,
"carton_price": 1
}
]
}Accepted
{
"id": "text",
"type": "Internal",
"supplier_id": 1,
"order_number": "text",
"source": "text",
"status": "text",
"reference": "text",
"created_at": "text",
"modified_at": "text",
"invoice_due_at": "text",
"shipped_at": "text",
"completed_at": "text",
"pick_location_id": "text",
"pick_location_name": "text",
"delivery_date": "text",
"currency": "text",
"amount": 1,
"amount_notax": 1,
"amount_tax": 1,
"payment_method": "text",
"shipping_name": "text",
"shipping_fee": 1,
"shipping_fee_notax": 1,
"shipping_fee_tax": 1,
"credit_card_fee": 1,
"credit_card_fee_notax": 1,
"credit_card_fee_tax": 1,
"credit": 1,
"credit_notax": 1,
"credit_tax": 1,
"notes": "text",
"last_modified_at": "text",
"line_items": [
{
"id": 1,
"order_id": 1,
"product_id": 1,
"sku": "text",
"barcode": "text",
"gtin": "text",
"name": "text",
"qty": 1,
"carton_qty": 1,
"carton_price": 1,
"amount": 1,
"amount_notax": 1,
"amount_tax": 1
}
],
"customer": {
"id": "text",
"type": "Internal",
"name": "text",
"abn": "text",
"account_number": "text",
"website": "text",
"logo_url": "text",
"payment_terms": 1,
"payment_terms_period": "text",
"credit_hold": true,
"notes": "text",
"last_modified_at": "text",
"contacts": [
{
"first_name": "text",
"last_name": "text",
"email": "text",
"phone": "text",
"mobile_area": "text",
"mobile_number": "text",
"role": "text"
}
],
"locations": [
{
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
}
],
"groups": [
{
"id": 1,
"name": "text"
}
],
"billing_location": {
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
},
"shipping_location": {
"id": "text",
"name": "text",
"is_billing": true,
"is_shipping": true,
"manage_stock": true,
"address": "text",
"suburb": "text",
"state": "text",
"postcode": "text",
"country": "text",
"location": {},
"opening_hours": {}
}
}
}Accepted
No content
DELETE /v1/sales-orders/modify?id=text HTTP/1.1
Accept: */*
Accepted
No content
Last updated