developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIAddOnGroups

Get add on group details

gethttps://core-api.ancon.io/api/v1/Tenants/{tenantId}/AddOnGroups/{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
  • addOnGroupobject | null
    9 fields in addOnGroup
    • idstring (uuid)
    • tenantIdstring (uuid)
    • namestring | null

      Name of the add-on group. The name is used to easily identify the group.

    • minimumAmountnumber (double)

      Minimum amount of ingredients from this group you must add to the order. 0 means it has no minimum amount.

    • maximumAmountnumber (double)

      Maximum amount of ingredients from this group you are allowed to add to the order. 0 means it has no maximum amount.

    • allowMultipleboolean

      A value indicating whether to allow multiple of the same ingredients from this group to be added to the order.

    • freeAmountnumber (double)

      Aount of ingredients that will be free of charge from this group. 0 menas it has no free ingredients and the normal ingredient prices will be used.

    • afterFreePriceobject | null

      Price that will be set for all ingredients that exceedes the 'FreeAmount'. If 'FreeAmount' is 0 then this price will not be used.

      2 fields in afterFreePrice
      • amountnumber (double)
      • currencystring | null
    • ingredientsarray<object> | null

      List of of ingredients and their prices.

      6 fields in ingredients
      • idstring (uuid)
      • namestring | null
      • positioninteger (int32)

        Sorting position of the ingredient in the group

      • hasOwnPriceboolean

        Whether the connected ingredient price is overriden for this add-on group. If this is set to false the price from the ingredient will be used.

      • defaultPriceobject | null

        The default price on the ingredient, used if 'HasOwnPrice' is false

        2 fields in defaultPrice
        • amountnumber (double)
        • currencystring | null
      • priceobject | null

        The overriden price for the connected ingredient, used if 'HasOwnPrice' is true

        2 fields in price
        • amountnumber (double)
        • currencystring | null
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)