v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Org 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.

get/organization/entities

Query parameters

type'store' | 'zone' | 'till' | 'STR_SERVER' | 'CONCEPT' required

Type of entity to retrieve.

idinteger

Pass an entity id as in the org_entities table (in database) to get the details of that particular entity. For example, ?type=STORE&id=12354309To get the details of multiple entries, pass each ID separating with , . For example, “12859252,12859253”.

scope'STORE_CUSTOM_FIELDS' | 'ZONE_CUSTOM_FIELDS' | 'TILL_CUSTOM_FIELDS'

Pass STORE_CUSTOM_FIELDS or ZONE_CUSTOM_FIELDS to retrieve the list of store level or zone level custom fields.

parent_identifier_type'STORE_CODE' | 'STORE_ID' | 'STORE_EXTERNAL_ID' | 'CONCEPT_CODE' | 'CONCEPT_ID'

Parent entity type to fetch its child entities

parent_identifier_valuestring

Pass the respective identifier value.

include_parentboolean

Pass true to retrieve the details of the parent entity (parent zone or concept). This is applicable only for type zone or concept. Sample - ?type=CONCEPT&id=50995&include_parent=true

sub_entities_countinteger

Limit the number of sub-entities to retrieve for each entity.

details'basic'

Pass basic to see only basic information excluding currency, time-zone, and language information.

exclude_locale'0' | '1'

Pass 1 to exclude time zone details (timezones), 0 to retrieve timezones > base_timezone details of an entity.

start_idinteger

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.

limitinteger

Limit the number of entities to retrieve.

modified_sincestring date

Retrieves the entities that are modified on or after a specific date.

active_onlyboolean

Pass true to retrieve the list of only active stores.

language_translatonsboolean

format'xml' | 'json'

Preferred response format.

Response

200

Example response

{
  "response": {
    "pagination": {
      "limit": "500",
      "offset": "0",
      "total": 1
    },
    "status": {
      "success": true,
      "code": 200,
      "message": "SUCCESS"
    },
    "organization": {
      "entities": {
        "entity": [
          {
            "item_status": {
              "success": "true",
              "code": 3200,
              "message": "Entity search successful"
            },
            "id": "50156992",
            "is_active": "1",
            "code": "new_till",
            "name": "new_till",
            "description": "Testing description",
            "last_updated_by": "50154735",
            "last_updated_on": "2024-06-04 09:03:20",
            "custom_fields": {
              "field": [
                {
                  "name": "cf_1",
                  "value": "15"
                }
              ]
            },
            "time_zone_id": "0",
            "currency_id": "0",
            "language_id": "0",
            "timezones": {
              "base_timezone": {
                "label": "Asia/Kolkata",
                "offset": "+05:30"
              }
            },
            "currencies": {
              "base_currency": {
                "symbol": "₹",
                "label": "INR"
              }
            },
            "language_locale": "IN",
            "languages": {
              "base_language": {
                "locale": "IN"
              }
            },
            "country_code": "IN",
            "username": "new_till",
            "type": "TILL"
          }
        ]
      }
    }
  }
}