Query Shop

POST/dana/merchant/shop/queryShop.htm

This API is used to obtain information of shop information

API Type

DANA Open API

Expected Timeout

3 second

SNAP Service Code

application/json

Content Type

application/json

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.queryShop

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:= shopIdType is EXTERNAL_ID

shopId

string

Required

Shop identifier.

INNER_ID : 21 max
EXTERNAL_ID: 64 max

shopIdType

string

1 - 11 charactersRequired

Shop identifier type, refer to shopIdType

INNER_ID

string

Shop identifier is generated by DANA

EXTERNAL_ID

string

Shop identifier is provided by merchant

{
    "request": {
       "head": {
          "version": "2.0",
          "function": "dana.merchant.shop.queryShop",
          "clientId": "2014000014442",
          "clientSecret": "2014000014442",
          "reqTime": "2001-07-04T12:08:56+05:30",
          "reqMsgId": "1234567asdfasdf1123fda",
          "reserve": "{}"
       },
       "body": {
          "merchantId": "216622222444445555555",
          "shopId": "2166522222222222",
          "shopIdType": "INNER_ID"
       }
    },
    "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.queryShop

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

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)

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

shopResourceInfo

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:

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

subDistrict

string

1 - 64 characters

Sub district

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

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

subDistrict

string

1 - 64 characters

Sub district

nmid

string

1 - 256 characters

National merchant identifier

 {
    "response": {
       "head": {
          "version":"2.0",
          "function":"dana.merchant.shop.queryShop",
          "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"
          },
          "shopResourceInfo": {
          "merchantId": "216622222444445555555",
          "parentDivisionId": "216622222444445555555",
          "parentRoleType": "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",
          "nmid":"xxxx"
          }
       }
    },
 "signature": "signature string"
 }

ResultStatus	ResultCodeId	ResultCode	ResultMessage	Partner Action
S	00000000	SUCCESS	success	Mark Query Shop process as Success
F	00000004	PARAM_ILLEGAL	parameter illegal	Mark Query Shop process as Failed. Retry request with proper parameter
F	00000900	SYSTEM_ERROR	system error	Mark Query Shop process as Failed. Retry request periodically

Query Shop​

Query Shop