developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIChecks

Add item V2

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

Adds a check item to an existing check or creates a check and adds an item to it.

Authorization

  • Access-Tokenheaderrequired

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

Path parameters

  • outletIdstring (uuid)required

Header parameters

  • correlationIdstring

    Correlation Id for the request

Request body application/json

  • itemobjectrequired
    9 fields in item
    • variantIdstring (uuid)required
    • quantitynumber (double)required

      min -100000, max 100000.

    • kitchenMessagestring | null
    • priceobject | null
      2 fields in price
      • unitPricenumber (double)
      • additionalPricenumber (double)
    • upsellGroupIdstring (uuid) | null
    • tagstring | null
    • modificationsarray<object> | null
      7 fields in modifications
      • modificationstring | null
      • ingredientIdstring (uuid) | null
      • addOnGroupIdstring (uuid) | null
      • replaceIdstring (uuid) | null
      • descriptionstring | null
      • quantitynumber (double)
      • freeAmountnumber (double)
    • addOnProductsarray<object> | null
      5 fields in addOnProducts
      • variantIdstring (uuid)
      • addOnGroupIdstring (uuid)
      • quantitynumber (double)
      • freeAmountnumber (double)
      • unitQuantitynumber (double) | null
    • subProductSpecificationarray<object> | null

      Gets or sets the list of sub product specifications. It is used when adding a multi product with sub product with optional variant. In those cases a variant has to be selected.

      2 fields in subProductSpecification
      • subProductIdstring (uuid)
      • subProductVariantIdstring (uuid)
  • courseIdstring (uuid) | null
  • checkIdstring (uuid) | null
  • checkobject | null
    6 fields in check
    • orderFormatinteger (int32)required

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

    • salesLocationTypeinteger (int32)required

      Allowed values: 0, 1, 2, 3.

    • salesLocationIdstring (uuid)required
    • guestCountinteger (int32) | null
    • collectionTicketIdstring (uuid) | null
    • externalTableIdstring | null
  • isPrepaidboolean

Responses

200OKapplication/json
  • timestampinteger (int64)

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

  • checkItemobject | null
    48 fields in checkItem
    • 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
            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)
      • 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
            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
    • 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
            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)
      • addOnGroupIdstring (uuid)
      • addOnGroupNamestring | null
      • freeAmountnumber (double) | null
      • positioninteger (int32) | null
  • checkobject | null
    5 fields in check
    • idstring (uuid)
    • ticketNumberinteger (int64)
    • customNamestring | null
    • customTicketNumberinteger (int64) | null
    • orderFormatinteger (int32)

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

400Bad Requestapplication/json
  • timestampinteger (int64)

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

  • messagestring | null
  • errorCodestring (uuid)
  • additionalDataany | 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)
423Lockedapplication/json
  • timestampinteger (int64)

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

  • objectIdstring (uuid)
  • objectTypestring | null
  • timeoutstring | null
  • reasonstring | null