developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIChecks

Add itemdeprecated

posthttps://core-api.ancon.io/api/v1/Outlets/{outletId}/Checks/AddItem
View .mdOpenAPI
Deprecated. Check the description for the replacement and sunset date, and see how deprecation works.

Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.

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
    8 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
    • modificationsarray<object> | null
      7 fields in modifications
      • modificationstring | null
      • ingredientIdstring (uuid) | null
      • addOnGroupIdstring (uuid) | null
      • replaceIdstring (uuid) | null
      • descriptionstring | null
      • quantitynumber (double)
      • freeAmountnumber (double)
    • tagstring | 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(s). In those cases the API user has to select a variant.

      2 fields in subProductSpecification
      • subProductIdstring (uuid)

        Gets or sets the Id of the sub product. A sub product can be be configured in Admin to point to a product and optionally a specific variant. So in some cases the API user has to specify which variant should be added as a sub product.

      • subProductVariantIdstring (uuid)

        Gets or sets the id of the variant to be used for this subproduct.

  • courseIdstring (uuid) | null
  • checkIdstring (uuid) | null
  • checkobject | null
    6 fields in check
    • orderFormatinteger (int32)

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

    • salesLocationTypeinteger (int32)

      Allowed values: 0, 1, 2, 3.

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

Responses

200OKapplication/json
  • checkItemobject | null

    Restored 1.0 wire shape of the old domain CheckItemDto as serialized inside the legacy CheckPaidEvent websocket payload on alpha/production (before the check item domain was restructured into CheckItemDto/SubCheckItemDto). Frozen - do not change the serialized surface.

    33 fields in checkItem
    • idstring (uuid)
    • createdstring (date-time)
    • modifiedstring (date-time)
    • quantityobject | null
      1 field in quantity
      • valuenumber (double)
    • unitQuantityobject | null
      1 field in unitQuantity
      • valuenumber (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)
        • currencyCodestring | null
      • additionalPriceobject | null
        2 fields in additionalPrice
        • amountnumber (double)
        • currencyCodestring | null
    • productPriceExclTaxobject | null
      2 fields in productPriceExclTax
      • unitPriceobject | null
        2 fields in unitPrice
        • amountnumber (double)
        • currencyCodestring | null
      • additionalPriceobject | null
        2 fields in additionalPrice
        • amountnumber (double)
        • currencyCodestring | null
    • kitchenMessagestring | null
    • discountobject | null
      2 fields in discount
      • valuenumber (double) | null
      • typeinteger (int32) | null

        Allowed values: 0, 1.

    • checkPaymentIdstring (uuid) | null
    • paidAtstring (date-time) | null
    • checkIdstring (uuid) | null
    • statusinteger (int32)

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

    • productMaterialCostExclTaxobject | null
      2 fields in productMaterialCostExclTax
      • unitPriceobject | null
        2 fields in unitPrice
        • amountnumber (double)
        • currencyCodestring | null
      • additionalPriceobject | null
        2 fields in additionalPrice
        • amountnumber (double)
        • currencyCodestring | null
    • ticketedAtstring (date-time) | null
    • ticketedTenantUserIdstring (uuid) | null
    • courseNamestring | null
    • coursePositioninteger (int32)
    • upsellGroupIdstring (uuid) | null
    • productobject | null

      Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.

      20 fields in product
      • glassesPerBottlenumber (double) | null
      • hasVariantsboolean
      • isSystemProductboolean
      • localizedProductNamesobject | null
        1 field in localizedProductNames
        • translationsmap<string, string> | null
      • localizedVariantNamesobject | null
        1 field in localizedVariantNames
        • translationsmap<string, string> | null
      • positionobject | null
        1 field in position
        • positioninteger (int32)
      • productGroupIdstring (uuid)
      • productGroupNamestring | null
      • productIdstring (uuid)
      • productNamestring | null
      • productNumberstring | null
      • productTypeinteger (int32)

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

      • storageInfoobject | null
        2 fields in storageInfo
        • temperatureinteger (int32)
        • sizeobject | null
          3 fields in size
          • heightinteger (int32)
          • widthinteger (int32)
          • lengthinteger (int32)
      • subProductIdstring (uuid) | null
      • subProductQuantityobject | null
        1 field in subProductQuantity
        • valuenumber (double)
      • useBasePriceboolean
      • variantIdstring (uuid)
      • variantNamestring | null
      • variantNumberstring | null
      • variantTypeinteger (int32)

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

    • discountInfoobject | null
      2 fields in discountInfo
      • discountIdstring (uuid) | null
      • discountNamestring | null
    • parentItemIdstring (uuid) | null
    • taxesarray<object> | null
      5 fields in taxes
      • idstring (uuid)
      • createdstring (date-time)
      • modifiedstring (date-time)
      • itemIdstring (uuid)
      • taxobject | null
        2 fields in tax
        • taxIdstring (uuid)
        • taxValueobject | null
          2 fields in taxValue
          • typeinteger (int32)

            Allowed values: 1, 2.

          • ratenumber (double)
    • modificationsarray<object> | null
      5 fields in modifications
      • idstring (uuid)
      • createdstring (date-time)
      • modifiedstring (date-time)
      • itemIdstring (uuid)
      • modificationobject | null

        Restored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.

        9 fields in modification
        • addOnGroupobject | null
          3 fields in addOnGroup
          • idstring (uuid)
          • namestring | null
          • localizedCustomerFacingNamesobject | null
            1 field in localizedCustomerFacingNames
            • translationsmap<string, string> | null
        • costobject | null
          2 fields in cost
          • amountnumber (double)
          • currencyCodestring | null
        • freeAmountobject | null
          1 field in freeAmount
          • valuenumber (double)
        • ingredientobject | null
          3 fields in ingredient
          • idstring (uuid)
          • nameobject | null
            1 field in name
            • valuestring | null
          • localizedNamesobject | null
            1 field in localizedNames
            • translationsmap<string, string> | null
        • materialCostobject | null
          2 fields in materialCost
          • amountnumber (double)
          • currencyCodestring | null
        • modificationstring | null
        • positionobject | null
          1 field in position
          • positioninteger (int32)
        • quantityobject | null
          1 field in quantity
          • valuenumber (double)
        • replacementobject | null
          3 fields in replacement
          • idstring (uuid)
          • nameobject | null
            1 field in name
            • valuestring | null
          • localizedNamesobject | null
            1 field in localizedNames
            • translationsmap<string, string> | null
    • checkItemsarray<object> | null
    • pricePresetIdstring (uuid) | null
    • isPrepaidboolean
    • usedAccountIdstring (uuid) | null
    • addOnProductsarray<object> | null
      21 fields in addOnProducts
      • idstring (uuid)
      • createdstring (date-time)
      • modifiedstring (date-time)
      • quantityobject | null
        1 field in quantity
        • valuenumber (double)
      • unitQuantityobject | null
        1 field in unitQuantity
        • valuenumber (double)
      • unitobject | null
        2 fields in unit
        • namestring | null
        • typeinteger (int32)

          Allowed values: 0, 1, 2, 3.

      • pricePresetIdstring (uuid) | null
      • productPriceInclTaxobject | null
        2 fields in productPriceInclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencyCodestring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencyCodestring | null
      • productPriceExclTaxobject | null
        2 fields in productPriceExclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencyCodestring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencyCodestring | null
      • discountobject | null
        2 fields in discount
        • valuenumber (double) | null
        • typeinteger (int32) | null

          Allowed values: 0, 1.

      • statusinteger (int32)

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

      • productMaterialCostExclTaxobject | null
        2 fields in productMaterialCostExclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencyCodestring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencyCodestring | null
      • productobject | null

        Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.

        20 fields in product
        • glassesPerBottlenumber (double) | null
        • hasVariantsboolean
        • isSystemProductboolean
        • localizedProductNamesobject | null
          1 field in localizedProductNames
          • translationsmap<string, string> | null
        • localizedVariantNamesobject | null
          1 field in localizedVariantNames
          • translationsmap<string, string> | null
        • positionobject | null
          1 field in position
          • positioninteger (int32)
        • productGroupIdstring (uuid)
        • productGroupNamestring | null
        • productIdstring (uuid)
        • productNamestring | null
        • productNumberstring | null
        • productTypeinteger (int32)

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

        • storageInfoobject | null
          2 fields in storageInfo
          • temperatureinteger (int32)
          • sizeobject | null
            3 fields in size
            • heightinteger (int32)
            • widthinteger (int32)
            • lengthinteger (int32)
        • subProductIdstring (uuid) | null
        • subProductQuantityobject | null
          1 field in subProductQuantity
          • valuenumber (double)
        • useBasePriceboolean
        • variantIdstring (uuid)
        • variantNamestring | null
        • variantNumberstring | null
        • variantTypeinteger (int32)

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

      • discountInfoobject | null
        2 fields in discountInfo
        • discountIdstring (uuid) | null
        • discountNamestring | null
      • addOnGroupIdstring (uuid)
      • addOnGroupNamestring | null
      • freeAmountobject | null
        1 field in freeAmount
        • valuenumber (double)
      • positionobject | null
        1 field in position
        • positioninteger (int32)
      • taxesarray<object> | null
        5 fields in taxes
        • idstring (uuid)
        • createdstring (date-time)
        • modifiedstring (date-time)
        • itemIdstring (uuid)
        • taxobject | null
          2 fields in tax
          • taxIdstring (uuid)
          • taxValueobject | null
            2 fields in taxValue
            • typeinteger (int32)

              Allowed values: 1, 2.

            • ratenumber (double)
      • kitchenMessagestring | null
      • addOnGroupLocalizedCustomerFacingNamesobject | null
        1 field in addOnGroupLocalizedCustomerFacingNames
        • translationsmap<string, string> | null
    • attendeeIdstring (uuid) | null
    • autoAcceptboolean
    • hasCourseSupportboolean
400Bad Requestapplication/json
  • messagestring | null
  • errorCodestring (uuid)
  • additionalDataany | null
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)