developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIChecks

Get check details V2

gethttps://core-api.ancon.io/api/v2/Outlets/{outletId}/Checks/{checkId}
View .mdOpenAPI

Authorization

  • Access-Tokenheaderrequired

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

Path parameters

  • outletIdstring (uuid)required
  • checkIdstring (uuid)required

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • timestampinteger (int64)

    Gets the timestamp in Unix time milliseconds when this response is created.

  • checkobject | null
    44 fields in check
    • idstring (uuid)
    • createdstring (date-time)
    • modifiedstring (date-time)
    • outletIdstring (uuid)
    • 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.

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

        Allowed values: 0, 1, 2, 3.

    • orderIdstring (uuid) | null
    • deletedstring (date-time) | null
    • closedCheckTenantUserIdstring (uuid) | null
    • createdCheckTenantUserIdstring (uuid)
    • closedCheckClientIdstring (uuid) | null
    • createdCheckClientIdstring (uuid)
    • deletedReasonstring | null
    • customTicketNumberinteger (int64) | 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
    • customerobject | null
      6 fields in customer
      • emailstring | null
      • fullNamestring | null
      • customerIdstring (uuid) | null
      • identityUserIdstring (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
    • discountValueobject | null
      2 fields in discountValue
      • valuenumber (double)
      • typeinteger (int32)

        Allowed values: 0, 1.

    • discountInfoobject | null
      2 fields in discountInfo
      • discountIdstring (uuid) | null
      • discountNamestring | null
    • customNamestring | null
    • guestCountinteger (int32) | null
    • saleSourceIdstring (uuid)
    • ticketNumberinteger (int64)
    • serialNumberinteger (int64)
    • referenceNumberinteger (int64)
    • collectionTicketIdstring (uuid) | null
    • lingerWhenClosedboolean
    • groupIdstring (uuid) | null
    • isHiddenboolean
    • awaitingConfirmationstring (date-time) | null
    • guestGroupIdstring (uuid) | null
    • statusinteger (int32)

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

    • totalAmountnumber (double)
    • totalAmountPlusTipnumber (double)
    • taxAmountnumber (double)
    • subtotalInclTaxnumber (double)
    • subtotalExclTaxnumber (double)
    • subTotalDiscountInclTaxnumber (double)
    • subTotalDiscountExclTaxnumber (double)
    • remainingAmountToPaynumber (double)
    • itemsarray<object> | null
      48 fields in items
      • idstring (uuid)
      • createdstring (date-time)
      • modifiedstring (date-time)
      • productobject | null
        18 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
        • useBasePriceboolean
        • isSystemProductboolean
        • productNumberstring | null
        • variantNumberstring | null
        • positioninteger (int32) | null
        • storageInfoobject | null
          2 fields in storageInfo
          • temperatureinteger (int32)
          • sizeobject
            3 fields in size
            • heightinteger (int32)
            • widthinteger (int32)
            • lengthinteger (int32)
        • subProductQuantitynumber (double) | null
        • subProductIdstring (uuid) | null
      • quantitynumber (double)
      • unitQuantitynumber (double)
      • unitobject | null
        2 fields in unit
        • namestring | null
        • typeinteger (int32)

          Allowed values: 0, 1, 2, 3.

      • productPriceInclTaxobject
        2 fields in productPriceInclTax
        • unitPricenumber (double)
        • additionalPricenumber (double)
      • productMaterialCostobject
        2 fields in productMaterialCost
        • unitPricenumber (double)
        • additionalPricenumber (double)
      • kitchenMessagestring | null
      • discountInfoobject | null
        2 fields in discountInfo
        • discountIdstring (uuid) | null
        • discountNamestring | null
      • discountValueobject | null
        2 fields in discountValue
        • valuenumber (double)
        • typeinteger (int32)

          Allowed values: 0, 1.

      • tagstring | null
      • pricePresetIdstring (uuid) | null
      • isTaxMandatoryboolean
      • isMultiproductboolean
      • hasOwnPriceboolean
      • taxesarray<object> | null
        2 fields in taxes
        • typeinteger (int32)

          Allowed values: 1, 2.

        • ratenumber (double)
      • productPriceExclTaxobject
        2 fields in productPriceExclTax
        • unitPricenumber (double)
        • additionalPricenumber (double)
      • priceInclTaxnumber (double)
      • priceExclTaxnumber (double)
      • totalPriceInclTaxnumber (double)
      • totalPriceExclTaxnumber (double)
      • productPricePerQuantityInclTaxnumber (double)
      • totalMaterialCostExclTaxnumber (double)
      • discountableAmountInclTaxnumber (double)
      • discountAmountInclTaxnumber (double)
      • discountAmountExclTaxnumber (double)
      • totalDiscountAmountInclTaxnumber (double)
      • totalDiscountAmountExclTaxnumber (double)
      • modificationPriceInclTaxnumber (double)
      • modificationPriceExclTaxnumber (double)
      • discountablePriceInclTaxnumber (double)
      • totalDiscountablePriceInclTaxnumber (double)
      • checkPaymentIdstring (uuid) | null
      • paidAtstring (date-time) | null
      • checkIdstring (uuid)
      • statusinteger (int32)

        Allowed values: 0, 1, 2, 4, 8, 16, 32.

      • ticketedAtstring (date-time) | null
      • ticketedTenantUserIdstring (uuid) | null
      • upsellGroupIdstring (uuid) | null
      • isPrepaidboolean
      • usedAccountIdstring (uuid) | null
      • courseNamestring | null
      • coursePositioninteger (int32)
      • modificationsarray<object> | null
        11 fields in modifications
        • modificationstring | null
        • costnumber (double)
        • materialCostnumber (double)
        • ingredientIdstring (uuid) | null
        • addOnGroupIdstring (uuid) | null
        • replaceIdstring (uuid) | null
        • namestring | null
        • replacementNamestring | null
        • quantitynumber (double)
        • freeAmountnumber (double)
        • positioninteger (int32)
      • subCheckItemsarray<object> | null
        42 fields in subCheckItems
        • idstring (uuid)
        • createdstring (date-time)
        • modifiedstring (date-time)
        • productobject | null
          18 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
          • useBasePriceboolean
          • isSystemProductboolean
          • productNumberstring | null
          • variantNumberstring | null
          • positioninteger (int32) | null
          • storageInfoobject | null
            2 fields in storageInfo
            • temperatureinteger (int32)
            • sizeobject
          • subProductQuantitynumber (double) | null
          • subProductIdstring (uuid) | null
        • quantitynumber (double)
        • unitQuantitynumber (double)
        • unitobject | null
          2 fields in unit
          • namestring | null
          • typeinteger (int32)

            Allowed values: 0, 1, 2, 3.

        • productPriceInclTaxobject
          2 fields in productPriceInclTax
          • unitPricenumber (double)
          • additionalPricenumber (double)
        • productMaterialCostobject
          2 fields in productMaterialCost
          • unitPricenumber (double)
          • additionalPricenumber (double)
        • kitchenMessagestring | null
        • discountInfoobject | null
          2 fields in discountInfo
          • discountIdstring (uuid) | null
          • discountNamestring | null
        • discountValueobject | null
          2 fields in discountValue
          • valuenumber (double)
          • typeinteger (int32)

            Allowed values: 0, 1.

        • tagstring | null
        • pricePresetIdstring (uuid) | null
        • isTaxMandatoryboolean
        • isMultiproductboolean
        • hasOwnPriceboolean
        • taxesarray<object> | null
          2 fields in taxes
          • typeinteger (int32)

            Allowed values: 1, 2.

          • ratenumber (double)
        • productPriceExclTaxobject
          2 fields in productPriceExclTax
          • unitPricenumber (double)
          • additionalPricenumber (double)
        • priceInclTaxnumber (double)
        • priceExclTaxnumber (double)
        • totalPriceInclTaxnumber (double)
        • totalPriceExclTaxnumber (double)
        • productPricePerQuantityInclTaxnumber (double)
        • totalMaterialCostExclTaxnumber (double)
        • discountableAmountInclTaxnumber (double)
        • discountAmountInclTaxnumber (double)
        • discountAmountExclTaxnumber (double)
        • totalDiscountAmountInclTaxnumber (double)
        • totalDiscountAmountExclTaxnumber (double)
        • modificationPriceInclTaxnumber (double)
        • modificationPriceExclTaxnumber (double)
        • discountablePriceInclTaxnumber (double)
        • totalDiscountablePriceInclTaxnumber (double)
        • parentUseBasePriceboolean
        • statusinteger (int32)

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

        • usedAccountIdstring (uuid) | null
        • upsellGroupIdstring (uuid) | null
        • courseNamestring | null
        • coursePositioninteger (int32)
        • modificationsarray<object> | null
          11 fields in modifications
          • modificationstring | null
          • costnumber (double)
          • materialCostnumber (double)
          • ingredientIdstring (uuid) | null
          • addOnGroupIdstring (uuid) | null
          • replaceIdstring (uuid) | null
          • namestring | null
          • replacementNamestring | null
          • quantitynumber (double)
          • freeAmountnumber (double)
          • positioninteger (int32)
        • addOnProductsarray<object> | null
          38 fields in addOnProducts
          • idstring (uuid)
          • createdstring (date-time)
          • modifiedstring (date-time)
          • productobject | null
            18 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
            • useBasePriceboolean
            • isSystemProductboolean
            • productNumberstring | null
            • variantNumberstring | null
            • positioninteger (int32) | null
            • storageInfoobject | null
            • subProductQuantitynumber (double) | null
            • subProductIdstring (uuid) | null
          • quantitynumber (double)
          • unitQuantitynumber (double)
          • unitobject | null
            2 fields in unit
            • namestring | null
            • typeinteger (int32)

              Allowed values: 0, 1, 2, 3.

          • productPriceInclTaxobject
            2 fields in productPriceInclTax
            • unitPricenumber (double)
            • additionalPricenumber (double)
          • productMaterialCostobject
            2 fields in productMaterialCost
            • unitPricenumber (double)
            • additionalPricenumber (double)
          • kitchenMessagestring | null
          • discountInfoobject | null
            2 fields in discountInfo
            • discountIdstring (uuid) | null
            • discountNamestring | null
          • discountValueobject | null
            2 fields in discountValue
            • valuenumber (double)
            • typeinteger (int32)

              Allowed values: 0, 1.

          • tagstring | null
          • pricePresetIdstring (uuid) | null
          • isTaxMandatoryboolean
          • isMultiproductboolean
          • hasOwnPriceboolean
          • taxesarray<object> | null
            2 fields in taxes
            • typeinteger (int32)

              Allowed values: 1, 2.

            • ratenumber (double)
          • productPriceExclTaxobject
            2 fields in productPriceExclTax
            • unitPricenumber (double)
            • additionalPricenumber (double)
          • priceInclTaxnumber (double)
          • priceExclTaxnumber (double)
          • totalPriceInclTaxnumber (double)
          • totalPriceExclTaxnumber (double)
          • productPricePerQuantityInclTaxnumber (double)
          • totalMaterialCostExclTaxnumber (double)
          • discountableAmountInclTaxnumber (double)
          • discountAmountInclTaxnumber (double)
          • discountAmountExclTaxnumber (double)
          • totalDiscountAmountInclTaxnumber (double)
          • totalDiscountAmountExclTaxnumber (double)
          • modificationPriceInclTaxnumber (double)
          • modificationPriceExclTaxnumber (double)
          • discountablePriceInclTaxnumber (double)
          • totalDiscountablePriceInclTaxnumber (double)
          • addOnGroupIdstring (uuid)
          • addOnGroupNamestring | null
          • freeAmountnumber (double) | null
          • positioninteger (int32) | null
      • addOnProductsarray<object> | null
        38 fields in addOnProducts
        • idstring (uuid)
        • createdstring (date-time)
        • modifiedstring (date-time)
        • productobject | null
          18 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
          • useBasePriceboolean
          • isSystemProductboolean
          • productNumberstring | null
          • variantNumberstring | null
          • positioninteger (int32) | null
          • storageInfoobject | null
            2 fields in storageInfo
            • temperatureinteger (int32)
            • sizeobject
          • subProductQuantitynumber (double) | null
          • subProductIdstring (uuid) | null
        • quantitynumber (double)
        • unitQuantitynumber (double)
        • unitobject | null
          2 fields in unit
          • namestring | null
          • typeinteger (int32)

            Allowed values: 0, 1, 2, 3.

        • productPriceInclTaxobject
          2 fields in productPriceInclTax
          • unitPricenumber (double)
          • additionalPricenumber (double)
        • productMaterialCostobject
          2 fields in productMaterialCost
          • unitPricenumber (double)
          • additionalPricenumber (double)
        • kitchenMessagestring | null
        • discountInfoobject | null
          2 fields in discountInfo
          • discountIdstring (uuid) | null
          • discountNamestring | null
        • discountValueobject | null
          2 fields in discountValue
          • valuenumber (double)
          • typeinteger (int32)

            Allowed values: 0, 1.

        • tagstring | null
        • pricePresetIdstring (uuid) | null
        • isTaxMandatoryboolean
        • isMultiproductboolean
        • hasOwnPriceboolean
        • taxesarray<object> | null
          2 fields in taxes
          • typeinteger (int32)

            Allowed values: 1, 2.

          • ratenumber (double)
        • productPriceExclTaxobject
          2 fields in productPriceExclTax
          • unitPricenumber (double)
          • additionalPricenumber (double)
        • priceInclTaxnumber (double)
        • priceExclTaxnumber (double)
        • totalPriceInclTaxnumber (double)
        • totalPriceExclTaxnumber (double)
        • productPricePerQuantityInclTaxnumber (double)
        • totalMaterialCostExclTaxnumber (double)
        • discountableAmountInclTaxnumber (double)
        • discountAmountInclTaxnumber (double)
        • discountAmountExclTaxnumber (double)
        • totalDiscountAmountInclTaxnumber (double)
        • totalDiscountAmountExclTaxnumber (double)
        • modificationPriceInclTaxnumber (double)
        • modificationPriceExclTaxnumber (double)
        • discountablePriceInclTaxnumber (double)
        • totalDiscountablePriceInclTaxnumber (double)
        • addOnGroupIdstring (uuid)
        • addOnGroupNamestring | null
        • freeAmountnumber (double) | null
        • positioninteger (int32) | null
    • paymentsarray<object> | null
      28 fields in payments
      • idstring (uuid)
      • createdstring (date-time)
      • modifiedstring (date-time)
      • checkIdstring (uuid)
      • paymentTypeinteger (int32)

        Allowed values: 1, 2, 3.

      • 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
      • externalReferencestring | null
      • statusinteger (int32)

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

      • terminalIdstring (uuid) | 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
      • externalIdentifierstring | null
      • clientIdstring (uuid)
      • externalTimeStampstring (date-time) | null
      • paymentDoneAtstring (date-time) | null
      • errorTypeinteger (int32) | null

        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, 24, 25, 26, -1.

      • tenantUserIdstring (uuid)
      • tipAmountnumber (double)
      • centralControlUnitSerialstring | null
      • isReceiptPrintedboolean
      • invoiceReferenceNotestring | null
      • receiptsarray<object> | null
        3 fields in receipts
        • receiverTypeinteger (int32)

          Allowed values: 1, 2.

        • needsSignatureboolean
        • receiptTextsarray<object> | null
          3 fields in receiptTexts
          • keystring | null
          • valuestring | null
          • namestring | null
      • transactionsarray<object> | null
        9 fields in transactions
        • idstring (uuid)
        • createdstring (date-time)
        • modifiedstring (date-time)
        • typeinteger (int32)

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

        • statusinteger (int32)

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

        • externalReferencestring | null
        • externalDatastring | null
        • errorDetailsstring | null
        • confirmationDatastring | null
      • usedGiftCardobject | null
        7 fields in usedGiftCard
        • idstring (uuid)
        • giftCardNumberstring | null
        • giftCardNumberTypeinteger (int32)

          Allowed values: 0, 1, 2.

        • soldDatestring (date-time) | null
        • expiryDatestring (date-time) | null
        • amountobject | null
          2 fields in amount
          • amountnumber (double)
          • currencystring | null
        • balanceobject | null
          2 fields in balance
          • amountnumber (double)
          • currencystring | null
      • usedWalletobject | null
        6 fields in usedWallet
        • idstring (uuid)
        • walletNumberstring | null
        • walletNumberTypeinteger (int32)

          Allowed values: 0, 1.

        • soldDatestring (date-time) | null
        • expiryDatestring (date-time) | null
        • balanceobject | null
          2 fields in balance
          • amountnumber (double)
          • currencystring | null
      • topUpWalletsarray<object> | null
        2 fields in topUpWallets
        • item1object | null
          6 fields in item1
          • idstring (uuid)
          • walletNumberstring | null
          • walletNumberTypeinteger (int32)

            Allowed values: 0, 1.

          • soldDatestring (date-time) | null
          • expiryDatestring (date-time) | null
          • balanceobject | null
            2 fields in balance
            • amountnumber (double)
            • currencystring | null
        • item2object | null
          2 fields in item2
          • amountnumber (double)
          • currencyCodestring | null
      • omniboostRoomsInfoarray<object> | null
        2 fields in omniboostRoomsInfo
        • idstring (uuid)
        • namestring | null
    • metadataarray<object> | null
      8 fields in metadata
      • idstring (uuid)
      • createdstring (date-time)
      • modifiedstring (date-time)
      • checkIdstring (uuid)
      • referencestring | null
      • typestring | null
      • isSystemboolean
      • metadataany | null
401Unauthorizedapplication/json
  • timestampinteger (int64)

    Gets the timestamp in Unix time milliseconds when this response is created.

  • messagestring | null
404Not Foundapplication/json
  • timestampinteger (int64)

    Gets the timestamp in Unix time milliseconds when this response is created.

  • messagestring | null
  • errorCodestring (uuid)