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
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List orders › Responses
Orders list retrieved successfully
createdAtupdatedAtorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdUpdate orders with nested line items
Updates one or more existing orders for a company. Each order includes nested line items array. Frontend sends complete structure with GUIDs. Line items not in the request will be soft-deleted.
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Update orders with nested line items › Request Body
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdUpdate orders with nested line items › Responses
Orders updated successfully with enriched customer names
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdCreate orders with optional line items
Creates one or more new orders for a company. Each order can include an optional array of line items that will be created atomically with the order.
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Create orders with optional line items › Request Body
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdCreate orders with optional line items › Responses
Orders and line items created successfully with enriched customer names
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdDelete orders
Soft deletes one or more orders and their line items by setting Active = 0. Temporal tables preserve the previous row state automatically.
path Parameters
companyIdThe unique identifier of the company
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Delete orders › Responses
Orders deleted successfully
deletedCountNumber of items deleted
deletedIdsList of IDs that were deleted
Download orders as CSV
Downloads all orders for a company as a CSV file
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Download orders as CSV › Responses
CSV file with order data
Download orders + line items (ZIP)
Downloads a ZIP file containing two CSV files: orders.csv and order-line-items.csv
path Parameters
companyIdThe unique identifier of the company
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Download orders + line items (ZIP) › Responses
ZIP file containing orders.csv and order-line-items.csv
Generate or retrieve order certificate pack PDF
Generates a certificate pack PDF for an order. Returns cached pack if data is unchanged since last generation.
path Parameters
companyIdorderIdHeaders
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Generate or retrieve order certificate pack PDF › Responses
Certificate pack PDF
Get an order by ID with nested line items
Retrieves a single order by its unique ID within the specified company, including all associated line items.
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
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get an order by ID with nested line items › Responses
Order retrieved successfully with nested line items
createdAtupdatedAtorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdGet 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.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get order details with line items › Responses
Order details with line items retrieved successfully
orderIdcompanyIdorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNamecreatedAtupdatedAtGet order change history
Returns field-level audit history for a specific order and its line items, derived from SQL Server temporal tables. Events from order header and line items are interleaved in a single chronological timeline.
path Parameters
companyIdThe unique identifier of the company
orderIdThe unique identifier of the order
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get order change history › Responses
Interleaved audit events for the order and its line items
changedAtchangedByIdchangedByNamechangeTypeentityTypeentityLabelList 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
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List deleted orders › Responses
Deleted orders list retrieved successfully
createdAtupdatedAtorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdReserve inventory for an order line item
Atomically reserves inventory stock against an order line item. When split=true, creates a new inventory row with the reserved quantity and appends the order reference to its name.
path Parameters
companyIdThe unique identifier of the company.
orderIdThe unique identifier of the order.
lineItemIdThe unique identifier of the order line item.
query Parameters
inventoryIdThe inventory item to reserve.
reserveQuantityThe quantity to reserve.
splitWhen 1, splits the inventory item creating a new row with the reserved quantity. When 0, reserves the whole item (reserveQuantity must equal the full quantity). The underlying SQL parameter is a BIT — callers must pass 1 or 0.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Reserve inventory for an order line item › Responses
Reservation successful
linkedInventoryIdoriginalInventoryIdwasSplitorderLineItemIdRestore deleted orders
Restores one or more soft-deleted orders and their line items by setting Active = 1.
path Parameters
companyIdThe unique identifier of the company owning the entries
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Restore deleted orders › Responses
Orders restored successfully
deletedCountNumber of items deleted
deletedIdsList of IDs that were deleted
Unreserve inventory from an order line item
Removes the traceability link between an order line item and an inventory item. Does not undo any inventory split.
path Parameters
companyIdThe unique identifier of the company.
orderIdThe unique identifier of the order.
lineItemIdThe unique identifier of the order line item.
inventoryIdThe inventory item to unreserve.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Unreserve inventory from an order line item › Responses
Unreservation successful, returns details of the removed reservation link
linkIdcompanyIdorderLineItemIdinventoryIdUpload 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
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Upload orders and/or line items › Responses
CSVs uploaded and processed successfully
Get CSV upload templates (ZIP)
Downloads a ZIP file containing CSV templates for both orders and order line items. Upload orders first, then use the same OrderReference values to link line items.
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get CSV upload templates (ZIP) › Responses
ZIP file containing orders-template.csv and order-line-items-template.csv