Get add on group list

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

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
3 fields in items
- idstring (uuid)
- namestring | 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}/AddOnGroups" \
  -H "Access-Token: $ANCON_TOKEN"

Response

{
  "items": [
    {
      "id": "a8c48abf-fa9f-4a33-a3b9-e9f15009e369",
      "name": "Add on group model name 1",
      "outletShares": [
        {
          "id": "3a4085cc-a775-4615-ac45-f552ccdfe120",
          "name": "Outlet 1",
          "productShareType": 0
        },
        {
          "id": "5f51ecf9-ca08-40aa-9ce0-434421774f59",
          "name": "Outlet 2",
          "productShareType": 0
        }
      ]
    },
    {
      "id": "1a7c6607-d1bc-426b-8759-efbdffb98637",
      "name": "Add on group model name 2",
      "outletShares": [
        {
          "id": "090aeb40-c482-4c6b-88c4-89dedc17b8e7",
          "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