Get order details list
https://core-api.ancon.io/api/v1/Outlets/{outletId}/Orders/DetailedListFetching only new and changed orders
Poll with filter[modified]=gte:<timestamp> (UTC, ISO 8601), where the timestamp is the time you started the previous poll minus a minute of overlap. This returns only the orders created or changed since then instead of re-reading the whole day. Because of the overlap an order can be returned more than once, so match orders on id.
modified is the time the order itself was last saved. It changes when the order is created, refunded (the refund is a new order with parentOrderId, and the original order is updated too), and when its status, pre-order status or invoice handling status changes. A refund payment result that arrives after the refund (for example from a card terminal) may not change modified. The nightly accounting run that publishes the day's voucher basis also updates every order of that day, so each order is returned once more after the day is closed. Kitchen ticket progress is not part of the order and does not change modified.
Filtering
Filter the list with filter[field]=operator:value; see how filtering works.
Show all 65 filter fields
- created (datetime)
- modified (datetime)
- order.id (guid)
- orderformat (enum flags)
- customer.id (nullable guid)
- customer.name (string)
- customer.email (string)
- customer.phone (string)
- company.id (guid)
- company.name (string)
- company.email" (string)
- status (enum)
- refundedat (datetime)
- totalamount (decimal)
- totalcurreny (string)
- totalamountplustip (decimal)
- taxamount (decimal)
- subtotalincltaxamount (decimal)
- subtotalexcltaxamount (decimal)
- subtotaldiscountincltaxamount (decimal)
- subtotaldiscountexcltaxamount (decimal)
- feeamountincltaxamount (decimal)
- feeamountexcltaxamount (decimal)
- discount.id (nullable guid)
- discount.name (string)
- discount.type (enum)
- discount.value (decimal)
- fromtype (enum)
- saleslocation.id (guid)
- saleslocation.type (enum)
- source (string)
- createdchecktenantuserid (nullable guid)
- closedchecktenantuserid (nullable guid)
- createdcheckclientid (nullable guid)
- closedcheckclientid (nullable guid)
- ticktedat (nullable datetime)
- ticketdoneat (nullable datetime)
- capturedat (nullable datetime)
- preparationtime (nullable timespan)
- checkoutservicetime.kind (enum)
- checkoutservicetime.time (datetime)
- customname (string)
- payment.ourreference (guid)
- payment.externalreference (string)
- payment.externalidentifier (string)
- payment.name (string)
- payment.type (enum)
- payment.terminalid (nullable guid)
- payment.clientid (nullable guid)
- payment.tenantuserid (nullable guid)
- payment.invoicereferencenote (string)
- payment.amount (decimal)
- payment.currency (string)
- payment.tipamount (decimal)
- payment.tipcurrency (string)
- payment.cashback (decimal)
- payment.cashbackcurrency (string)
- payment.rounding (decimal)
- payment.roundingcurrency (string)
- payment.status (enum)
- ordernumber (long)
- referencenumber (long)
- ticketnumber (long)
- serialnumber (long)
- refundserialnumber (long)
Authorization
Access-TokenheaderrequiredTenant- or outlet-level token from the backoffice. See Get started.
Path parameters
outletIdstring (uuid)required
Query parameters
Offsetinteger (int32)Offset the result, defaults to 0
Limitinteger (int32)Limits how many items to get, defaults to 100 min 0, max 1000.
OrderstringOrder the result.
SearchstringFiltermap<string, array<string>>Filter the result. Filter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00
Filter takes filter[field]=operator:value on 65 fields. Build a filter
Header parameters
correlationIdstringCorrelation Id for the request
Responses
200OK
itemsarray<object> | null43 fields in
itemsidstring (uuid)createdstring (date-time)orderFormatsinteger (int32)Allowed values:
0,1,2,4,8,16,32,64,128,159,191.statusinteger (int32)Allowed values:
0,1,2,3.refundedAtstring (date-time) | nullcustomerobject | null5 fields in
customeremailstring | nullcustomerIdstring (uuid) | nullnamestring | nullphonestring | nulladdressobject | null6 fields in
addressstreetstring | nullzipCodestring | nullcitystring | nullstatestring | nullcountrystring | nulllocationobject | null2 fields in
locationlatitudenumber (double)longitudenumber (double)
deliveryobject | null3 fields in
deliveryaddressobject | null6 fields in
addressstreetstring | nullzipCodestring | nullcitystring | nullstatestring | nullcountrystring | nulllocationobject | null2 fields in
locationlatitudenumber (double)longitudenumber (double)
phonestring | nullrecipientstring | null
totalAmountobject | nullOrder total (include tax) This amount includes modifications. This amount includes fees. This amount is calculated from SubtotalInclTax + FeeAmountInclTax This amount is what must be paid or refunded to complete the order.
2 fields in
totalAmountamountnumber (double)currencystring | null
taxAmountobject | nullOrder total tax.
2 fields in
taxAmountamountnumber (double)currencystring | null
subtotalInclTaxobject | nullOrder sub total (include tax). This amount is calculated from OrderItem.TotalPriceInclTax
2 fields in
subtotalInclTaxamountnumber (double)currencystring | null
subtotalExclTaxobject | nullOrder sub total (exclude tax). This amount is calculated from OrderItem.TotalPriceExclTax
2 fields in
subtotalExclTaxamountnumber (double)currencystring | null
subTotalDiscountInclTaxobject | nullGets the order subtotal discount (include tax) This amount is calculated from OrderItem.DiscountAmountInclTax
2 fields in
subTotalDiscountInclTaxamountnumber (double)currencystring | null
subTotalDiscountExclTaxobject | nullGets the order subtotal discount (exclude tax) This amount is calculated from OrderItem.DiscountAmountExclTax
2 fields in
subTotalDiscountExclTaxamountnumber (double)currencystring | null
feeAmountInclTaxobject | nullGets the total fee amount (include tax) This amount is calculated from OrderFee.AmountInclTax
2 fields in
feeAmountInclTaxamountnumber (double)currencystring | null
feeAmountExclTaxobject | nullGets the total fee amount (exclude tax) This amount is calculated from OrderFee.AmountExclTax
2 fields in
feeAmountExclTaxamountnumber (double)currencystring | null
discountobject | null2 fields in
discountidstring (uuid) | nullnamestring | null
discountValueobject | nullThe applied discount value.
2 fields in
discountValuevaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
salesLocationobject | nullInformation about where this order was sold (table, bar etc.).
2 fields in
salesLocationsalesLocationIdstring (uuid) | nulltypeinteger (int32)Allowed values:
0,1,2,3.
sourcestring | nullsaleSourceIdstring (uuid)outletobject | null2 fields in
outletidstring (uuid)namestring | null
paymentsarray<object> | null21 fields in
paymentsidstring (uuid)createdstring (date-time)orderIdstring (uuid)amountobject | null2 fields in
amountamountnumber (double)currencystring | null
cashBackAmountobject | null2 fields in
cashBackAmountamountnumber (double)currencystring | null
roundingAmountobject | null2 fields in
roundingAmountamountnumber (double)currencystring | null
tipAmountobject | null2 fields in
tipAmountamountnumber (double)currencystring | null
paymentMethodobject | null3 fields in
paymentMethodidstring | nulltypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23.displayNamestring | null
ourReferencestring (uuid)externalReferencestring | nullexternalIdentifierstring | nullclientIdstring (uuid) | nulltenantUserIdstring (uuid) | nullexternalTimeStampstring (date-time) | nullintegrationTypeinteger (int32)Allowed values:
1,2.statusinteger (int32)Allowed values:
0,1,2,3,4.centralControlUnitSerialstring | nullinvoiceReferenceNotestring | nullinvoiceHandlingStatusinteger (int32) | nullAllowed values:
1,2,4,8.refundsarray<object> | null7 fields in
refundsidstring (uuid)refundedAtstring (date-time) | nullrefundAmountobject | null2 fields in
refundAmountamountnumber (double)currencystring | null
roundingAmountobject | null2 fields in
roundingAmountamountnumber (double)currencystring | null
paymentIdstring (uuid)statusinteger (int32)Allowed values:
0,1,2,3,4.refundReferencestring (uuid)
mewsInfoany | null
itemsarray<object> | null21 fields in
itemsidstring (uuid)productobject | null9 fields in
productproductIdstring (uuid)productNamestring | nullproductTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10.variantIdstring (uuid)variantNamestring | nullhasVariantsbooleanproductGroupIdstring (uuid)productGroupNamestring | nulluseBasePriceboolean
quantitynumber (double)unitQuantitynumber (double)unitobject | null2 fields in
unitnamestring | nulltypeinteger (int32)Allowed values:
0,1,2,3.
productPriceInclTaxobject | null2 fields in
productPriceInclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencystring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencystring | null
productPriceExclTaxobject | null2 fields in
productPriceExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencystring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencystring | null
productMaterialCostExclTaxobject | null2 fields in
productMaterialCostExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencystring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencystring | null
totalPriceInclTaxobject | null2 fields in
totalPriceInclTaxamountnumber (double)currencystring | null
totalPriceExclTaxobject | null2 fields in
totalPriceExclTaxamountnumber (double)currencystring | null
totalMaterialCostExclTaxobject | null2 fields in
totalMaterialCostExclTaxamountnumber (double)currencystring | null
discountAmountInclTaxobject | null2 fields in
discountAmountInclTaxamountnumber (double)currencystring | null
discountAmountExclTaxobject | null2 fields in
discountAmountExclTaxamountnumber (double)currencystring | null
taxesarray<object> | null2 fields in
taxestypeinteger (int32)Allowed values:
1,2.ratenumber (double)
modificationsarray<object> | null12 fields in
modificationsmodificationstring | nullingredientIdstring (uuid) | nullnamestring | nullreplaceIdstring (uuid) | nullreplacementNamestring | nulladdOnGroupIdstring (uuid) | nulladdOnGroupNamestring | nullquantitynumber (double)freeAmountnumber (double)costnumber (double)totalCostnumber (double)positioninteger (int32)
addOnProductsarray<object> | null19 fields in
addOnProductsidstring (uuid)productobject | null9 fields in
productproductIdstring (uuid)productNamestring | nullproductTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10.variantIdstring (uuid)variantNamestring | nullhasVariantsbooleanproductGroupIdstring (uuid)productGroupNamestring | nulluseBasePriceboolean
quantitynumber (double)unitQuantitynumber (double)unitobject | null2 fields in
unitnamestring | nulltypeinteger (int32)Allowed values:
0,1,2,3.
productPriceInclTaxobject | null2 fields in
productPriceInclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencystring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencystring | null
productPriceExclTaxobject | null2 fields in
productPriceExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencystring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencystring | null
productMaterialCostExclTaxobject | null2 fields in
productMaterialCostExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencystring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencystring | null
totalPriceInclTaxobject | null2 fields in
totalPriceInclTaxamountnumber (double)currencystring | null
totalPriceExclTaxobject | null2 fields in
totalPriceExclTaxamountnumber (double)currencystring | null
totalMaterialCostExclTaxobject | null2 fields in
totalMaterialCostExclTaxamountnumber (double)currencystring | null
discountAmountInclTaxobject | null2 fields in
discountAmountInclTaxamountnumber (double)currencystring | null
discountAmountExclTaxobject | null2 fields in
discountAmountExclTaxamountnumber (double)currencystring | null
taxesarray<object> | null2 fields in
taxestypeinteger (int32)Allowed values:
1,2.ratenumber (double)
discountobject | null2 fields in
discountvaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
statusinteger (int32) | nullAllowed values:
0,1,2,3.addOnGroupIdstring (uuid)addOnGroupNamestring | nulladdOnFreeAmountnumber (double)
discountobject | null2 fields in
discountvaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
statusinteger (int32) | nullAllowed values:
0,1,2,3.soldAtstring (date-time)refundsarray<object> | null5 fields in
refundsidstring (uuid)quantitynumber (double)statusinteger (int32)Allowed values:
0,1,2,3.refundReferencestring (uuid)orderItemIdstring (uuid)
itemsarray<object> | null
feesarray<object> | null5 fields in
feesfeeIdstring (uuid)feeNamestring | nullamountInclTaxobject | null2 fields in
amountInclTaxamountnumber (double)currencystring | null
amountExclTaxobject | null2 fields in
amountExclTaxamountnumber (double)currencystring | null
taxesarray<object> | null2 fields in
taxestypeinteger (int32)Allowed values:
1,2.ratenumber (double)
voucherBasisIdstring (uuid) | nullincrementalNumbersobject | null4 fields in
incrementalNumbersticketNumberinteger (int64) | nullUnique number per outlet per Z-Report, it will reset when a Z-Report is made and start on 1 again. Used alot in the UI to give a simple to read number, will also be printed on tickets.
serialNumberinteger (int64) | nullUnbroken sequence per outlet which statisfies the needs of certain pos system laws, is only used on Checks.
referenceNumberinteger (int64) | nullUnbroken sequence per outlet which is used for all types of sales. Suitable for correlation between systems.
refundSerialNumberinteger (int64) | nullUses same series as SerialNumber and is set on orders which is refunded.
fromTypeinteger (int32)Allowed values:
0,1.fromTypeCreatedstring (date-time)createdCheckTenantUserIdstring (uuid) | nullThe tenant user id of who created the check this order was created from.
closedCheckTenantUserIdstring (uuid) | nullTenant user id of who closed the check this order was created from.
createdCheckClientIdstring (uuid) | nullclosedCheckClientIdstring (uuid) | nullticketedAtstring (date-time) | nullThe time this order was ticketed.
soldAtstring (date-time)The time when this order was sold. When something is sold is different if the order comes from check or checkout. Check: The last time an item was ticketed or if no tickets then it will be when the order was created. Checkout: The time the order was created.
checkoutAuthorizedAtstring (date-time) | nullcheckoutServiceTimeobject | nullService time for the sale. No time is needed for Kind.AsSoonAsPossible it will be set as current UTC time on server side.
2 fields in
checkoutServiceTimekindinteger (int32)Allowed values:
0,1,-1.timestring (date-time) | null
ticketClosedAtstring (date-time) | nullcompanyInfoobject | null7 fields in
companyInfocompanyIdstring (uuid) | nullcompanyNamestring | nullcompanyBusinessNumberstring | nulladdressobject | null4 fields in
addressstreetstring | nullstreet2string | nullzipCodestring | nullcitystring | null
invoiceEmailstring | nullmemberIdstring (uuid) | nullmemberNamestring | null
metaDataarray<object> | null2 fields in
metaDatametaDataany | nullRename for next version to Metadata
metaDataTypestring | null
guestGroupIdstring (uuid) | nullorderTypeinteger (int32)Allowed values:
0,1,2,3,4,5.parentOrderIdstring (uuid) | nullcustomNamestring | null
metaobject | null2 fields in
metacountinteger (int32)offsetinteger (int32)
401Unauthorized
messagestring | null
404Not Found
messagestring | nullerrorCodestring (uuid)
429Too Many Requests
typestring | nulltitlestring | nullstatusinteger (int32) | nulldetailstring | nullinstancestring | null