Skip to main content
The getSubRetailer method retrieves a list of all sub-retailers loaded on the terminal and shows their current status.

​
Request

JSON-RPC 2.0All methods in TweezerComm follow a JSON-RPC 2.0 structure. See Integration for more details on how the requests are structured and sent.
In the request, ensure to configure the following:
  • The method field must be set to getSubRetailer.
  • The service must be set to ashrait in the params.
{
    "jsonrpc": "2.0",
    "method": "getSubRetailer",
    "params": [
        "ashrait"
    ],
    "id": "123454352"
}

​
Request Parameters

This method doesn’t require any parameters beyond the standard service name.

​
Response

A successful call returns the list of sub-retailers and their status. 
{
    "jsonrpc": "2.0",
    "id": "123454352",
    "result": {
        "statusCode": 0,
        "statusMessage": "OK",
        "subRetailers": [
            {
                "retailerId": "0883806",
                "retailerName": "",
                "isActivated": true,
                "isStartWork": false
            },
            {
                "retailerId": "0884806",
                "retailerName": "",
                "isActivated": true,
                "isStartWork": false
            }
        ]
    }
}

​
Response Parameters

The result object contains the following fields:
NameTypeDescription
statusCodeintegerThe status of the operation. 0 indicates success.
statusMessagestringA message describing the status, such as “OK”.
subRetailersarray of objectsA list containing sub-retailer objects. See table below.

​
Sub-Retailer Object Structure

Each object in the subRetailers array has the following structure:
NameTypeDescription
retailerIdstringThe unique identifier for the sub-retailer.
retailerNamestringThe name of the sub-retailer (may be empty).
isActivatedbooleantrue if the sub-retailer was added to the terminal successfully.
isStartWorkbooleantrue only after a doPeriodic call has been successfully run.