Skip to main content

Update Shop​

POST/dana/merchant/shop/updateShop.htm

This API is used to update the shop information

API Type
DANA Open API
Expected Timeout
3 second
SNAP Service Code
-
Accept
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.updateShop
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)
shopId
string
Required
Shop identifier. The length depend on shopIdType:
  • INNER_ID : 21 max
  • EXTERNAL_ID: 64 max
merchantId
string
21 charactersRequired
Merchant identifier
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
mainName
string
1 - 256 characters
Shop name
shopAddress
json object
Required
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
shopDesc
string
1 - 1024 characters
Shop description
newExternalShopId
string
1 - 64 characters
New external shop identifier
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]
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
string
1 - 64 characters
Extend information
sizeType
string
1 - 4 characters
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
ln
string
1 - 10 characters
Longitude of shop's location
lat
string
1 - 10 characters
Latitude of shop's location
loyalty
string
1 - 5 characters
Flag for loyalty category. The possible value are true or false
ownerAddress
json object
Conditional
Owner address, refer to addressInfo
Conditional Info
Y:= apiVersion > 2
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
ownerName
json object
Conditional
Owner name, refer to userName
Conditional Info
Y:= apiVersion > 2
firstName
string
1 - 64 charactersRequired
First name
lastName
string
1 - 64 charactersRequired
Last name
ownerPhoneNumber
json object
Conditional
Owner phone number, refer to mobileNoInfo
Conditional Info
Y:= apiVersion > 2
mobileId
string
1 - 32 charactersRequired
Mobile identifier
mobileNo
string
1 - 32 charactersRequired
Mobile phone number
verified
string
1 - 5 charactersRequired
Flag for verified mobile, the possible values are true or false
ownerIdType
string
1 - 8 charactersConditional
Owner identifier type, refer to ownerIdType
KTP
string
Use KTP as an owner identifier
SIM
string
Use SIM as an owner identifier
PASSPORT
string
Use passport as an owner identifier
NIB
string
Use Nomor Induk Berusaha (NIB) as an owner identifier
SIUP
string
Use Surat Izin Usaha Perdagangan (SIUP) as an owner identifier
Conditional Info
Y:= apiVersion > 2
ownerIdNo
string
Conditional
Owner identifier number. The length depend on ownerIdType:
  • KTP: 16
  • SIM: 12-14
  • Passport: 8
  • NIB: >= 13
  • SIUP: Free text
Conditional Info
Y:= apiVersion > 2
deviceNumber
string
Conditional
Device number
Conditional Info
Y:= apiVersion > 2
posNumber
string
Conditional
Pos number
Conditional Info
Y:= apiVersion > 2
apiVersion
string
1 - 8 charactersConditional
API version. As per the respective API reference
Conditional Info
Y:= Need to add new attributes
businessEntity
string
1 - 12 charactersConditional
Business entity, refer to businessEntity
individu
string
Business is individual
pt
string
Business entity is Perseroan Terbatas (PT)
cv
string
Business entity is Commanditaire Vennootschap/Persekutuan Komanditer (CV)
yayasan
string
Business entity is foundation
usaha_dagang
string
Business entity is market
koperasi
string
Business entity is Koperasi
Conditional Info
Y:= apiVersion > 2
shopOwning
string
1 - 12 charactersConditional
Shop owning information, refer to shopOwning
DIRECT OWNED
string
Shop is owned by direct owner
FRANCHISED
string
Shop is owned by franchise
Conditional Info
Y:= apiVersion > 2
shopBizType
string
1 - 6 characters
Shop business type, refer to shopBizType
OFFLINE
string
Shop location is offline
ONLINE
string
Shop location is online
businessDocs
array of json object
Conditional
Business document, refer to businessDoc.
Notes:
  • BusinessEntity individu can only use businessDoc.docType KTP and SIM
  • Other BusinessEntity can only use SIUP and 'NIB'
Conditional Info
Y:= apiVersion > 2
docType
string
1 - 8 charactersRequired
Business document type, refer to
KTP
string
Use KTP as an owner identifier
SIM
string
Use SIM as an owner identifier
PASSPORT
string
Use passport as an owner identifier
NIB
string
Use Nomor Induk Berusaha (NIB) as an owner identifier
SIUP
string
Use Surat Izin Usaha Perdagangan (SIUP) as an owner identifier
docId
string
Required
Business document identifier number. The length depend on docType:
  • KTP: 16
  • SIM:12-14
  • Passport:8
  • NIB: >= 13
  • SIUP: Free text
docFile
string (base64)
Required
Business document file in base64 String, accepted file extensions: PDF, GIF, PNG
businessEndDate
string
1 - 10 charactersConditional
Business end date, in format YYYY-MM-dd
Conditional Info
Y:= apiVersion > 2
taxNo
string
15 characters
Tax number (NPWP)
taxAddress
json object
1 - 256 characters
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
brandName
string
1 - 256 characters
Brand name on legal name or tax name
directorPics
array of json object
Conditional
Director as a PIC of shop, refer to businessPic
Conditional Info
Y:= apiVersion > 2
picName
string
1 - 64 charactersRequired
Business PIC name
picPosition
string
1 - 64 charactersRequired
Business PIC position
nonDirectorPics
array of json object
Conditional
Non director which become an PIC of shop, refer to businessPic
Conditional Info
Y:= apiVersion > 2
picName
string
1 - 64 charactersRequired
Business PIC name
picPosition
string
1 - 64 charactersRequired
Business PIC position
{
    "request":{
       "head":{
          "version":"2.0",
          "function":"dana.merchant.shop.updateShop",
          "clientId":"2014000014442",
          "clientSecret":"2014000014442",
          "reqTime":"2001-07-04T12:08:56+05:30",
          "reqMsgId":"1234567asdfasdf1123fda",
          "reserve":"{}"
       },
       "body":{
          "shopId":"216662222444445555123",
          "merchantId":"216622222444445555555",
          "shopIdType":"INNER_ID",
          "mainName":"divisionName1",
          "shopAddress":{
             "country":"country",
             "province":"province",
             "city":"city",
             "area":"area",
             "address1":"address1",
             "address2":"address2",
             "postcode":"postcode",
             "subDistrict":"subDistrict"
          },
          "shopDesc":"description",
          "newExternalShopId":"shop1",
          "mccCodes":[
             "0783"
          ],
          "logoUrlMap":{
             "PC_LOGO":"base64ImageCodexxxxxxxxxxx"
          },
          "extInfo":{

          },
          "sizeType":"UMI",
          "ln":"106.84513",
          "lat":"-6.21462",
          "loyalty":"true",
          "ownerAddress":{
             "country":"country",
             "province":"province",
             "city":"city",
             "area":"area",
             "address1":"address1",
             "address2":"address2",
             "postcode":"postcode",
             "subDistrict":"subDistrict"
          },
          "ownerName":{
             "firstName":"Jane",
             "lastName":"Doe"
          },
          "ownerPhoneNumber":{
             "mobileNo":"62800000000",
             "mobileId":"mobileId",
             "verified":"true"
          },
          "ownerIdType":"KTP",
          "ownerIdNo":"3172010000000000",
          "deviceNumber":"0",
          "posNumber":"0",
          "apiVersion":"3",
          "businessEntity":"individu",
          "shopOwning":"DIRECT_OWNED",
          "shopBizType":"ONLINE",
          "businessDocs":[
          {
             "docType":"KTP",
             "docId":"3172010000000000",
             "docFile":"stringbase64value"
          }
          ],
          "businessEndDate":"2021-05-26",
          "taxNo":"123456789012345",
          "taxAddress":{
             "country":"Indonesia",
             "province":"DKI Jakarta",
             "city":"Jakarta",
             "area":"area",
             "address1":"address1",
             "address2":"address2",
             "postcode":"14123"
          },
          "brandName":"XXX",
          "directorPics":[
          {
             "picName":"Agus",
             "picPosition":"DIRECTOR_FINANCE"
          }
          ],
          "nonDirectorPics":[
          {
             "picName":"Budi",
             "picPosition":"OPERATION"
          }
          ]
       }
    },
    "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.updateShop
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
 {
    "response":{
       "head":{
          "version":"2.0",
          "function":"dana.merchant.shop.updateShop",
          "clientId":"211020000000000000044",
          "clientSecret": "2014000014442",
          "respTime":"2022-03-22T14:45:43+07:00",
          "reqMsgId":"1234567asdfasdf1123fda",
          "reserve":"{}"
       },
       "body":{
          "resultInfo":{
             "resultStatus":"S",
             "resultCodeId":"00000000",
             "resultCode":"SUCCESS",
             "resultMsg":"success"
          }
       }
    },
    "signature":"signature string"
 }
ResultStatusResultCodeIdResultCodeResultMessagePartner Action
S 00000000SUCCESSsuccess
Mark Update Shop process as Success
F 00000004PARAM_ILLEGALparameter illegal
Mark Update Shop process as Failed. Retry request with proper parameter
F 00000900SYSTEM_ERRORsystem error
Mark Update Shop process as Failed. Retry request periodically
F 00000004SHOP_NOT_EXISTshop not exist
Mark Update Shop process as Failed. Retry request with proper parameter
F 00000900PARENT_ID_NOT_EXISTparent id not exist
Mark Update Shop process as Failed. Retry request with proper parameter or can contact to DANA to check parent division configuration