List orders
Retrieves a list of all orders for a company
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
List orders › Responses
Orders list retrieved successfully
createdAtupdatedAtorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdorderIdcompanyIdUpdate orders
Updates one or more existing orders for a company
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
Update orders › Request Body
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdorderIdcompanyIdUpdate orders › Responses
Orders updated successfully
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdorderIdcompanyIdCreate orders
Creates one or more new orders for a company
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
Create orders › Request Body
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdorderIdcompanyIdCreate orders › Responses
Orders created successfully
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdorderIdcompanyIdGet an order by ID
Retrieves a single order by its unique ID within the specified company including status and core line metadata.
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
orderIdThe unique identifier of the order. Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
Get an order by ID › Responses
Order retrieved successfully
createdAtupdatedAtorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdorderIdcompanyIdUpload orders from CSV
Get audit trail for an order
Retrieves the complete audit trail of all changes made to a specific order and its line items, ordered by edit timestamp descending.
path Parameters
companyIdThe unique identifier of the company
orderIdThe unique identifier of the order
Get audit trail for an order › Responses
Audit trail retrieved successfully
ordersEditHistoryIdorderIdorderLineItemIdeditoreditorNamefieldChangedoldValuenewValueeditedAtGet order details with line items
Retrieves a single order with all its line items by order ID within the specified company.
path Parameters
companyIdThe unique identifier of the company.
orderIdThe unique identifier of the order.
Get order details with line items › Responses
Order details with line items retrieved successfully
orderIdcompanyIdorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcreatedAtupdatedAtList deleted orders
Retrieves a list of all soft-deleted orders for a company (Active = 0)
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
List deleted orders › Responses
Deleted orders list retrieved successfully
createdAtupdatedAtorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdorderIdcompanyIdRestore deleted orders
Upload orders and/or line items
Uploads and processes up to two CSV files (orders and/or order line items). The endpoint identifies which file is which by inspecting the CSV header columns (not by the uploaded form field name). At least one file is required. Line items can link to orders via OrderId or OrderReference.
path Parameters
companyIdThe unique identifier of the company
Upload orders and/or line items › Responses
CSVs uploaded and processed successfully

