English

简体中文

English

简体中文

Appearance

About Market ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Market management enables multi-regional operations in Genstore. It provides tools to configure region-specific parameters including primary market, currency, domain, language, routing, market identifier (handle), and other related information to achieve precise localization.

Core Concepts

Market: An independent operational unit containing specific operational configurations.

Region: The target area served by the market, determining regional parameters. The association between markets and regions defines several important localization configurations:

  • Currency Settings: Different regions use their respective local currencies.
  • Exchange Rate Management: Supports manual specification and adjustment of exchange rates.
  • Pricing Strategy: Allows dynamic price adjustments for different regions.

Handle: A unique identifier for markets in the system, typically composed of lowercase letters, numbers, and hyphens (e.g., us-east, europe-west).

Primary Market: The store's default market, typically serving as a reference baseline for other market configurations.

Localization Parameters: Include market currency, primary language, and other regional configurations.4

Core Features

  • Query Market Information: Retrieve market basic information, including associated regions, market identifier (handle), name, currency, primary language, primary market status, etc.
  • Create Market: Create new market configurations, supporting basic information setup to expand service area coverage.
  • Update Market Information: Modify market regions, names, primary language, currency, and other basic configurations.
  • Delete Market: Remove all configurations for a specified market.
  • Get Market List: Batch retrieve store market list, maximum 250 records per request.
  • Count Markets: Query the total number of markets in the current store.

WARNING

  • Market deletion affects client access logic, please operate with caution.

  • Changes to market-region associations affect product display, price calculation, user access, and other aspects, requiring careful evaluation.

Use Cases

  • Market Information Query: Operations teams can retrieve market basic configurations, service areas, language and currency settings to ensure business strategy alignment with market settings.
  • Market Expansion Configuration: Operations teams can create new markets, set target regions and localization parameters for rapid business expansion into new areas.
  • Multi-Market Data Management: Merchants can batch retrieve market lists, count markets, and monitor market status to achieve efficient multi-regional operations.

Endpoints

POST /api/202412/market: Create market

PUT /api/202412/markets/{marketId}: Update market

DELETE /api/202412/markets/{marketId}: Delete market

GET /api/202412/markets/count: Get market count

GET /api/202412/markets: Get market list

GET /api/202412/markets/{marketId}: Get market details

Market Object ​

A market Object

Properties ​

marketobject
The market information.
- Hide child properties
marketIdnumber
The ID for the shop market. A 64-bit integer.
marketNamestring
The name of the shop market.
handlestring
A unique identifier for the market. This is changeable by the merchant.
activeboolean
Activation status of the market.
primaryboolean
Is the market the main market and the only one under the shop can be primary.
countryListarray
The country - region code (2 letters) of a group of stores.
currencystring
The main currency of the shop market adopts the three-character code in accordance with the ISO 4217 standard.
bash
{
  "market": {
    "marketName": "Sun's Shop",
    "active": "true",
    "handle": "AaBbc",
    "currency": "USD",
    "countryList": "["US","CN","JP"]",
    "marketId": "1234567890",
    "primary": "true"
  }
}

POST Create market ​

Create shop market.

Access scope

Requires ANY of the following access scopes: write_market

Endpoint

POST /api/202412/market 

Request Params

marketobject
The market information.
- Hide child properties
marketNamestring
The name of the shop market.
handlestring
A unique identifier for the market. This is changeable by the merchant.
countryListarray
The country - region code (2 letters) of a group of stores.
currencystring
The main currency of the shop market adopts the three-character code in accordance with the ISO 4217 standard.

Response Data

marketobject
The market information.
- Hide child properties
marketIdnumber
The ID for the shop market. A 64-bit integer.
marketNamestring
The name of the shop market.
handlestring
A unique identifier for the market. This is changeable by the merchant.
activeboolean
Activation status of the market.
primaryboolean
Is the market the main market and the only one under the shop can be primary.
countryListarray
The country - region code (2 letters) of a group of stores.
currencystring
The main currency of the shop market adopts the three-character code in accordance with the ISO 4217 standard.
bash
curl -X POST \ 
https://{shop}.genmystore.com/api/202412/market" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"market":{
		"marketName":"Sun's Shop",
		"handle":"AaBbc",
		"currency":"USD",
		"countryList":"[\"US\",\"CN\",\"JP\"]"
	}
}'
json
HTTP/1.1 200 OK
{
  "market": {
    "marketName": "Sun's Shop",
    "active": "true",
    "handle": "AaBbc",
    "currency": "USD",
    "countryList": "[\"US\",\"CN\",\"JP\"]",
    "marketId": "1234567890",
    "primary": "true"
  }
}

PUT Update market ​

Update shop market information.

Access scope

Requires ANY of the following access scopes: write_market

Endpoint

PUT /api/202412/markets/{marketId} 

Request Params

marketobject
The market data.
- Hide child properties
marketIdnumber
The ID for the shop market, A 64-bit integer.
marketNamestring
The name of the shop market.
handlestring
A unique identifier for the market. This is changeable by the merchant.
countryListarray
The country - region code (2 letters) of a group of stores.
currencystring
The main currency of the shop market adopts the three-character code in accordance with the ISO 4217 standard.

Response Data

marketobject
- Hide child properties
marketNamestring
The name of the shop market.
handlestring
A unique identifier for the market. This is changeable by the merchant.
currencystring
The main currency of the shop market adopts the three-character code in accordance with the ISO 4217 standard.
countryListarray
The country - region code (2 letters) of a group of stores.
marketIdnumber
The ID for the shop market, A 64-bit integer.
bash
curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/markets/{marketId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"market":{
		"marketName":"Sun's Shop",
		"handle":"AaBbc",
		"currency":"USD",
		"countryList":"[\"US\",\"CN\",\"JP\"]",
		"marketId":"1234567890"
	}
}'
json
HTTP/1.1 200 OK
{
  "market": {
    "marketName": "Sun's Shop",
    "handle": "AaBbc",
    "currency": "USD",
    "countryList": "[\"US\",\"CN\",\"JP\"]",
    "marketId": "1234567890"
  }
}

DELETE Delete market ​

Delete shop market.

Access scope

Requires ANY of the following access scopes: write_market

Endpoint

DELETE /api/202412/markets/{marketId} 

Request Params

marketIdnumber
The market ID.

Response Data

{}
bash
curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/markets/{marketId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{}

GET Get market count ​

Get shop market count.

Access scope

Requires ANY of the following access scopes: read_shops read_market write_market

Endpoint

GET /api/202412/markets/count 

Request Params

{}

Response Data

countnumber
Counts of the shop markets.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/markets/count" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "count": "10"
}

GET Get market list ​

Get the market list.

Access scope

Requires ANY of the following access scopes: read_shops read_market write_market

Endpoint

GET /api/202412/markets 

Request Params

{}

Response Data

marketsarray
The market list.
- Hide child properties
marketIdnumber
The ID for the shop market. A 64-bit integer.
marketNamestring
The name of the shop market.
handlestring
A unique identifier for the market. This is changeable by the merchant.
activeboolean
Activation status of the market.
primaryboolean
Is the market the main market and the only one under the shop can be primary.
countryListarray
The country - region code (2 letters) of a group of stores.
currencystring
The main currency of the shop market adopts the three-character code in accordance with the ISO 4217 standard.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/markets" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "markets": [
    {
      "marketName": "Sun's Shop",
      "active": "true",
      "handle": "AaBbc",
      "currency": "USD",
      "countryList": "[\"US\",\"CN\",\"JP\"]",
      "marketId": "1234567890",
      "primary": "true"
    }
  ]
}

GET Get market details ​

Query the information of the specified market.

Access scope

Requires ANY of the following access scopes: read_shops read_market write_market

Endpoint

GET /api/202412/markets/{marketId} 

Request Params

marketIdnumber
The market ID.

Response Data

marketobject
The market information.
- Hide child properties
marketIdnumber
The ID for the shop market. A 64-bit integer.
marketNamestring
The name of the shop market.
handlestring
A unique identifier for the market. This is changeable by the merchant.
activeboolean
Activation status of the market.
primaryboolean
Is the market the main market and the only one under the shop can be primary.
countryListarray
The country - region code (2 letters) of a group of stores.
currencystring
The main currency of the shop market adopts the three-character code in accordance with the ISO 4217 standard.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/markets/{marketId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "market": {
    "marketName": "Sun's Shop",
    "active": "true",
    "handle": "AaBbc",
    "currency": "USD",
    "countryList": "[\"US\",\"CN\",\"JP\"]",
    "marketId": "1234567890",
    "primary": "true"
  }
}