Get product list

gethttps://core-api.ancon.io/api/v1/Tenants/{tenantId}/Products

Filtering

Filter the list with filter[field]=operator:value; see how filtering works.

Show all 18 filter fields

created (datetime)
name (string)
producttype (enum)
variant.name (string)
description (string)
hasvariants (boolean)
productgroup.id (guid)
productgroup.name (string)
menutree.branchid (guid)
menutree.branchname (string)
course.id (nullable guid)
course.name (string)
course.code (string)
tag.id (guid)
tag.name (string)
tag.type (enum)
availability.systemvisibility (enum)
availability.orderformat (enum flags)

Try filters

Build a filter for this endpoint and copy the request. It also runs against sample data so you can see what matches. How filtering works

Filters

Documented filter fields

Reads asname contains “beef”

Request

?filter[name]=has:beef

Sample products · 3 of 8 match

name	producttype	productgroup.name	hasvariants	created	deleted
Beefburger	0	Burgers	true	2022-09-14 10:12	null
Steak beef 150g	3	Mains	false	2021-06-02 08:00	null
Nice beef sallad	0	Salads	false	2022-11-01 09:30	null
Ceasar sallad	0	Salads	true	2020-12-30 15:45	null
Baconburger 200g	3	Burgers	true	2022-10-26 08:30	null
Lager 50cl	2	Drinks	false	2021-01-01 12:32	null
Mineral water bottle	1	Drinks	false	2022-03-15 11:00	null
Chicken wrap	0	Mains	false	2022-05-20 13:10	2023-01-10 09:00

Made-up rows, not from a real tenant. Filters are applied left to right.

Authorization

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

Path parameters

tenantIdstring (uuid)required

Query parameters

MetaFiltermap<string, array<string>>
Offsetinteger (int32)
Offset the result, defaults to 0
Limitinteger (int32)
Limits how many items to get, defaults to 100 min 0, max 1000.
Orderstring
Order the result.
Searchstring
Filtermap<string, array<string>>
Filter the result. Filter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00

Filter takes filter[field]=operator:value on 18 fields. Build a filter

Header parameters

correlationIdstring
Correlation Id for the request

Responses

200OKapplication/json

itemsarray<object> | null
13 fields in items
- idstring (uuid)
- surrogateIdstring (uuid)
- productTypeinteger (int32)
  Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.
- namestring | null
- descriptionstring | null
- allergyInformationstring | null
- imagestring (uuid) | null
- productGroupobject | null
  2 fields in productGroup
  - idstring (uuid)
  - namestring | null
- mandatoryToPickVariantboolean
- variantsarray<object> | null
  10 fields in variants
  - idstring (uuid)
  - namestring | null
  - isMainProductVariantboolean
  - useBasePriceboolean
  - isOpenPriceboolean
  - 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
  - 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)
  - hasPricePresetsboolean
  - hasPriceOverridesboolean
- outletSharesarray<object> | null
  3 fields in outletShares
  - idstring (uuid)
  - namestring | null
  - productShareTypeinteger (int32)
    Allowed values: 0, 1.
- tagsarray<object> | null
  3 fields in tags
  - idstring (uuid)
  - namestring | null
  - typeinteger (int32)
    Allowed values: 0, 1, 2, 3.
- metadataany | null
metaobject | null
2 fields in meta
- countinteger (int32)
- offsetinteger (int32)

400Bad Requestapplication/json

messagestring | null
errorCodestring (uuid)
additionalDataany | null

401Unauthorizedapplication/json

messagestring | null

404Not Foundapplication/json

messagestring | null
errorCodestring (uuid)

Request

curl -X GET "https://core-api.ancon.io/api/v1/Tenants/{tenantId}/Products" \
  -H "Access-Token: $ANCON_TOKEN"

Response

Generated from the schema; values are placeholders.

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "surrogateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productType": 0,
      "name": "string",
      "description": "string",
      "allergyInformation": "string",
      "image": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productGroup": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "mandatoryToPickVariant": true,
      "variants": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "isMainProductVariant": true,
          "useBasePrice": true,
          "isOpenPrice": true,
          "variantPrice": {
            "unitPrice": {},
            "additionalPrice": {}
          },
          "materialCost": {
            "unitPrice": {},
            "additionalPrice": {}
          },
          "position": 0,
          "hasPricePresets": true,
          "hasPriceOverrides": true
        }
      ],
      "outletShares": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "productShareType": 0
        }
      ],
      "tags": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "type": 0
        }
      ],
      "metadata": null
    }
  ],
  "meta": {
    "count": 0,
    "offset": 0
  }
}

#Filtering

Try filters

#Authorization

#Path parameters

#Query parameters

#Header parameters

#Responses

Filtering

Authorization

Path parameters

Query parameters

Header parameters

Responses