Skip to main content

Get Shop List

POST/dana/merchant/shop/getShopList.htm

This API is used to obtain shop list

API Type
DANA Open API
Expected Timeout
3 second
SNAP Service Code
-
Accept
application/json
Content Type
application/json
This API is used for the following solution:
Shop
A shop refers to a merchant’s actual store or outlet within each division or category. It represents the operational unit where transactions take place and can be managed individually using the DANA API.
version
string
1 - 8 charactersRequired
API version. As per the respective API reference
function
string
1 - 128 charactersRequired
According to specifications defined by each business domain
Value: dana.merchant.shop.getShopList
clientId
string
1 - 36 charactersRequired
Client identifier which provided by DANA and used to identify partner and application system
clientSecret
string
1 - 64 charactersRequired
As a secret key of client. Assigned client secret during registration
reqTime
string
25 charactersRequired
Request time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
reqMsgId
string
1 - 64 charactersRequired
Identify an unique system request. Each request will be assigned with a unique identifier (UUID)
reserve
string
1 - 256 characters
Reserved for future implementation (Key/Value)
merchantId
string
21 charactersConditional
Merchant identifier
Conditional Info
Y:= parentIdType is EXTERNAL_ID
parentId
string
Required
Parent identifier. The length depend on parentIdType:
• INNER_ID: 21 max
• EXTERNAL_ID: 64 max
parentIdType
string
1 - 11 charactersRequired
Parent identifier type, refer to parentIdType
INNER_ID
string
Parent identifier is generated by DANA
EXTERNAL_ID
string
Parent identifier is provided by merchant
pageNum
string
Page number
pageSize
string
Page size
{
    "request": {
        "head": {
          "version": "2.0",
          "function": "dana.merchant.shop.getShopList",
          "clientId": "2014000014442",
          "clientSecret": "2014000014442",
          "reqTime": "2001-07-04T12:08:56+05:30",
          "reqMsgId": "1234567asdfasdf1123fda",
          "reserve": "{}"
        },
        "body": {
          "merchantId": "216622222444445555555",
          "parentId": "2166522222222222",
          "parentIdType": "INNER_ID",
          "pageSize" : "10",
          "pageNum" : "1"
        }
    },
    "signature": "signature string"
}
version
string
1 - 8 charactersRequired
API version. As per the respective API reference
function
string
1 - 128 charactersRequired
According to specifications defined by each business domain
Value: dana.merchant.shop.getShopList
clientId
string
1 - 36 charactersRequired
Client identifier which provided by DANA and used to identify partner and application system
clientSecret
string
1 - 64 charactersRequired
As a secret key of client. Assigned client secret during registration
respTime
string
25 charactersRequired
Response time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
reqMsgId
string
1 - 64 charactersRequired
Identify an unique system request. Each request will be assigned with a unique identifier (UUID)
reserve
string
1 - 256 characters
Reserved for future implementation (Key/Value)
resultInfo
json object
Required
Define the detail of result information
resultStatus
string
1 charactersRequired
Result status, refer to result code list ResultStatus
The status of the request can be:
• S: Success
• F: Failure
• U: Unknown
Can be added if these 3 statuses are insufficient for business requirements
resultCodeId
string
1 - 16 charactersRequired
Result code identifier, refer to result code list ResultCodeId
resultCode
string
1 - 64 charactersRequired
Result code string, refer to ResultCode
resultMsg
string
1 - 256 characters
Result message, refer to result code list ResultMsg
shopResourceInfoList
array of json object
Conditional
Define the detail of shop resource information, refer to shopResourceInfo
Conditional Info
Y:= Successfully processed
shopId
string
21 charactersRequired
Shop identifier
merchantId
string
21 charactersConditional
Merchant identifier
Conditional Info
Y:= Successfully processed
parentDivisionId
string
Parent division identifier. The length depend on parentRoleType: **
• MERCHANT: 21 max
• DIVISION: 21 max
• EXTERNAL_DIVISION:64 max
parentRoleType
string
1 - 17 characters
Type of parent role, refer to parentRoleType
MERCHANT
string
Parent role type is merchant
DIVISION
string
Parent role type is division
EXTERNAL_DIVISION
string
Parent role type is external division
shopDesc
string
1 - 1024 characters
Shop description
mainName
string
1 - 256 charactersRequired
Shop name
sizeType
string
1 - 4 charactersRequired
Size type, refer to sizeType
UMI
string
Usaha Mikro
UKE
string
Usaha Kecil
UME
string
Usaha Menengah
UBE
string
Usaha Besar
URE
string
Usaha Reguler
shopAddress
json object
Shop address, refer to addressInfo
country
string
1 - 64 charactersRequired
Country name
province
string
1 - 64 charactersRequired
Province name
city
string
1 - 64 charactersRequired
City name
area
string
1 - 64 charactersRequired
Area name
address1
string
1 - 256 charactersRequired
Information of address 1
address2
string
1 - 256 charactersRequired
Information of address 2
postcode
string
5 charactersRequired
Postcode
externalShopId
string
1 - 64 characters
External shop identifier
logoUrlMap
array of string
Logo URL, the map keys are:
• LOGO
• PC_LOGO
• MOBILE_LOGO
Notes: The logo’s value is the string which is the image’s data encoded with base64 and image type must PNG format
extInfo
array of string
Extend info, the map keys are:
• LOGO
• PC_LOGO
• MOBILE_LOGO
mccCodes
array of string
1 - 64 characters
Merchant category code, used to identify the type of business in which a merchant is engaged, refer to MCC
ln
string
1 - 10 characters
Longitude of shop’s location
lat
string
1 - 10 characters
Latitude of shop’s location
taxNo
string
15 characters
Tax number (NPWP)
brandName
string
1 - 256 characters
Brand name on legal name or tax name
taxAddress
json object
Tax address, refer to addressInfo
country
string
1 - 64 charactersRequired
Country name
province
string
1 - 64 charactersRequired
Province name
city
string
1 - 64 charactersRequired
City name
area
string
1 - 64 charactersRequired
Area name
address1
string
1 - 256 charactersRequired
Information of address 1
address2
string
1 - 256 charactersRequired
Information of address 2
postcode
string
5 charactersRequired
Postcode
nmid
string
1 - 256 characters
National merchant identifier
pageSize
string
Page size
pageNum
string
Page number
count
string
Number of selected data
hasNext
string
1 - 5 characters
Determine whether the data is on the last page or not. The possible values are true or false
Notes: Will be false if the data on the last page
{
    "response": {
        "head": {
            "version":"2.0",
            "function":"dana.merchant.shop.getShopList",
            "clientId":"211020000000000000044",
            "clientSecret": "2014000014442",
            "respTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body": {
            "resultInfo": {
                "resultStatus": "S",
                "resultCodeId": "00000000",
                "resultCode": "SUCCESS",
                "resultMsg": "success"
            },
            "shopResourceInfoList": [{
                "merchantId": "216622222444445555555",
                "parentDivisionId": "216622222444445555555",
                "shopParentType": "MERCHANT",
                "mainName": "divisionName1",
                "sizeType": "UMI",
                "shopAddress": {
                    "country": "country",
                    "province": "province",
                    "city": "city",
                    "area": "area",
                    "address1": "address1",
                    "address2": "address2",
                    "postcode": "12214"
                },
                "externalShopId": "shop1",
                "logoUrlMap": {
                    "PC_LOGO": "base64ImageCodexxxxxxxxxxx"
                },
                "extInfo": "{}",
                "ln": "106.84513",
                "lat": "-6.21462"
            }],
           "pageSize" : "10",
           "pageNum" : "1",
           "count" : "1",
           "hasNext" : "false"
        }
    },
    "signature": "signature string"
}
ResultStatusResultCodeIdResultCodeResultMessageSolution
S 00000000SUCCESSsuccess
Mark Get Shop List process as Success
F 00000004PARAM_ILLEGALparameter illegal
Mark Get Shop List process as Failed. Retry request with proper parameter
F 00000900SYSTEM_ERRORsystem error
Mark Get Shop List process as Failed. Retry request periodically
ask AIAI Assistant
Need help with our documentation?
Start from our frequently asked questions or feel free to ask anything else.

AI generated responses may contain mistakes.