developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APITickets

Get ticket details

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

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • outletIdstring (uuid)required
  • ticketIdstring (uuid)required

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • ticketobject | null
    25 fields in ticket
    • idstring (uuid)
    • 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.

    • orderFormatinteger (int32)

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

    • 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 | null
    • customerobject | null
      5 fields in customer
      • emailstring | null
      • fullNamestring | null
      • customerIdstring (uuid) | 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)
      • phonestring | 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
    • 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
    • statusinteger (int32)

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

    • instructionsstring | null
    • acceptedAtstring (date-time)
    • preparingAtstring (date-time) | null
    • readyAtstring (date-time) | null
    • closedAtstring (date-time) | null
    • autoModeinteger (int32)

      Allowed values: 0, 1, 2, 3.

    • sourcestring | null
    • saleSourceIdstring (uuid)
    • 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
    • feesarray<object> | null
      5 fields in fees
      • idstring (uuid)
      • feeIdstring (uuid)
      • namestring | null
      • amountInclTaxobject | null
        2 fields in amountInclTax
        • amountnumber (double)
        • currencystring | null
      • amountExclTaxobject | null
        2 fields in amountExclTax
        • amountnumber (double)
        • currencystring | null
    • subTicketsarray<object> | null
      3 fields in subTickets
      • idstring (uuid)
      • ticketDestinationIdstring (uuid)
      • isCompletedboolean
    • itemsarray<object> | null
      16 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)
      • courseNamestring | null
      • coursePositioninteger (int32)
      • statusinteger (int32)

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

      • ticketItemsarray<object> | null
      • ticketItemTypeinteger (int32)

        Allowed values: 0, 1, 2.

401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)