developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIProducts

Get product details v1.1

gethttps://core-api.ancon.io/api/v1.1/Tenants/{tenantId}/Products/{id}
View .mdOpenAPI

Authorization

  • Access-Tokenheaderrequired

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

Path parameters

  • tenantIdstring (uuid)required
  • idstring (uuid)required

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • productobject | null
    40 fields in product
    • idstring (uuid)
    • createdstring (date-time)
    • modifiedstring (date-time)
    • productTypeinteger (int32)

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

    • namestring | null
    • customerFacingNamestring | null
    • ticketNamestring | null
    • productNumberstring | null
    • descriptionstring | null
    • allergyInformationstring | null
    • imagestring (uuid) | null
    • useAvailabilityHoursboolean
    • hasVariantsboolean
    • mandatoryToPickVariantboolean
    • autoAcceptboolean
    • flowViewEnabledboolean
    • glassesPerBottlenumber (double) | null
    • availableVolumesarray<integer (int32)> | null
    • isSystemProductboolean
    • metaDatamap<string, array<array<array<array>>>> | null
    • productGroupobject | null
      2 fields in productGroup
      • idstring (uuid)
      • namestring | null
    • courseobject | null
      5 fields in course
      • idstring (uuid)
      • namestring | null
      • codestring | null
      • positioninteger (int32)
      • courseGroupIdstring (uuid)
    • variantsarray<object> | null
      15 fields in variants
      • idstring (uuid)
      • namestring | null
      • customerFacingNamestring | null
      • ticketNamestring | null
      • variantTypeinteger (int32)

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

      • isMainProductVariantboolean
      • useBasePriceboolean
      • isOpenPriceboolean
      • variantNumberstring | null
      • variantPriceobject | null
        2 fields in variantPrice
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencystring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencystring | null
      • overridePricesarray<object> | null
        6 fields in overridePrices
        • outletIdstring (uuid) | null
        • priceGroupIdstring (uuid) | null
        • orderFormatinteger (int32)

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

        • outletNamestring | null
        • priceGroupNamestring | null
        • priceobject | null
          2 fields in price
          • unitPriceobject | null
            2 fields in unitPrice
            • amountnumber (double)
            • currencystring | null
          • additionalPriceobject | null
            2 fields in additionalPrice
            • amountnumber (double)
            • currencystring | null
      • materialCostobject | null
        2 fields in materialCost
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencystring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencystring | null
      • positioninteger (int32)
      • outletStocksarray<object> | null
        5 fields in outletStocks
        • stockProductIdstring (uuid)
        • outletIdstring (uuid)
        • productVariantIdstring (uuid)
        • stockCountnumber (double)
        • reorderCountnumber (double)
      • pricePresetsarray<object> | null
        4 fields in pricePresets
        • pricePresetIdstring (uuid)
        • pricePresetNamestring | null
        • priceobject | null
          2 fields in price
          • unitPriceobject | null
            2 fields in unitPrice
            • amountnumber (double)
            • currencystring | null
          • additionalPriceobject | null
            2 fields in additionalPrice
            • amountnumber (double)
            • currencystring | null
        • positioninteger (int32)
    • outletSharesarray<object> | null
      3 fields in outletShares
      • idstring (uuid)
      • namestring | null
      • productShareTypeinteger (int32)

        Allowed values: 0, 1.

    • taxesarray<object> | null
      3 fields in taxes
      • idstring (uuid)
      • taxTypeinteger (int32)

        Allowed values: 1, 2.

      • ratenumber (double)
    • menuTreeItemsarray<object> | null
      3 fields in menuTreeItems
      • idstring (uuid)
      • menuTreeBranchIdstring (uuid)
      • menuTreeBranchNamestring | null
    • productAvailabilitiesarray<object> | null
      2 fields in productAvailabilities
      • systemVisibilityinteger (int32)

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

      • orderFormatinteger (int32)

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

    • availabilityHoursarray<object> | null
      6 fields in availabilityHours
      • idstring (uuid)
      • orderFormatinteger (int32)

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

      • systemVisibilityinteger (int32) | null

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

      • dayOfWeekinteger (int32)

        Allowed values: 0, 1, 2, 4, 8, 16, 31, 32, 64, 96, 127.

      • fromstring (time)
      • durationstring (date-span)
    • ticketDestinationsarray<object> | null
      2 fields in ticketDestinations
      • idstring (uuid)
      • namestring | null
    • addOnGroupsarray<object> | null
      10 fields in addOnGroups
      • idstring (uuid)
      • addOnGroupIdstring (uuid)
      • addOnGroupNamestring | null
      • positioninteger (int32)
      • minimumAmountnumber (double)
      • maximumAmountnumber (double)
      • allowMultipleboolean
      • freeAmountnumber (double)
      • afterFreePriceobject | null
        2 fields in afterFreePrice
        • amountnumber (double)
        • currencystring | null
      • customerFacingNamestring | null
    • upsellGroupsarray<object> | null
      2 fields in upsellGroups
      • idstring (uuid)
      • namestring | null
    • ingredientsarray<object> | null
      7 fields in ingredients
      • idstring (uuid)
      • ingredientIdstring (uuid)
      • ingredientNamestring | null
      • isMandatoryboolean
      • hasReplacementsboolean
      • positioninteger (int32)
      • replacementsarray<object> | null
        8 fields in replacements
        • ingredientIdstring (uuid)
        • ingredientNamestring | null
        • ingredientPricenumber (double)
        • positioninteger (int32)
        • overridePriceboolean
        • pricenumber (double)
        • currencystring | null
        • pricesarray<object> | null
          7 fields in prices
          • outletIdstring (uuid) | null
          • priceGroupIdstring (uuid) | null
          • orderFormatsinteger (int32)

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

          • outletNamestring | null
          • priceGroupNamestring | null
          • orderFormatNamestring | null
          • priceobject | null
            2 fields in price
            • amountnumber (double)
            • currencystring | null
    • productTagsarray<object> | null
      3 fields in productTags
      • idstring (uuid)
      • namestring | null
      • typeinteger (int32)

        Allowed values: 0, 1, 2, 3.

    • productGroupTagsarray<object> | null
      3 fields in productGroupTags
      • idstring (uuid)
      • namestring | null
      • typeinteger (int32)

        Allowed values: 0, 1, 2, 3.

    • subProductsarray<object> | null
      10 fields in subProducts
      • idstring (uuid)
      • productIdstring (uuid)
      • variantIdstring (uuid) | null
      • productNamestring | null
      • useOverridePriceboolean
      • positioninteger (int32)
      • quantitynumber (double)
      • outletSharesarray<string (uuid)> | null
      • taxesarray<object> | null
        3 fields in taxes
        • idstring (uuid)
        • taxTypeinteger (int32)

          Allowed values: 1, 2.

        • ratenumber (double)
      • subProductVariantsarray<object> | null
        4 fields in subProductVariants
        • variantIdstring (uuid)
        • variantNamestring | null
        • priceobject | null
          2 fields in price
          • unitPriceobject | null
            2 fields in unitPrice
            • unitPriceobject | null
            • additionalPriceobject | null
          • materialCostobject | null
            2 fields in materialCost
            • unitPriceobject | null
            • additionalPriceobject | null
        • overridePriceobject | null
          2 fields in overridePrice
          • unitPriceobject | null
            2 fields in unitPrice
            • unitPriceobject | null
            • additionalPriceobject | null
          • materialCostobject | null
            2 fields in materialCost
            • unitPriceobject | null
            • additionalPriceobject | null
    • hasIngredientsboolean
    • hasAddOnGroupsboolean
    • hasUpsellGroupsboolean
    • hasProductTagsboolean
    • hasProductGroupTagsboolean
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)