Get outlet list

gethttps://core-api.ancon.io/api/v1/Tenants/Outlets

View .md OpenAPI

Filtering

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

created (datetime)
name (string)
businessnumber (string)

Try filters

Build a filter for this endpoint and copy the request. How filtering works

Filters

Documented filter fields

Reads asNo filters: the endpoint returns everything (paged).

Request

(no filters)

No sample data for this endpoint; the request above is what you would send.

Authorization

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

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

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

Header parameters

correlationIdstring
Correlation Id for the request

Responses

200OKapplication/json

itemsarray<object> | null
2 fields in items
- idstring (uuid)
- namestring | 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/Outlets" \
  -H "Access-Token: $ANCON_TOKEN"

Response

Generated from the schema; values are placeholders.

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  ],
  "meta": {
    "count": 0,
    "offset": 0
  }
}

#Filtering

Try filters

#Authorization

#Query parameters

#Header parameters

#Responses

Filtering

Authorization

Query parameters

Header parameters

Responses