To get child entities

https://{{host}}/v1.1/organization/entities?type={type}&parent_identifier_type={parent_type}&parent_identifier_value={identifier_value}

Request parameter

Parameter	Description
type*	Pass the entity type to retrieve. Value: STORE, STR_SERVER (store server), TILL, ZONE, CONCEPT. Pass example, pass STORE to retrieve store details.
scope	Pass STORE_CUSTOM_FIELDS or ZONE_CUSTOM_FIELDS to retrieve the list of store level or zone level custom fields.
id	Pass an entity id as in the org_entities table (in database) to get the details of that particular entity.
parent_identifier_type	Parent entity type to fetch its child entities. Values: STORE_CODE, STORE_ID, STORE_EXTERNAL_ID, CONCEPT_CODE, CONCEPT_ID.
parent_identifier_value	Pass the respective identifier value. For example, parent_identifier_type=CONCEPT_CODE&parent_identifier_value=supermarket.
include_parent	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	Limit the number of sub-entities to retrieve for each entity.
details	Pass basic to see only basic information excluding currency, time-zone, and language information.
exclude_locale	Pass 1 to exclude time zone details (timezones), 0 to retrieve timezones > base_timezone details of an entity. Default value is 0.
start_id	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	Limit the number of entities to retrieve. Default value is 500.
modified_since	Retrieves the entities that are modified on or after a specific date. Pass the date in YYYY-MM-DD format.
active_only	Pass true to retrieve the list of only active stores.

Response parameter

Parameter	Description
limit	Maximum number of items returned per page.
offset	Offset for the starting record of the result.
total	Total number of entities found.
success	Indicates if the request was successful.
code	Status code for the response.
message	Message describing the status of the request.
id	Unique identifier for the store.
is_active	Indicates if the store is active (1 = Yes).
code	Code representing the store.
name	Name of the store.
description	Description of the store.
last_updated_by	Identifier of the user who last updated the entity.
last_updated_on	Date and time when the entity was last updated.
custom_fields.field	Custom fields associated with the entity. Each field contains name and value.
time_zone_id	Identifier for the store's timezone.
currency_id	Identifier for the store's currency.
language_id	Identifier for the store's language.
label	Label for the base timezone of the store.
offset	Offset for the base timezone of the store.
symbol	Symbol for the base currency of the store.
label	Label for the base currency of the store.
language_code	Code representing the store's language.
language_locale	Locale associated with the store's language.
base_language.lang	Base language of the store.
base_language.locale	Locale of the base language of the store.
external_id	External identifier for the store.
external_id_1	Additional external identifier for the store.
external_id_2	Another additional external identifier for the store.
mobile	Mobile number associated with the store.
channel	Channel where the store operates (e.g., instore).
land_line	Landline number associated with the store.
email	Email address associated with the store.
address	Address of the store.
latitude	Latitude coordinate of the store's location.
longitude	Longitude coordinate of the store's location.
type	Type of the entity (e.g., STORE).