关于店铺

访问范围

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

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

店铺管理是 Genstore 商家运营的基础组成部分，它提供了完整的店铺信息管理能力。通过该模块，商家可以配置店铺的基础信息与地点信息，包含店铺名称、域名、联系电话、地址、时区等相关信息，实现统一的店铺信息管理。

核心功能

查询店铺信息：获取店铺的基础信息，包括店铺名称、访问域名、联系电话等。
查询地点详情：获取单个店铺地点的详细信息。
创建店铺地点：添加新的店铺地点信息。
更新地点信息：编辑已有店铺地点的信息。
删除店铺地点：移除指定的店铺地点信息。
获取地点列表：滚动分页获取店铺地点列表。
统计地点数量：获取当前店铺的地点总数。

应用场景

智能通知管理：商家可基于店铺时区，在合适的时间发送通知和奖励，避免打扰客户，提升客户满意度。
店铺信息配置：运营团队可维护店铺基础信息，确保客户能获取准确的店铺信息。
多地点管理：商家可创建和管理多个店铺地点，实现高效的多店运营。

接口

POST /api/202412/shops/location: 创建仓储地址

PUT /api/202412/shops/locations/{locationId}: 更新仓储地址

PUT /api/202412/shops/brand: 更新店铺品牌信息

PUT /api/202412/shops/info: 更新店铺基本信息

DELETE /api/202412/shops/locations/{locationId}: 删除仓储地址

GET /api/202412/shops/info: 获取店铺基本信息

GET /api/202412/shops/locations/count: 获取仓储地址数量

GET /api/202412/shops/locations/{locationId}: 获取仓储地址详情

GET /api/202412/shops/languages: 获取语言列表

GET /api/202412/shops/locations: 获取地点列表

GET /api/202412/shops/brand: 获取店铺品牌信息

店铺对象

一个店铺对象。

属性

shopobject

表示店铺信息

- 收起属性

shopIdnumber

店铺的唯一标识，64位数值。

shopNamestring

店铺的名称。

domainstring

店铺的域名。

descriptionstring

店铺的简介。

logostring

店铺的Logo，在C端展示。

mailstring

店铺的邮箱地址，可以用此来联系商户。

countrystring

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

currencystring

店铺的主货币，采用ISO_4217标准的3位字符。

timezonestring

店铺的时区。

ianaTimezonestring

店铺的IANA时区。

weightUnitstring

店铺的重量单位，可选值lb、oz、g、kg。

店铺对象

bash

{
  "shop": {
    "country": "US",
    "mail": "name@example.com",
    "timezone": "-4",
    "domain": "online-shop.genstore.com",
    "shopName": "Sun's Shop",
    "description": "This is a test shop descirption",
    "logo": "https://statics.genstore.com/folder/qefadfasdfafwerw.png",
    "currency": "USD",
    "shopId": "1234567890",
    "ianaTimezone": "America/New_York",
    "weightUnit": "kg"
  }
}

`POST` 创建仓储地址

创建仓储地址。

访问范围

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

接口

POST /api/202412/shops/location

请求参数

locationobjectrequired

仓储地址信息。

- 收起属性

locationNamestringrequired

仓储的地址。

countrystringrequired

仓储地址的国家地区编码。

provincestring

仓储地址的省级单位编码。

citystring

仓储地址的市，商户填写。

address1string

仓储地址的街道地址。

address2string

仓储地址的街道的地址。

zipcodestring

邮政编码。

phonestring

联系电话。

latitudestring

仓储的纬度。

longitudestring

仓储的经度。

fulfillmentServiceHandlenumber

履约服务商Handle。注：应用有独立的履约发货能力，需要先创建履约服务商，将履约服务商ID填写到这个地方。履约服务商的地点只创建，不能修改内容。

响应数据

locationobject

仓储地址信息。

- 收起属性

locationNamestringrequired

仓储的地址。

countrystringrequired

仓储地址的国家地区编码。

provincestring

仓储地址的省级单位编码。

citystring

仓储地址的市，商户填写。

address1string

仓储地址的街道地址。

address2string

仓储地址的街道的地址。

zipcodestring

邮政编码。

phonestring

联系电话。

latitudestring

仓储的纬度。

longitudestring

仓储的经度。

locationIdnumberrequired

仓储的ID。

isDefaultbooleanrequired

是否是默认的仓储地址。

stopStatusboolean

此仓储地址是否已经停用。

fulfillmentServiceHandlenumberrequired

履约服务商Handle。

POST /api/202412/shops/location

bash

curl -X POST \ 
https://{shop}.genmystore.com/api/202412/shops/location" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"location":{
		"zipcode":"k1n5t5",
		"country":"US",
		"locationName":"Shanghai warehousing",
		"province":"PN",
		"city":"上海市",
		"address2":"Unit 42",
		"phone":"86-13112341234",
		"address1":"126 York Street",
		"latitude":"36.30556423523153",
		"longitude":"104.48060937499996",
		"fulfillmentServiceHandle":"12333"
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "location": {
    "country": "US",
    "locationName": "Shanghai warehousing",
    "city": "上海市",
    "address2": "Unit 42",
    "address1": "126 York Street",
    "latitude": "36.30556423523153",
    "zipcode": "k1n5t5",
    "isDefault": "true",
    "province": "PN",
    "phone": "86-13112341234",
    "locationId": "1234657809123",
    "stopStatus": "true",
    "longitude": "104.48060937499996",
    "fulfillmentServiceHandle": "12333"
  }
}

`PUT` 更新仓储地址

更新仓储地址。

访问范围

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

接口

PUT /api/202412/shops/locations/{locationId}

请求参数

locationobjectrequired

- 收起属性

locationNamestringrequired

仓储的地址。

countrystring

仓储地址的国家地区编码。

provincestring

仓储地址的省级单位编码。

citystring

仓储地址的市，商户填写。

address1string

仓储地址的街道地址。

address2string

仓储地址的街道的地址。

zipcodestring

邮政编码。

phonestring

联系电话。

latitudestring

仓储的纬度。

longitudestring

仓储的经度。

locationIdnumberrequired

仓储的ID。

响应数据

locationobject

- 收起属性

countrystring

仓储地址的国家地区编码。

locationNamestring

仓储的名字，用于标识。

citystring

仓储地址的市，商户填写。

address2string

仓储地址的街道的地址。

address1string

仓储地址的街道地址。

latitudestring

仓储的纬度。

zipcodestring

邮政编码。

isDefaultboolean

是否是默认的仓储地址。

provincestring

仓储地址的省级单位编码。

phonestring

联系电话。

locationIdnumber

仓储的ID。

stopStatusboolean

此仓储地址是否已经停用。

longitudestring

仓储的经度。

fulfillmentServiceHandlenumber

履约服务商Handle。

PUT /api/202412/shops/locations/{locationId}

bash

curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/shops/locations/{locationId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"location":{
		"zipcode":"k1n5t5",
		"country":"US",
		"locationName":"Shanghai warehousing",
		"province":"PN",
		"city":"上海市",
		"address2":"Unit 42",
		"phone":"86-13112341234",
		"address1":"126 York Street",
		"locationId":"12345",
		"latitude":"36.30556423523153",
		"longitude":"104.48060937499996"
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "location": {
    "country": "CN",
    "locationName": "Shanghai warehousing",
    "city": "上海市",
    "address2": "Unit 42",
    "address1": "126 York Street",
    "latitude": "36.30556423523153",
    "zipcode": "k1n5t5",
    "isDefault": "true",
    "province": "PN",
    "phone": "86-13112341234",
    "locationId": "1234657809123",
    "stopStatus": "true",
    "longitude": "104.48060937499996",
    "fulfillmentServiceHandle": "12333"
  }
}

`PUT` 更新店铺品牌信息

更新店铺品牌信息

访问范围

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

接口

PUT /api/202412/shops/brand

请求参数

brandobjectrequired

品牌

- 收起属性

defaultLogostring

默认logo

squareLogostring

方形logo

primaryColorsarray

主色

+ 展开属性

secondaryColorsarray

辅助色

+ 展开属性

socialMediasarray

社媒分享链接

+ 展开属性

响应数据

brandobjectrequired

品牌

- 收起属性

defaultLogostring

默认logo

squareLogostring

方形logo

primaryColorsarray

主色

+ 展开属性

secondaryColorsarray

辅助色

+ 展开属性

socialMediasarray

社媒分享链接

+ 展开属性

PUT /api/202412/shops/brand

bash

curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/shops/brand" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"brand":{
		"secondaryColors":[
			{
				"isCompare":"false",
				"background":"#07ea19",
				"foreground":"#e31818"
			}
		],
		"primaryColors":[
			{
				"background":"#de2626",
				"foreground":"d85d5d"
			}
		],
		"socialMedias":[
			{
				"value":"https://facebook.com/1",
				"key":"Support Channel: Facebook,Tiktok, X (Twitter), Pinterest, Instagram, Tumblr, Snapchat, YouTube, Vimeo, LinkedIn"
			}
		],
		"squareLogo":"https://image-c.genstoredev.com/qa-34K/4022051066694/feeebd189f4f486ea8d3f9212499daac.webp",
		"defaultLogo":"https://image-c.genstoredev.com/qa-34K/4022051066694/c10b57f2e51d4d5f98296e8f93284725.webp?urlname=fcc35ef7e3374bbfa9c6ba1cd8ce6776"
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "brand": {
    "secondaryColors": [
      {
        "isCompare": "true",
        "background": "#07ea19",
        "foreground": "#07ea19"
      }
    ],
    "primaryColors": [
      {
        "background": "#de2626",
        "foreground": "#de2626"
      }
    ],
    "socialMedias": [
      {
        "value": "https://facebook.com/1",
        "key": "Support Channel: Facebook,Tiktok, X (Twitter), Pinterest, Instagram, Tumblr, Snapchat, YouTube, Vimeo, LinkedIn"
      }
    ],
    "squareLogo": "https://image-c.genstoredev.com/qa-34K/4022051066694/feeebd189f4f486ea8d3f9212499daac.webp",
    "defaultLogo": "https://image-c.genstoredev.com/qa-34K/4022051066694/c10b57f2e51d4d5f98296e8f93284725.webp?urlname=fcc35ef7e3374bbfa9c6ba1cd8ce6776"
  }
}

`PUT` 更新店铺基本信息

更新店铺基本信息，比如币种、时区、账单地址等

访问范围

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

接口

PUT /api/202412/shops/info

请求参数

shopobjectrequired

店铺的信息。

- 收起属性

shopNamestringrequired

店铺的名称。

currencystringrequired

店铺的主货币，采用 ISO_4217 标准的3位字符。

ianaTimezonestringrequired

店铺的 IANA 时区。

weightUnitstringrequired

店铺的重量单位，可选值 lb、oz、g、kg。

响应数据

shopobjectrequired

店铺的信息。

- 收起属性

shopNamestringrequired

店铺的名称。

currencystringrequired

店铺的主货币，采用 ISO_4217 标准的3位字符。

ianaTimezonestringrequired

店铺的 IANA 时区。

weightUnitstringrequired

店铺的重量单位，可选值 lb、oz、g、kg。

PUT /api/202412/shops/info

bash

curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/shops/info" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"shop":{
		"shopName":"Sun's Shop",
		"currency":"USD",
		"ianaTimezone":"America/New_York",
		"weightUnit":"kg"
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "shop": {
    "shopName": "Sun's Shop",
    "currency": "USD",
    "ianaTimezone": "America/New_York",
    "weightUnit": "kg"
  }
}

`DELETE` 删除仓储地址

删除仓储地址。

访问范围

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

接口

DELETE /api/202412/shops/locations/{locationId}

请求参数

locationIdnumberrequired

仓储地址 ID。

响应数据

{}

DELETE /api/202412/shops/locations/{locationId}

bash

curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/shops/locations/{locationId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{}

`GET` 获取店铺基本信息

获取店铺基本信息。

访问范围

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

接口

GET /api/202412/shops/info

请求参数

{}

响应数据

shopobjectrequired

店铺的信息。

- 收起属性

shopIdnumberrequired

店铺的唯一标识符，64 位数值。

shopNamestringrequired

店铺的名称。

domainstring

店铺的域名。

descriptionstring

店铺的简介。

logostring

店铺的 Logo 表示，在 C 端展示。

mailstringrequired

店铺的邮箱地址，可以用此来联系商户。

countrystringrequired

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

currencystringrequired

店铺的主货币，采用 ISO_4217 标准的3位字符。

timezonestring

店铺的时区。

ianaTimezonestringrequired

店铺的 IANA 时区。

weightUnitstringrequired

店铺的重量单位，可选值 lb、oz、g、kg。

originDomainstringrequired

店铺初始化赋予的域名。

shopStatusnumberrequired

店铺的状态。 0: 停用, 1: 试用版, 2: 付费版本, 3: 欠费

GET /api/202412/shops/info

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/info" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "shop": {
    "country": "US",
    "mail": "name@example.com",
    "timezone": "-4",
    "shopName": "Sun's Shop",
    "description": "This is a test shop descirption",
    "originDomain": "aaa.genstore.com",
    "shopStatus": "1",
    "domain": "online-shop.genstore.com",
    "logo": "https: //statics.genstore.com/folder/qefadfasdfafwerw.png",
    "currency": "USD",
    "shopId": "1234567890",
    "ianaTimezone": "America/New_York",
    "weightUnit": "kg"
  }
}

`GET` 获取仓储地址数量

获取仓储地址数量。

访问范围

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

接口

GET /api/202412/shops/locations/count

请求参数

{}

响应数据

countnumberrequired

仓储地址的数量。

GET /api/202412/shops/locations/count

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/locations/count" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "count": "123"
}

`GET` 获取仓储地址详情

查询仓储地址详情。

访问范围

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

接口

GET /api/202412/shops/locations/{locationId}

请求参数

locationIdnumberrequired

仓储地址的ID

响应数据

locationobject

仓储信息。

- 收起属性

locationNamestringrequired

仓储的地址。

countrystringrequired

仓储地址的国家地区编码。

provincestring

仓储地址的省级单位编码。

citystring

仓储地址的市，商户填写。

address1string

仓储地址的街道地址。

address2string

仓储地址的街道的地址。

zipcodestring

邮政编码。

phonestring

联系电话。

latitudestring

仓储的纬度。

longitudestring

仓储的经度。

locationIdnumberrequired

仓储的ID。

isDefaultboolean

是否是默认的仓储地址。

stopStatusboolean

此仓储地址是否已经停用。

fulfillmentServiceHandlenumberrequired

履约服务商Handle。

GET /api/202412/shops/locations/{locationId}

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/locations/{locationId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "location": {
    "country": "US",
    "locationName": "Shanghai warehousing",
    "city": "上海市",
    "address2": "Unit 42",
    "address1": "126 York Street",
    "latitude": "36.30556423523153",
    "zipcode": "k1n5t5",
    "isDefault": "true",
    "province": "PN",
    "phone": "86-13112341234",
    "locationId": "1234657809123",
    "stopStatus": "true",
    "longitude": "104.48060937499996",
    "fulfillmentServiceHandle": "12333"
  }
}

`GET` 获取语言列表

获取店铺支持的语言列表。

访问范围

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

接口

GET /api/202412/shops/languages

请求参数

{}

响应数据

languagesobjectrequired

语言列表。

- 收起属性

publishedListarrayrequired

已经发布的语言列表。

+ 展开属性

unPublishedListarrayrequired

未发布的语言列表。

+ 展开属性

GET /api/202412/shops/languages

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/languages" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "languages": {
    "publishedList": [
      {
        "translateStatus": "true",
        "isDefault": "true",
        "languageCountry": "en-US",
        "name": "English",
        "language": "en"
      }
    ],
    "unPublishedList": [
      {
        "translateStatus": "false",
        "isDefault": "false",
        "languageCountry": "zh-CN",
        "name": "Chinese Simplified",
        "language": "zh-CN"
      }
    ]
  }
}

`GET` 获取地点列表

滚动分页获取店铺地点列表。

访问范围

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

接口

GET /api/202412/shops/locations

请求参数

pageTokenstring

滚动分页参数，第一次请求为空

limitnumberrequired

分页数量限制，默认限制 10。

响应数据

locationsobjectrequired

仓储列表信息。

- 收起属性

countrystringrequired

仓储地址的国家地区编码。

locationNamestringrequired

仓储的名称。

citystringrequired

仓储地址的市，商户填写。

address2stringrequired

仓储地址的街道的地址。

address1stringrequired

仓储地址的街道地址。

latitudestringrequired

仓储的纬度。

zipcodestringrequired

邮政编码。

isDefaultbooleanrequired

是否是默认的仓储地址。

provincestringrequired

仓储地址的省级单位编码。

phonestringrequired

联系电话。

locationIdnumberrequired

仓储的ID。

stopStatusbooleanrequired

此仓储地址是否已经停用。

longitudestringrequired

仓储的经度。

fulfillmentServiceHandlenumberrequired

履约服务商Handle。

GET /api/202412/shops/locations

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/locations" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "locations": {
    "country": "US",
    "locationName": "Shanghai warehousing",
    "city": "上海市",
    "address2": "Unit 42",
    "address1": "126 York Street",
    "latitude": "36.30556423523153",
    "zipcode": "200000",
    "isDefault": "true",
    "province": "PN",
    "phone": "86-13112341234",
    "locationId": "1234657809123",
    "stopStatus": "true",
    "longitude": "104.48060937499996",
    "fulfillmentServiceHandle": "12333"
  }
}

`GET` 获取店铺品牌信息

获取店铺品牌信息

访问范围

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

接口

GET /api/202412/shops/brand

请求参数

{}

响应数据

brandobjectrequired

品牌

- 收起属性

defaultLogostring

默认logo

squareLogostring

方形logo

primaryColorsarray

主色

+ 展开属性

secondaryColorsarray

辅助色

+ 展开属性

socialMediasarray

社媒分享链接

+ 展开属性

GET /api/202412/shops/brand

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/brand" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "brand": {
    "secondaryColors": [
      {
        "isCompare": "false",
        "background": "#07ea19",
        "foreground": "#e31818"
      }
    ],
    "primaryColors": [
      {
        "background": "#de2626",
        "foreground": "#d85d5d"
      }
    ],
    "socialMedias": [
      {
        "value": "https://facebook.com/1",
        "key": "Support Channel: Facebook,Tiktok, X (Twitter), Pinterest, Instagram, Tumblr, Snapchat, YouTube, Vimeo, LinkedIn"
      }
    ],
    "squareLogo": "https://image-c.genstoredev.com/qa-34K/4022051066694/feeebd189f4f486ea8d3f9212499daac.webp",
    "defaultLogo": "https://image-c.genstoredev.com/qa-34K/4022051066694/c10b57f2e51d4d5f98296e8f93284725.webp?urlname=fcc35ef7e3374bbfa9c6ba1cd8ce6776"
  }
}

关于店铺

访问范围

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

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

核心功能

查询店铺信息：获取店铺的基础信息，包括店铺名称、访问域名、联系电话等。
查询地点详情：获取单个店铺地点的详细信息。
创建店铺地点：添加新的店铺地点信息。
更新地点信息：编辑已有店铺地点的信息。
删除店铺地点：移除指定的店铺地点信息。
获取地点列表：滚动分页获取店铺地点列表。
统计地点数量：获取当前店铺的地点总数。

应用场景

智能通知管理：商家可基于店铺时区，在合适的时间发送通知和奖励，避免打扰客户，提升客户满意度。
店铺信息配置：运营团队可维护店铺基础信息，确保客户能获取准确的店铺信息。
多地点管理：商家可创建和管理多个店铺地点，实现高效的多店运营。

店铺对象

接口

GET /api/202412/shops/brand

产品

变体

系列

库存

类目

礼品卡

厂商

订单

履约

退货

客户

主题

页面

店铺

市场

翻译

素材

元字段

元字段定义

账户

交易

支付

折扣

授权

消息订阅

订阅收费

使用量收费

关于 店铺 ​

店铺 对象 ​

属性 ​

POST 创建仓储地址 ​

请求参数

响应数据

PUT 更新仓储地址 ​

请求参数

响应数据

PUT 更新店铺品牌信息 ​

请求参数

响应数据

PUT 更新店铺基本信息 ​

请求参数

响应数据

DELETE 删除仓储地址 ​

请求参数

响应数据

GET 获取店铺基本信息 ​

请求参数

响应数据

GET 获取仓储地址数量 ​

请求参数

响应数据

GET 获取仓储地址详情 ​

请求参数

响应数据

GET 获取语言列表 ​

请求参数

响应数据

GET 获取地点列表 ​

请求参数

响应数据

GET 获取店铺品牌信息 ​

请求参数

响应数据

关于 店铺 ​

店铺 对象 ​

属性 ​

POST 创建仓储地址 ​

PUT 更新仓储地址 ​

PUT 更新店铺品牌信息 ​

PUT 更新店铺基本信息 ​

DELETE 删除仓储地址 ​

GET 获取店铺基本信息 ​

GET 获取仓储地址数量 ​

GET 获取仓储地址详情 ​

GET 获取语言列表 ​

GET 获取地点列表 ​

GET 获取店铺品牌信息 ​

关于店铺

店铺对象

属性

`POST` 创建仓储地址

`PUT` 更新仓储地址

`PUT` 更新店铺品牌信息

`PUT` 更新店铺基本信息

`DELETE` 删除仓储地址

`GET` 获取店铺基本信息

`GET` 获取仓储地址数量

`GET` 获取仓储地址详情

`GET` 获取语言列表

`GET` 获取地点列表

`GET` 获取店铺品牌信息

关于店铺

店铺对象

属性

`POST` 创建仓储地址

`PUT` 更新仓储地址

`PUT` 更新店铺品牌信息

`PUT` 更新店铺基本信息

`DELETE` 删除仓储地址

`GET` 获取店铺基本信息

`GET` 获取仓储地址数量

`GET` 获取仓储地址详情

`GET` 获取语言列表

`GET` 获取地点列表

`GET` 获取店铺品牌信息