Orders
Orders received from your e-shops and ERP systems, or created manually in Chameleoon. Reading requires the orders read permission; changing orders requires read and write.
Each order ships in one or more fulfillments, and each fulfillment becomes one shipment. GET /v2/orders/{id} returns the order with its fulfillments; follow shipmentId to GET /v2/shipments/{id}.
List orders
Returns a paginated list of orders, newest first by documentCreatedAt.
Without a date range, orders from the last 60 days are returned. A date range can span up to one year. When referenceNumbers is set, the date range is ignored.
query Parameters
pagePage number for pagination
pageSizeNumber of items per page
createdFromOrders placed from this date and time, inclusive (format yyyy-MM-ddTHH:mm:ss.fff). Defaults to the last 60 days. Ignored when referenceNumbers is set.
createdToOrders placed up to this date and time, inclusive (format yyyy-MM-ddTHH:mm:ss.fff). The range can span up to one year.
referenceNumbersOrder numbers, up to 20. Repeat the parameter for multiple values. The date range is ignored.
parentInternalStatusStandard order statuses. Repeat the parameter for multiple values.
Headers
Accept-LanguageLanguage code for localized responses
List orders › Responses
Paginated list of orders
pageCurrent page number
pageSizeNumber of items per page
totalPagesTotal number of pages
nextPageWhether a next page exists
previousPageWhether a previous page exists
itemsCountTotal number of items across all pages
Orders, newest first
Get order by ID
Returns an order with its customer, prices, lines and fulfillments.
path Parameters
idUnique order identifier
Headers
Accept-LanguageLanguage code for localized responses
Get order by ID › Responses
The order
idUnique order identifier
referenceNumberOrder number shown to the customer
channelHow the order was received
referenceSourceSource system type, such as shoptet or api
sourceIdentifierSource profile, as returned by GET /v2/sources
parentInternalStatusStandard status that internalStatus belongs to
Order status in Chameleoon; can be one of your custom statuses
fulfillmentProgressWarehouse progress across all fulfillments of the order.
pending— not started yetpicking— being pickedpartial_picked— some fulfillments are pickedpicked— all fulfillments are pickedpacking— being packedpartial_packed— some fulfillments are packedpacked— all fulfillments are packedcompleted— all fulfillments are completedcancelled— all fulfillments are cancelledunknown— not available
internalPaymentStatusPayment status of the order.
unknown— not specifiedwaiting_for_payment— awaiting paymentpaid— paidpayment_failed— payment failed
internalPaymentTypePayment type of the order.
unknown— not specifiedcod— cash on deliverybank_transfer— bank transfercard— card
Billing address of the customer
Delivery address
Payment method chosen by the customer
Shipping method chosen by the customer
Order totals
Order lines
shippingNumbersTracking numbers of the order's shipments
createdAtWhen the order was imported into Chameleoon (format yyyy-MM-ddTHH:mm:ss.fff)
changedAtWhen the order was last updated (format yyyy-MM-ddTHH:mm:ss.fff)
Fulfillments of the order, including cancelled ones. Event history is not included; use GET /v2/fulfillments/{id}.
externalDocumentIdOrder ID in the source system, such as your e-shop
Order status in the source system
noteCustomer note
internalNoteInternal note added in Chameleoon
Invoices and shipments linked to the order
expectedShippingDateExpected shipping date (format yyyy-MM-ddTHH:mm:ss.fff)
documentCreatedAtWhen the order was placed in the source system; null if the source system did not send it (format yyyy-MM-ddTHH:mm:ss.fff). Used for sorting and date filters.