Get All Stores

GET/v3/stores

Get Store By ID

• To query for ALL stores under a merchant.

• To implement a pagination cursor, you may use query string: ~/?cursor= < cursor >_

Request Parameters:

No request parameter is required for this endpoint.

Response Parameters

itemsObject[]

Array of store object

Example: (Refer to explanation below)

codeString

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"

metaObject

Database object

Example: (Refer to explanation below)

Array of store object (items):

idString

Store ID

Example: "6170506694335521334"

nameString

Store Name

Example: "REVENUE MONSTER"

addressLine1String

Store Address 1

Example: "B-5-30, 5th Floor, Block Bougainvillea,"

addressLine2String

Store Address 2

Example: "PJU 6A, Lebuhraya SPRINT, 10 Boulevard,"

postCodeString

Postcode of store

Example: "47400"

cityString

City of store

Example: "Petaling Jaya"

stateString

State of store

Example: "Selangor"

countryString

Country of store

Example: "Malaysia"

countryCodeString

Country code of store contact number

Example: "60"

phoneNumberString

Phone number of store

Example: "377334080"

geoLocationObject of [Float]

Geo Location (latitude and longitude) of store

Example: {"Lat": 3.1349857, "Lng": 101.6136659 }

statusString

Current status of store

Example: "ACTIVE"

isDefaultString

Default store of merchant (first store created upon signup)

Example: true

createdAtDateTime

Creation date time of store

Example: "2018-02-12T08:53:13Z"

updatedAtDateTime

Last update date time of store

Example: "2018-02-12T08:53:13Z"

Database object (meta):

countUint

Current page record

Example: 1

totalUint

Total record in database

Example: 1

cursorUint

Optional, if pagination exists.

Example: 1