developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APITickets

Get ticket details list

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

Filtering

Filter the list with filter[field]=operator:value; see how filtering works.

  • created (datetime)
  • ticketnumber (long)
  • orderformat (enum flags)
  • ordertype (enum)
  • status (enum)
  • salesourceid (guid)
  • iscorrectionticket (boolean)

Try filters

Build a filter for this endpoint and copy the request. How filtering works

Filters

Documented filter fields

Reads asNo filters: the endpoint returns everything (paged).

Request
(no filters)

No sample data for this endpoint; the request above is what you would send.

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 7 fields. Build a filter

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • itemsarray<object> | null
    16 fields in items
    • idstring (uuid)
    • ticketNumberinteger (int64) | null
    • orderFormatinteger (int32)

      Allowed values: 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191.

    • orderTypeinteger (int32)

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

    • serviceTimeobject | 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 serviceTime
      • kindinteger (int32)

        Allowed values: 0, 1, -1.

      • timestring (date-time) | null
    • preparationTimestring (date-span) | null
    • customerNamestring | null
    • salesLocationobject | null
      4 fields in salesLocation
      • typeinteger (int32)

        Allowed values: 0, 1, 2, 3.

      • tableobject | null
        2 fields in table
        • idstring (uuid)
        • numberinteger (int32)
      • posobject | null
        2 fields in pos
        • idstring (uuid)
        • namestring | null
      • expressobject | null
        2 fields in express
        • idstring (uuid)
        • namestring | null
    • statusinteger (int32)

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

    • customTicketNumberinteger (int64) | null
    • totalAmountobject | null
      2 fields in totalAmount
      • amountnumber (double)
      • currencystring | null
    • subtotalInclTaxobject | null
      2 fields in subtotalInclTax
      • amountnumber (double)
      • currencystring | null
    • subTotalDiscountInclTaxobject | null
      2 fields in subTotalDiscountInclTax
      • amountnumber (double)
      • currencystring | null
    • feeAmountInclTaxobject | null
      2 fields in feeAmountInclTax
      • amountnumber (double)
      • currencystring | null
    • subTicketsarray<object> | null
      3 fields in subTickets
      • idstring (uuid)
      • ticketDestinationIdstring (uuid)
      • isCompletedboolean
    • itemsarray<object> | null
      11 fields in items
      • idstring (uuid)
      • productobject | null
        10 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
        • variantTypeinteger (int32)

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

        • hasVariantsboolean
        • productGroupIdstring (uuid)
        • productGroupNamestring | null
        • glassesPerBottlenumber (double) | null
      • quantitynumber (double)
      • unitQuantitynumber (double)
      • unitstring | null
      • unitTypeinteger (int32)

        Allowed values: 0, 1, 2, 3.

      • kitchenMessagestring | null
      • totalPriceInclTaxobject | null
        2 fields in totalPriceInclTax
        • amountnumber (double)
        • currencystring | null
      • discountAmountInclTaxobject | null
        2 fields in discountAmountInclTax
        • amountnumber (double)
        • currencystring | null
      • ticketDestinationsarray<string (uuid)> | null
      • 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)
  • metaobject | null
    2 fields in meta
    • countinteger (int32)
    • offsetinteger (int32)
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)