Get ingredients list

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

View .md OpenAPI

Authorization

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

Path parameters

tenantIdstring (uuid)required

Query parameters

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

Header parameters

correlationIdstring
Correlation Id for the request

Responses

200OKapplication/json

itemsarray<object> | null
4 fields in items
- idstring (uuid)
- namestring | null
- priceobject | null
  2 fields in price
  - amountnumber (double)
  - currencystring | null
- outletSharesarray<object> | null
  3 fields in outletShares
  - idstring (uuid)
  - namestring | null
  - productShareTypeinteger (int32)
    Allowed values: 0, 1.
metaobject | null
2 fields in meta
- countinteger (int32)
- offsetinteger (int32)

401Unauthorizedapplication/json

messagestring | null

404Not Foundapplication/json

messagestring | null
errorCodestring (uuid)

Request

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

Response

{
  "items": [
    {
      "id": "b626e230-3457-443e-a8fc-a980d3ffb3e4",
      "name": "Ingredient 1",
      "price": {
        "amount": 15,
        "currency": "SEK"
      },
      "outletShares": [
        {
          "id": "e7ba80d7-21de-4d48-9727-5ac44f1d61bb",
          "name": "Outlet 1",
          "productShareType": 0
        },
        {
          "id": "d824563a-1daa-4d71-a2b3-06da0c6c4f00",
          "name": "Outlet 2",
          "productShareType": 0
        }
      ]
    },
    {
      "id": "833f4092-d315-41c1-89e5-d02034b73601",
      "name": "Ingredient 2",
      "price": {
        "amount": 10,
        "currency": "SEK"
      },
      "outletShares": [
        {
          "id": "b62067d7-6269-4081-b987-0367e9614141",
          "name": "Outlet 3",
          "productShareType": 1
        }
      ]
    }
  ],
  "meta": {
    "count": 2,
    "offset": 0
  }
}

#Authorization

#Path parameters

#Query parameters

#Header parameters

#Responses

Authorization

Path parameters

Query parameters

Header parameters

Responses