Get All Stores
Retrieve all stores belonging to the authenticated merchant.
When to Use
▾
Use this endpoint when you:
- List every store the merchant operates
- Build a store picker in your dashboard
- Need pagination over merchants with many stores
Append ?cursor=<cursor> to paginate large result sets.
How to Use
▾
/v3/storesStep 1: Authenticate
▾
Obtain a valid accessToken for the merchant.
Step 2: Send the GET Request
▾
No request body required. Add ?cursor=<cursor> query string for paginated reads.
Step 3: Iterate items
▾
itemsThe response items array holds each store record. The meta object reports counts and the next cursor.
Request Parameters
▾
No request body. Authenticated headers only.
Response Parameters
▾
Array of store object
Store ID
Example: "6170506694335521334"
Merchant Settlement ID
Example: ""
Store Name
Example: "REVENUE MONSTER"
Store image URL
Example: "https://storage.googleapis.com/rm-prod-asset/img/store.png"
Store Address 1
Example: "B-5-30, 5th Floor, Block Bougainvillea,"
Store Address 2
Example: "PJU 6A, Lebuhraya SPRINT, 10 Boulevard,"
Postcode of store
Example: "47400"
City of store
Example: "Petaling Jaya"
State of store
Example: "Selangor"
Country of store
Example: "Malaysia"
Country code of store contact number
Example: "60"
Phone number of store
Example: "377334080"
Geo Location (latitude and longitude) of store
Example: {"Lat": 3.1349857, "Lng": 101.6136659 }
Current status of store
Example: "ACTIVE"
Default store of merchant (first store created upon signup)
Example: true
Creation date time of store
Example: "2018-02-12T08:53:13Z"
Last update date time of store
Example: "2018-02-12T08:53:13Z"
Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)
Example: "SUCCESS"
Database object
Current page record
Example: 1
Total record in database
Example: 1
Optional, if pagination exists.
Example: 1