Skip to main content

Update Store

Update details of an existing store under a merchant account.

When to Use

Use this endpoint when:

  • Store info changes (name, address, contact)
  • Geo-location needs adjusting
  • Settlement account linkage is updated

How to Use

Endpoint
PATCH/v3/store/{store_id}

Step 1: Get the Store ID

Retrieve storeId from Get All Stores or Get Store By ID.

Step 2: Build the Body

Include only the fields you want to change.

Step 3: Send the PATCH Request

Pass storeId as a path parameter — /v3/store/{storeId}.


Request Parameters

Pass storeId as a path parameter.

merchantSettlementIdSTRING

Linkage with payment settlement account

nameSTRINGrequired

Store Name

Example: "REVENUE MONSTER"

addressLine1STRINGrequired

Store Address 1

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

addressLine2STRING

Store Address 2

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

postCodeSTRINGrequired

Postcode of store

Example: "47400"

citySTRINGrequired

City of store

Example: "Petaling Jaya"

stateSTRINGrequired

State of store

Example: "Selangor"

countrySTRINGrequired

Country of store

Example: "Malaysia"

countryCodeSTRINGrequired

Country code of store contact number

Example: "60"

phoneNumberSTRINGrequired

Phone number of store

Example: "377334080"

geoLocationOBJECT

Geo Location (latitude and longitude) of store

Example: {"latitude": 3.1349857, "longitude": 101.6136659 }


Response Parameters

itemOBJECT

Updated store details.

idSTRING

Store ID

Example: "6170506694335521334"

merchantSettlementIdSTRING

Linkage with payment settlement account

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

Geo Location (latitude and longitude) of store

Example: {"latitude": 3.1349857, "longitude": 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"

codeSTRING

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

Example: "SUCCESS"