get
https://{host}/v1.1/organization/entities
Retrieves the details of zones, stores, store servers, concepts or TILLs configured for the current organization. By default, it fetches up to 200 entities.
Example request
curl --location --request GET 'https://eu.api.capillarytech.com/v1.1/organization/entities?type=CONCEPT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic b3NzViOTY0YjA3MTUyZDIzNGI3MA==' \
--header 'Cookie: _cfuvid=5xRIvZNGebysflcCPUIerxXfddTPPCVLZ1_rpjmFeUA-1764931787098-0.0.1.1-604800000' \
--data '[
{
"code": "BRANDNee005",
"name": "Brand Nee",
"description": "First brand"
},
{
"code": "BRANDNee004",
"name": "Brand Nee2"
}
]'Request parameter
| Parameter | Type | Description |
|---|---|---|
| type* | Enum | Pass the entity type of which you want to retrieve the details. Value: STORE, STR_SERVER (store server), TILL, ZONE, CONCEPT. Pass example, pass STORE to retrieve store details. The maximum number of stores that can be fetched at once is 500. |
| scope | Enum | Pass STORE_CUSTOM_FIELDS or ZONE_CUSTOM_FIELDS to retrieve the list of store level or zone level custom fields. TILL_CUSTOM_FIELDS - To retrieve details of till specific custom fields. |
| id | long | Pass an entity id as in the org_entities table (in database) to get the details of that particular entity. |
| parent_identifier_type | enum | Parent entity type to fetch its child entities. Values: STORE_CODE, STORE_ID, STORE_EXTERNAL_ID, CONCEPT_CODE, CONCEPT_ID. |
| parent_identifier_value | string | Pass the respective identifier value. For example, parent_identifier_type=CONCEPT_CODE&parent_identifier_value=supermarket. |
| include_parent | boolean | Pass true to retrieve the details of the parent entity (parent zone or concept). This is applicable only for type zone or concept. |
| sub_entities_count | int | Limit the number of sub-entities to retrieve for each entity. |
| details | enum | Pass basic to see only basic information excluding currency, time-zone, and language information. |
| exclude_locale | boolean | Pass 1 to exclude time zone details (timezones), 0 to retrieve timezones > base_timezone details of an entity. Default value is 0. |
| start_id | long | Fetches entities that are above the offset number you pass. Offset is the position of the entity in the db record. The value is assigned based on the sequence of creation. For example, start_id=10 retrieves all the entities from record number 11. |
| limit | int | Limit the number of entities to retrieve. Default value is 500. |
| modified_since | date | Retrieves the entities that are modified on or after a specific date. Pass the date in YYYY-MM-DD format. |
| active_only | boolean | Pass true to retrieve the list of only active stores. |
Response parameter
{
"response": {
"pagination": {
"limit": "500",
"offset": "0",
"total": 30
},
"status": {
"success": true,
"code": 200,
"message": "SUCCESS"
},
"organization": {
"entities": {
"entity": [
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "50662920",
"is_active": "0",
"reference_id": "-1",
"code": "autoconcept1667890152",
"name": "autoconcept1667890152",
"description": "autoconcept1667890152",
"last_updated_by": "15000449",
"last_updated_on": "2022-11-08 12:19:14",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041271",
"is_active": "0",
"reference_id": "-1",
"code": "na_concept",
"name": "na concept",
"description": "concept from UI",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-07 21:07:37",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041265",
"is_active": "1",
"reference_id": "-1",
"code": "root",
"name": "ROOT",
"description": "This Is The Auto Generated Root Concept",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-07 21:07:13",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "50662931",
"is_active": "0",
"reference_id": "-1",
"code": "autoconcept1667890433",
"name": "autoconcept1667890433",
"description": "autoconcept1667890433",
"last_updated_by": "15000449",
"last_updated_on": "2022-11-08 12:23:55",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041349",
"is_active": "0",
"reference_id": "-1",
"code": "concepts936002",
"name": "modifiedConcepts yilci",
"description": "Concepts bgppkazxmx",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:41:47",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041348",
"is_active": "0",
"reference_id": "-1",
"code": "concepts761972",
"name": "Concepts uarkz",
"description": "Concepts ehimuujfon",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:39:08",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "50662887",
"is_active": "0",
"reference_id": "-1",
"code": "autoconcept1667889782",
"name": "autoconcept1667889782",
"description": "autoconcept1667889782",
"last_updated_by": "15000449",
"last_updated_on": "2022-11-08 12:13:04",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041351",
"is_active": "0",
"reference_id": "-1",
"code": "concepts51739",
"name": "Concepts wnbgp",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041357",
"is_active": "0",
"reference_id": "-1",
"code": "concepts650592",
"name": "Concepts lpnjs",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041356",
"is_active": "0",
"reference_id": "-1",
"code": "concepts917095",
"name": "Concepts elpgs",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041359",
"is_active": "0",
"reference_id": "-1",
"code": "concepts974456",
"name": "Concepts beyjs",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041358",
"is_active": "0",
"reference_id": "-1",
"code": "concepts195638",
"name": "Concepts vzkjh",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041353",
"is_active": "0",
"reference_id": "-1",
"code": "concepts765983",
"name": "Concepts ihyhc",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041352",
"is_active": "0",
"reference_id": "-1",
"code": "concepts355011",
"name": "Concepts iaefg",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041355",
"is_active": "0",
"reference_id": "-1",
"code": "concepts561733",
"name": "Concepts pjpvs",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041354",
"is_active": "0",
"reference_id": "-1",
"code": "concepts515656",
"name": "Concepts wvkps",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041365",
"is_active": "0",
"reference_id": "-1",
"code": "concepts636872",
"name": "Concepts dslpo",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041364",
"is_active": "0",
"reference_id": "-1",
"code": "concepts635746",
"name": "Concepts zhfmd",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041367",
"is_active": "0",
"reference_id": "-1",
"code": "concepts856555",
"name": "Concepts amycs",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041366",
"is_active": "0",
"reference_id": "-1",
"code": "concepts572571",
"name": "Concepts wmheg",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "50027919",
"is_active": "1",
"reference_id": "-1",
"code": "apiconceptone",
"name": "apiconceptone",
"description": "apiconceptone",
"last_updated_by": "15000449",
"last_updated_on": "2021-01-26 10:01:07",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "23",
"language_id": "1",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "₹",
"label": "INR"
}
},
"language_code": "",
"language_locale": "AF",
"languages": {
"base_language": {
"lang": "",
"locale": "AF"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041361",
"is_active": "0",
"reference_id": "-1",
"code": "concepts293557",
"name": "Concepts safzz",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041360",
"is_active": "0",
"reference_id": "-1",
"code": "concepts200147",
"name": "Concepts tfhwm",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041363",
"is_active": "0",
"reference_id": "-1",
"code": "concepts446825",
"name": "Concepts oijjv",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "50662898",
"is_active": "0",
"reference_id": "-1",
"code": "autoconcept1667889890",
"name": "autoconcept1667889890",
"description": "autoconcept1667889890",
"last_updated_by": "15000449",
"last_updated_on": "2022-11-08 12:14:51",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041362",
"is_active": "0",
"reference_id": "-1",
"code": "concepts823588",
"name": "Concepts vzmwo",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "50662909",
"is_active": "0",
"reference_id": "-1",
"code": "autoconcept1667890003",
"name": "autoconcept1667890003",
"description": "autoconcept1667890003",
"last_updated_by": "15000449",
"last_updated_on": "2022-11-08 12:16:44",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041369",
"is_active": "0",
"reference_id": "-1",
"code": "concepts875692",
"name": "Concepts ogmyu",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041368",
"is_active": "0",
"reference_id": "-1",
"code": "concepts702978",
"name": "Concepts rvikc",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
},
{
"item_status": {
"success": "true",
"code": 3200,
"message": "Entity search successful"
},
"id": "15041370",
"is_active": "0",
"reference_id": "-1",
"code": "concepts104377",
"name": "Concepts cdbas",
"description": "Concepts siwyjozukq",
"last_updated_by": "2944978",
"last_updated_on": "2014-07-08 17:45:53",
"custom_fields": {
"field": []
},
"language_translations": {
"field": []
},
"time_zone_id": "0",
"currency_id": "0",
"language_id": "0",
"timezones": {
"base_timezone": {
"label": "Asia/Shanghai",
"offset": "+08:00"
}
},
"currencies": {
"base_currency": {
"symbol": "€",
"label": "EUR"
}
},
"language_code": "",
"language_locale": "CN",
"languages": {
"base_language": {
"lang": "",
"locale": "CN"
}
},
"parent": {},
"level": "",
"type": "CONCEPT"
}
]
}
}
}
}| Parameter | Data Type | Description |
|---|---|---|
| response.pagination.limit | Integer | Maximum number of items returned per page. |
| response.pagination.offset | Integer | Offset for the starting record of the result. |
| response.pagination.total | Integer | Total number of entities found. |
| response.status.success | Boolean | Indicates if the request was successful. |
| response.status.code | Integer | Status code for the response. |
| response.status.message | String | Message describing the status of the request. |
| entity.id | String | Unique identifier for the store. |
| entity.is_active | Boolean | Indicates if the store is active (1 = Yes). |
| entity.code | String | Code representing the store or concept based on the query parameter. |
| entity.name | String | Name of the store. |
| entity.description | String | Description of the store. |
| entity.last_updated_by | String | Identifier of the user who last updated the entity. |
| entity.last_updated_on | String | Date and time when the entity was last updated. |
| entity.custom_fields.field | Object | Custom fields associated with the entity. Each field contains name and value. |
| entity.time_zone_id | String | Identifier for the store's timezone. |
| entity.currency_id | String | Identifier for the store's currency. |
| entity.language_id | String | Identifier for the store's language. |
| entity.timezones.base_timezone.label | String | Label for the base timezone of the store. |
| entity.timezones.base_timezone.offset | String | Offset for the base timezone of the store. |
| entity.currencies.base_currency.symbol | String | Symbol for the base currency of the store. |
| entity.currencies.base_currency.label | String | Label for the base currency of the store. |
| entity.language_code | String | Code representing the store's language. |
| entity.language_locale | String | Locale associated with the store's language. |
| entity.languages.base_language.lang | String | Base language of the store. |
| entity.languages.base_language.locale | String | Locale of the base language of the store. |
| entity.external_id | String | External identifier for the store. |
| entity.external_id_1 | String | Additional external identifier for the store. |
| entity.external_id_2 | String | Another additional external identifier for the store. |
| entity.mobile | String | Mobile number associated with the store. |
| entity.channel | String | Channel where the store operates (e.g., instore). |
| entity.land_line | String | Landline number associated with the store. |
| entity.email | String | Email address associated with the store. |
| entity.address | String | Address of the store. |
| entity.location.latitude | Double | Latitude coordinate of the store's location. |
| entity.location.longitude | Double | Longitude coordinate of the store's location. |
| entity.type | String | Type of the entity (e.g., STORE). |