Core APIOrders

Get order details list

gethttps://core-api.ancon.io/api/v1/Outlets/{outletId}/Orders/DetailedList
View .mdOpenAPI

Fetching 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)

Try filters

Build a filter for this endpoint and copy the request. It also runs against sample data so you can see what matches. How filtering works

Filters

Documented filter fields

Reads asmodified is on or after “2026-10-21T00:00:00Z”

Request
?filter[modified]=gte:2026-10-21T00:00:00Z

Sample orders · 5 of 7 match

ordernumbercustomer.nameorderformatstatustotalamountcreatedmodifiedrefundedat
1041Alex Berg82312.52026-10-19 11:022026-10-19 11:40null
1042null12892026-10-19 12:152026-10-19 12:16null
1043Sam Lind925402026-10-20 17:482026-10-21 08:05null
1044Kim Ahl1232752026-10-20 18:302026-10-22 09:122026-10-22 09:12
1045null221642026-10-21 12:012026-10-21 12:01null
1046Alex Berg1617202026-10-22 19:202026-10-22 19:58null
1047Robin Ek804982026-10-23 10:052026-10-23 10:05null

Made-up rows, not from a real tenant. Filters are applied left to right.

Authorization

  • Access-Tokenheaderrequired

    Tenant- 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.

  • Orderstring

    Order the result.

  • Searchstring
  • Filtermap<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

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • itemsarray<object> | null
    43 fields in items
    • idstring (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) | null
    • customerobject | null
      5 fields in customer
      • emailstring | null
      • customerIdstring (uuid) | null
      • namestring | null
      • phonestring | null
      • addressobject | null
        6 fields in address
        • streetstring | null
        • zipCodestring | null
        • citystring | null
        • statestring | null
        • countrystring | null
        • locationobject | null
          2 fields in location
          • latitudenumber (double)
          • longitudenumber (double)
    • deliveryobject | null
      3 fields in delivery
      • addressobject | null
        6 fields in address
        • streetstring | null
        • zipCodestring | null
        • citystring | null
        • statestring | null
        • countrystring | null
        • locationobject | null
          2 fields in location
          • latitudenumber (double)
          • longitudenumber (double)
      • phonestring | null
      • recipientstring | null
    • totalAmountobject | null

      Order 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 totalAmount
      • amountnumber (double)
      • currencystring | null
    • taxAmountobject | null

      Order total tax.

      2 fields in taxAmount
      • amountnumber (double)
      • currencystring | null
    • subtotalInclTaxobject | null

      Order sub total (include tax). This amount is calculated from OrderItem.TotalPriceInclTax

      2 fields in subtotalInclTax
      • amountnumber (double)
      • currencystring | null
    • subtotalExclTaxobject | null

      Order sub total (exclude tax). This amount is calculated from OrderItem.TotalPriceExclTax

      2 fields in subtotalExclTax
      • amountnumber (double)
      • currencystring | null
    • subTotalDiscountInclTaxobject | null

      Gets the order subtotal discount (include tax) This amount is calculated from OrderItem.DiscountAmountInclTax

      2 fields in subTotalDiscountInclTax
      • amountnumber (double)
      • currencystring | null
    • subTotalDiscountExclTaxobject | null

      Gets the order subtotal discount (exclude tax) This amount is calculated from OrderItem.DiscountAmountExclTax

      2 fields in subTotalDiscountExclTax
      • amountnumber (double)
      • currencystring | null
    • feeAmountInclTaxobject | null

      Gets the total fee amount (include tax) This amount is calculated from OrderFee.AmountInclTax

      2 fields in feeAmountInclTax
      • amountnumber (double)
      • currencystring | null
    • feeAmountExclTaxobject | null

      Gets the total fee amount (exclude tax) This amount is calculated from OrderFee.AmountExclTax

      2 fields in feeAmountExclTax
      • amountnumber (double)
      • currencystring | null
    • discountobject | null
      2 fields in discount
      • idstring (uuid) | null
      • namestring | null
    • discountValueobject | null

      The applied discount value.

      2 fields in discountValue
      • valuenumber (double) | null
      • typeinteger (int32) | null

        Allowed values: 0, 1.

    • salesLocationobject | null

      Information about where this order was sold (table, bar etc.).

      2 fields in salesLocation
      • salesLocationIdstring (uuid) | null
      • typeinteger (int32)

        Allowed values: 0, 1, 2, 3.

    • sourcestring | null
    • saleSourceIdstring (uuid)
    • outletobject | null
      2 fields in outlet
      • idstring (uuid)
      • namestring | null
    • paymentsarray<object> | null
      21 fields in payments
      • idstring (uuid)
      • createdstring (date-time)
      • orderIdstring (uuid)
      • amountobject | null
        2 fields in amount
        • amountnumber (double)
        • currencystring | null
      • cashBackAmountobject | null
        2 fields in cashBackAmount
        • amountnumber (double)
        • currencystring | null
      • roundingAmountobject | null
        2 fields in roundingAmount
        • amountnumber (double)
        • currencystring | null
      • tipAmountobject | null
        2 fields in tipAmount
        • amountnumber (double)
        • currencystring | null
      • paymentMethodobject | null
        3 fields in paymentMethod
        • idstring | null
        • typeinteger (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 | null
      • externalIdentifierstring | null
      • clientIdstring (uuid) | null
      • tenantUserIdstring (uuid) | null
      • externalTimeStampstring (date-time) | null
      • integrationTypeinteger (int32)

        Allowed values: 1, 2.

      • statusinteger (int32)

        Allowed values: 0, 1, 2, 3, 4.

      • centralControlUnitSerialstring | null
      • invoiceReferenceNotestring | null
      • invoiceHandlingStatusinteger (int32) | null

        Allowed values: 1, 2, 4, 8.

      • refundsarray<object> | null
        7 fields in refunds
        • idstring (uuid)
        • refundedAtstring (date-time) | null
        • refundAmountobject | null
          2 fields in refundAmount
          • amountnumber (double)
          • currencystring | null
        • roundingAmountobject | null
          2 fields in roundingAmount
          • amountnumber (double)
          • currencystring | null
        • paymentIdstring (uuid)
        • statusinteger (int32)

          Allowed values: 0, 1, 2, 3, 4.

        • refundReferencestring (uuid)
      • mewsInfoany | null
    • itemsarray<object> | null
      21 fields in items
      • idstring (uuid)
      • productobject | null
        9 fields in product
        • productIdstring (uuid)
        • productNamestring | null
        • productTypeinteger (int32)

          Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.

        • variantIdstring (uuid)
        • variantNamestring | null
        • hasVariantsboolean
        • productGroupIdstring (uuid)
        • productGroupNamestring | null
        • useBasePriceboolean
      • quantitynumber (double)
      • unitQuantitynumber (double)
      • unitobject | null
        2 fields in unit
        • namestring | null
        • typeinteger (int32)

          Allowed values: 0, 1, 2, 3.

      • productPriceInclTaxobject | null
        2 fields in productPriceInclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencystring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencystring | null
      • productPriceExclTaxobject | null
        2 fields in productPriceExclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencystring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencystring | null
      • productMaterialCostExclTaxobject | null
        2 fields in productMaterialCostExclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencystring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencystring | null
      • totalPriceInclTaxobject | null
        2 fields in totalPriceInclTax
        • amountnumber (double)
        • currencystring | null
      • totalPriceExclTaxobject | null
        2 fields in totalPriceExclTax
        • amountnumber (double)
        • currencystring | null
      • totalMaterialCostExclTaxobject | null
        2 fields in totalMaterialCostExclTax
        • amountnumber (double)
        • currencystring | null
      • discountAmountInclTaxobject | null
        2 fields in discountAmountInclTax
        • amountnumber (double)
        • currencystring | null
      • discountAmountExclTaxobject | null
        2 fields in discountAmountExclTax
        • amountnumber (double)
        • currencystring | null
      • taxesarray<object> | null
        2 fields in taxes
        • typeinteger (int32)

          Allowed values: 1, 2.

        • ratenumber (double)
      • modificationsarray<object> | null
        12 fields in modifications
        • modificationstring | null
        • ingredientIdstring (uuid) | null
        • namestring | null
        • replaceIdstring (uuid) | null
        • replacementNamestring | null
        • addOnGroupIdstring (uuid) | null
        • addOnGroupNamestring | null
        • quantitynumber (double)
        • freeAmountnumber (double)
        • costnumber (double)
        • totalCostnumber (double)
        • positioninteger (int32)
      • addOnProductsarray<object> | null
        19 fields in addOnProducts
        • idstring (uuid)
        • productobject | null
          9 fields in product
          • productIdstring (uuid)
          • productNamestring | null
          • productTypeinteger (int32)

            Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.

          • variantIdstring (uuid)
          • variantNamestring | null
          • hasVariantsboolean
          • productGroupIdstring (uuid)
          • productGroupNamestring | null
          • useBasePriceboolean
        • quantitynumber (double)
        • unitQuantitynumber (double)
        • unitobject | null
          2 fields in unit
          • namestring | null
          • typeinteger (int32)

            Allowed values: 0, 1, 2, 3.

        • productPriceInclTaxobject | null
          2 fields in productPriceInclTax
          • unitPriceobject | null
            2 fields in unitPrice
            • amountnumber (double)
            • currencystring | null
          • additionalPriceobject | null
            2 fields in additionalPrice
            • amountnumber (double)
            • currencystring | null
        • productPriceExclTaxobject | null
          2 fields in productPriceExclTax
          • unitPriceobject | null
            2 fields in unitPrice
            • amountnumber (double)
            • currencystring | null
          • additionalPriceobject | null
            2 fields in additionalPrice
            • amountnumber (double)
            • currencystring | null
        • productMaterialCostExclTaxobject | null
          2 fields in productMaterialCostExclTax
          • unitPriceobject | null
            2 fields in unitPrice
            • amountnumber (double)
            • currencystring | null
          • additionalPriceobject | null
            2 fields in additionalPrice
            • amountnumber (double)
            • currencystring | null
        • totalPriceInclTaxobject | null
          2 fields in totalPriceInclTax
          • amountnumber (double)
          • currencystring | null
        • totalPriceExclTaxobject | null
          2 fields in totalPriceExclTax
          • amountnumber (double)
          • currencystring | null
        • totalMaterialCostExclTaxobject | null
          2 fields in totalMaterialCostExclTax
          • amountnumber (double)
          • currencystring | null
        • discountAmountInclTaxobject | null
          2 fields in discountAmountInclTax
          • amountnumber (double)
          • currencystring | null
        • discountAmountExclTaxobject | null
          2 fields in discountAmountExclTax
          • amountnumber (double)
          • currencystring | null
        • taxesarray<object> | null
          2 fields in taxes
          • typeinteger (int32)

            Allowed values: 1, 2.

          • ratenumber (double)
        • discountobject | null
          2 fields in discount
          • valuenumber (double) | null
          • typeinteger (int32) | null

            Allowed values: 0, 1.

        • statusinteger (int32) | null

          Allowed values: 0, 1, 2, 3.

        • addOnGroupIdstring (uuid)
        • addOnGroupNamestring | null
        • addOnFreeAmountnumber (double)
      • discountobject | null
        2 fields in discount
        • valuenumber (double) | null
        • typeinteger (int32) | null

          Allowed values: 0, 1.

      • statusinteger (int32) | null

        Allowed values: 0, 1, 2, 3.

      • soldAtstring (date-time)
      • refundsarray<object> | null
        5 fields in refunds
        • idstring (uuid)
        • quantitynumber (double)
        • statusinteger (int32)

          Allowed values: 0, 1, 2, 3.

        • refundReferencestring (uuid)
        • orderItemIdstring (uuid)
      • itemsarray<object> | null
    • feesarray<object> | null
      5 fields in fees
      • feeIdstring (uuid)
      • feeNamestring | null
      • amountInclTaxobject | null
        2 fields in amountInclTax
        • amountnumber (double)
        • currencystring | null
      • amountExclTaxobject | null
        2 fields in amountExclTax
        • amountnumber (double)
        • currencystring | null
      • taxesarray<object> | null
        2 fields in taxes
        • typeinteger (int32)

          Allowed values: 1, 2.

        • ratenumber (double)
    • voucherBasisIdstring (uuid) | null
    • incrementalNumbersobject | null
      4 fields in incrementalNumbers
      • ticketNumberinteger (int64) | null

        Unique 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) | null

        Unbroken sequence per outlet which statisfies the needs of certain pos system laws, is only used on Checks.

      • referenceNumberinteger (int64) | null

        Unbroken sequence per outlet which is used for all types of sales. Suitable for correlation between systems.

      • refundSerialNumberinteger (int64) | null

        Uses same series as SerialNumber and is set on orders which is refunded.

    • fromTypeinteger (int32)

      Allowed values: 0, 1.

    • fromTypeCreatedstring (date-time)
    • createdCheckTenantUserIdstring (uuid) | null

      The tenant user id of who created the check this order was created from.

    • closedCheckTenantUserIdstring (uuid) | null

      Tenant user id of who closed the check this order was created from.

    • createdCheckClientIdstring (uuid) | null
    • closedCheckClientIdstring (uuid) | null
    • ticketedAtstring (date-time) | null

      The 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) | null
    • checkoutServiceTimeobject | null

      Service 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 checkoutServiceTime
      • kindinteger (int32)

        Allowed values: 0, 1, -1.

      • timestring (date-time) | null
    • ticketClosedAtstring (date-time) | null
    • companyInfoobject | null
      7 fields in companyInfo
      • companyIdstring (uuid) | null
      • companyNamestring | null
      • companyBusinessNumberstring | null
      • addressobject | null
        4 fields in address
        • streetstring | null
        • street2string | null
        • zipCodestring | null
        • citystring | null
      • invoiceEmailstring | null
      • memberIdstring (uuid) | null
      • memberNamestring | null
    • metaDataarray<object> | null
      2 fields in metaData
      • metaDataany | null

        Rename for next version to Metadata

      • metaDataTypestring | null
    • guestGroupIdstring (uuid) | null
    • orderTypeinteger (int32)

      Allowed values: 0, 1, 2, 3, 4, 5.

    • parentOrderIdstring (uuid) | null
    • customNamestring | null
  • metaobject | null
    2 fields in meta
    • countinteger (int32)
    • offsetinteger (int32)
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)
429Too Many Requestsapplication/json
  • typestring | null
  • titlestring | null
  • statusinteger (int32) | null
  • detailstring | null
  • instancestring | null