Core APIProducts

Create product draft

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

Authorization

  • Access-Tokenheaderrequired

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

Path parameters

  • tenantIdstring (uuid)required

Header parameters

  • correlationIdstring

    Correlation Id for the request

Request body application/json

  • productGroupIdstring (uuid)required

    Product group id for this product

  • productOutletIdstring (uuid) | null

    Outlet id this product belongs to

  • namestringrequired

    Name of the product

  • descriptionstring | null

    Description of the product

  • allergyInformationstring | null

    Allergy information for the product if any is available. For example (Contains traces of peanuts)

  • hasVariantsboolean

    True means ths product has more than one variants for example a product named Coca-Cola can have two variants: 33cl, 50cl. False means that there will only be one variant

  • mandatoryToPickVariantboolean

    Gets a value indicating whether if it is mandatory to select variant instead of default selection. This applies only for standard products and when there are more than one variants.

  • autoAcceptboolean

    Gets a value indicating whether auto accept mode is enabled for the product.

  • availableInAllOutletsboolean

    If true will make the product shared with all outlets within the tenant

  • flowViewEnabledboolean

    Gets a value indicating whether the flowview enabled for the product. Default value will be false (which means AccordianView). This should be only applicable to Standard Products and only available in POS.

  • courseIdstring (uuid) | null

    Optional course id this product will have by default when added to a check

Responses

201Createdapplication/json
  • idstring (uuid)
400Bad Requestapplication/json
  • messagestring | null
  • errorCodestring (uuid)
  • additionalDataany | null
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)