关于市场

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

市场管理是 Genstore 多国家地区运营的核心组成部分，它提供了完整的多市场信息管理能力。通过该模块，商家可以灵活配置不同国家地区的运营参数，包含主市场、货币、域名、语言、路由、市场标识符（handle）等相关信息，实现本地化的精细运营。

核心概念

市场（Market）：独立运营的区域单元，包含特定的运营配置。
国家地区（Region）：市场服务的目标区域，决定市场的区域化参数。市场与国家地区的关联关系决定了多项重要的本地化配置：
- 货币设置：不同国家地区使用各自的本地货币。
- 汇率管理：支持手动指定与调整汇率。
- 价格策略：可针对不同地区动态调整价格上浮比例。
Handle：市场在系统中的唯一标识符，通常是由小写字母、数字和连字符组成的字符串（如：us-east、europe-west）。
主市场：店铺的默认市场，通常作为其他市场配置的参考基准。
本地化参数：包括市场使用的货币、主语言等区域化配置。

核心功能

查询市场信息：获取市场的基本信息，包括对应国家地区、市场标识符（handle）、名称、货币、主语言、是否主市场等。
创建市场：创建新的市场配置，支持设置基础信息，扩展服务区域范围。
更新市场信息：修改市场的国家地区、名称、主语言、使用货币等基础配置。
删除市场：移除指定市场的所有配置信息。
获取市场列表：批量获取店铺下的市场列表，单次最多返回 250 条记录。
统计市场数量：查询当前店铺的市场总数。

WARNING

市场删除操作会影响客户端访问逻辑，请谨慎操作。
变更市场与国家地区的关联关系会影响商品展示、价格计算、用户访问等多个环节，需要审慎评估。

应用场景

市场信息查询：运营团队可获取市场的基础配置、服务区域、语言货币等信息，确保业务策略与市场设置的一致性。
市场拓展配置：运营团队可创建新市场、设置目标区域和本地化参数，快速开展新地区业务。
多市场数据管理：商家可批量获取市场列表、统计市场数量、监控市场状态，实现高效的多区域运营。

接口

POST /api/202412/market: 创建市场

PUT /api/202412/markets/{marketId}: 更新市场

DELETE /api/202412/markets/{marketId}: 删除市场

GET /api/202412/markets/count: 获取市场数量

GET /api/202412/markets: 查询市场列表

GET /api/202412/markets/{marketId}: 获取市场详情

市场对象

一个市场对象

属性

marketobject

市场信息。

- 收起属性

marketIdnumber

市场的唯一标识，64位数值。

marketNamestring

店铺的名称。

handlestring

一个店铺下唯一的编号，可以由商户编辑。

activeboolean

市场激活状态。

primaryboolean

市场是否是主市场，主市场店铺下唯一。

countryListarray

一组店铺的国家地区编码（2位）。

currencystring

市场的的主货币，采用ISO_4217标准的3位字符。

市场对象

bash

{
  "market": {
    "marketName": "Sun's Shop",
    "active": "true",
    "handle": "AaBbc",
    "currency": "USD",
    "countryList": "["US","CN","JP"]",
    "marketId": "1234567890",
    "primary": "true"
  }
}

`POST` 创建市场

创建市场。

访问范围

需要以下任意访问权限: write_market

接口

POST /api/202412/market

请求参数

marketobject

市场信息。

- 收起属性

marketNamestring

店铺的名称。

handlestring

一个店铺下唯一的编号，可以由商户编辑。

countryListarray

一组店铺的国家地区编码(2位)。

currencystring

市场的的主货币，采用ISO_4217标准的3位字符。

响应数据

marketobject

市场信息。

- 收起属性

marketIdnumber

市场的 ID，64位数值。

marketNamestring

店铺的名称。

handlestring

一个店铺下唯一的编号，可以由商户编辑。

activeboolean

市场激活状态。

primaryboolean

市场是否是主市场，主市场店铺下唯一。

countryListarray

一组店铺的国家地区编码（2位）。

currencystring

市场的的主货币，采用ISO_4217标准的3位字符。

POST /api/202412/market

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` 更新市场

修改店铺市场信息。

访问范围

需要以下任意访问权限: write_market

接口

PUT /api/202412/markets/{marketId}

请求参数

marketobject

市场的信息。

- 收起属性

marketIdnumber

市场的ID，64位数值。

marketNamestring

店铺的名称。

handlestring

一个店铺下唯一的编号，可以由商户编辑。

countryListarray

一组店铺的国家地区编码(2位)。

currencystring

市场的的主货币，采用ISO_4217标准的3位字符。

响应数据

marketobject

- 收起属性

marketNamestring

店铺的名称。

handlestring

一个店铺下唯一的编号，可以由商户编辑。

currencystring

市场的的主货币，采用ISO_4217标准的3位字符。

countryListarray

一组店铺的国家地区编码(2位)。

marketIdnumber

市场的ID，64位数值。

PUT /api/202412/markets/{marketId}

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` 删除市场

删除市场。

访问范围

需要以下任意访问权限: write_market

接口

DELETE /api/202412/markets/{marketId}

请求参数

marketIdnumber

市场的 ID。

响应数据

{}

DELETE /api/202412/markets/{marketId}

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` 获取市场数量

获取市场数量。

访问范围

需要以下任意访问权限: read_shops read_market write_market

接口

GET /api/202412/markets/count

请求参数

{}

响应数据

countnumber

市场的数量。

GET /api/202412/markets/count

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` 查询市场列表

查询市场列表。

访问范围

需要以下任意访问权限: read_shops read_market write_market

接口

GET /api/202412/markets

请求参数

{}

响应数据

marketsarray

市场列表。

- 收起属性

marketIdnumber

市场的 ID，64位数值。

marketNamestring

店铺的名称。

handlestring

一个店铺下唯一的编号，可以由商户编辑。

activeboolean

市场激活状态。

primaryboolean

市场是否是主市场，主市场店铺下唯一。

countryListarray

一组店铺的国家地区编码（2位）。

currencystring

市场的的主货币，采用ISO_4217标准的3位字符。

GET /api/202412/markets

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` 获取市场详情

查询指定市场信息。

访问范围

需要以下任意访问权限: read_shops read_market write_market

接口

GET /api/202412/markets/{marketId}

请求参数

marketIdnumber

市场的 ID。

响应数据

marketobject

市场信息。

- 收起属性

marketIdnumber

市场的 ID，64位数值。

marketNamestring

店铺的名称。

handlestring

一个店铺下唯一的编号，可以由商户编辑。

activeboolean

市场激活状态。

primaryboolean

市场是否是主市场，主市场店铺下唯一。

countryListarray

一组店铺的国家地区编码（2位）。

currencystring

市场的的主货币，采用ISO_4217标准的3位字符。

GET /api/202412/markets/{marketId}

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"
  }
}

关于市场

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

核心概念

市场（Market）：独立运营的区域单元，包含特定的运营配置。
国家地区（Region）：市场服务的目标区域，决定市场的区域化参数。市场与国家地区的关联关系决定了多项重要的本地化配置：
- 货币设置：不同国家地区使用各自的本地货币。
- 汇率管理：支持手动指定与调整汇率。
- 价格策略：可针对不同地区动态调整价格上浮比例。
Handle：市场在系统中的唯一标识符，通常是由小写字母、数字和连字符组成的字符串（如：us-east、europe-west）。
主市场：店铺的默认市场，通常作为其他市场配置的参考基准。
本地化参数：包括市场使用的货币、主语言等区域化配置。

核心功能

查询市场信息：获取市场的基本信息，包括对应国家地区、市场标识符（handle）、名称、货币、主语言、是否主市场等。
创建市场：创建新的市场配置，支持设置基础信息，扩展服务区域范围。
更新市场信息：修改市场的国家地区、名称、主语言、使用货币等基础配置。
删除市场：移除指定市场的所有配置信息。
获取市场列表：批量获取店铺下的市场列表，单次最多返回 250 条记录。
统计市场数量：查询当前店铺的市场总数。

WARNING

市场删除操作会影响客户端访问逻辑，请谨慎操作。
变更市场与国家地区的关联关系会影响商品展示、价格计算、用户访问等多个环节，需要审慎评估。

应用场景

市场信息查询：运营团队可获取市场的基础配置、服务区域、语言货币等信息，确保业务策略与市场设置的一致性。
市场拓展配置：运营团队可创建新市场、设置目标区域和本地化参数，快速开展新地区业务。
多市场数据管理：商家可批量获取市场列表、统计市场数量、监控市场状态，实现高效的多区域运营。

市场对象

接口

GET /api/202412/markets/{marketId}

产品

变体

系列

库存

类目

礼品卡

厂商

订单

履约

退货

客户

主题

店铺

市场

翻译

元字段

元字段定义

账户

交易

折扣

授权

消息订阅

关于 市场 ​

市场 对象 ​

属性 ​

POST 创建市场 ​

请求参数

响应数据

PUT 更新市场 ​

请求参数

响应数据

DELETE 删除市场 ​

请求参数

响应数据

GET 获取市场数量 ​

请求参数

响应数据

GET 查询市场列表 ​

请求参数

响应数据

GET 获取市场详情 ​

请求参数

响应数据

关于 市场 ​

市场 对象 ​

属性 ​

POST 创建市场 ​

PUT 更新市场 ​

DELETE 删除市场 ​

GET 获取市场数量 ​

GET 查询市场列表 ​

GET 获取市场详情 ​

关于市场

市场对象

属性

`POST` 创建市场

`PUT` 更新市场

`DELETE` 删除市场

`GET` 获取市场数量

`GET` 查询市场列表

`GET` 获取市场详情

关于市场

市场对象

属性

`POST` 创建市场

`PUT` 更新市场

`DELETE` 删除市场

`GET` 获取市场数量

`GET` 查询市场列表

`GET` 获取市场详情