关于产品

访问范围

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

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

Genstore 产品业务域是核心业务模块，通过提供一系列的 RESTful 接口，全面管理产品信息，支持产品的创建、检索、更新和删除，涵盖产品基础信息、产品变体、库存管理、礼品卡、产品系列，以及类目搜索等子域。

其中，产品是店铺中销售的基本单位，包括商品的所有基础信息如名称、描述等。Genstore 提供了一系列 RESTful 接口，开发者和电商平台管理者可通过相关接口对产品信息进行详细的操作，包括创建、读取、更新和删除（CRUD）。每个产品条目包含了所有必要的详情，使其在商店中展示并提供给消费者购买。

核心功能

创建产品：添加新产品到系统中。
获取产品列表：检索所有产品的详细信息。
获取单个产品：根据产品 ID 检索特定产品的详细信息。
更新产品：修改现有产品的信息。
删除产品：从系统中删除特定产品。

应用场景

在线商店运营：店铺运营者可高效管理商品目录、实时更新商品详情、控制商品展示并协调库存变更，确保全渠道商品信息的准确性和及时性。
库存管理继承：运营团队可跨系统同步库存水平、配置自动库存更新规则、管理库存分配策略，在防止超卖的同时优化库存效率。
多渠道商品展示：电商团队可在移动应用和网站间分发统一的商品信息、管理富媒体内容、同步更新销售渠道，提供一致的商品体验。
商品表现分析：业务分析师可追踪商品指标、生成销售趋势报告、分析市场表现，支持数据驱动的库存和定价决策。

接口

EVENT products/delete: 产品删除

EVENT products/create: 产品创建

EVENT products/update: 产品更新

产品对象

产品业务域对象。

属性

productobject

产品信息。

- 收起属性

productIdnumber

产品唯一标识符。

titlestring

产品标题。

subTitlestring

产品副标题。

bodyHtmlstring

产品描述，支持 HTML 格式。

productTypestring

产品类型。枚举值：normal - 一般实物商品。

tagsarray

产品标签唯一标识符列表。

vendorstring

产品品牌厂商。

collectionsarray

产品系列唯一标识符列表。

statusstring

产品的状态。枚举值：active - 上架状态；inactive - 下架状态；archived - 归档状态；draft - 草稿状态。

imagesarray

产品图片信息。

+ 展开属性

isMultiVariantboolean

是否多变体，true 是多变体，false 不是多变体。

optionsarray

商品自定义属性信息，例如尺码、颜色和材料。

+ 展开属性

variantsarray

产品变体列表。

+ 展开属性

marketAssignsarray

市场分配列表。

+ 展开属性

productCategoryobject

产品类目。

+ 展开属性

salesChannelsarray

销售渠道信息。

+ 展开属性

产品对象

bash

{
  "product": {
    "isMultiVariant": "false",
    "salesChannels": [
      {
        "salesChannelCode": "onlineStore"
      }
    ],
    "images": [
      {
        "productId": "102745140756584",
        "src": "https://blaze.com/s/files/[email protected]?v=1716260620",
        "position": "1"
      }
    ],
    "productId": "102745140756584",
    "variants": [
      {
        "inventoryManagement": "true",
        "productId": "102744460756584",
        "costPrice": "3",
        "weight": "1",
        "compareOfPrice": "22",
        "inventoryQuantities": [
          {
            "locationId": "50002",
            "available": "666"
          }
        ],
        "price": "10",
        "options": [
          {
            "name": "size",
            "id": "10034623756584",
            "position": "1",
            "value": {
              "name": "L",
              "id": "10167791756584",
              "position": "1"
            }
          }
        ],
        "variantId": "107362030756584",
        "isDisabled": "false",
        "sku": "P001",
        "barcode": "AXOYX49XOPEX6",
        "weightUnit": "kg"
      }
    ],
    "marketAssigns": [
      {
        "isAssigned": "true",
        "marketId": "6016662702584"
      }
    ],
    "title": "shirt",
    "tags": "[102984300756584,102984300756585]",
    "productCategory": {
      "categoryName": "pet",
      "categoryId": "209148956145"
    },
    "subTitle": "wool shirt",
    "collections": "[107363170756584,107363170756585]",
    "vendor": "nike",
    "options": [
      {
        "name": "size",
        "id": "10034623756584",
        "position": "1",
        "value": [
          {
            "name": "L",
            "id": "10167791756584",
            "position": "1"
          }
        ]
      }
    ],
    "bodyHtml": "<p>wool shirt</p>",
    "productType": "normal",
    "status": "active"
  }
}

`EVENT` 产品删除

产品删除

访问范围

需要以下任意访问权限: write_products read_products

消息

EVENT products/delete

消息数据

productIdnumber

产品唯一标识符。

products/delete: 示例数据

json

{
  "productId": "102745140756584"
}

`EVENT` 产品创建

产品创建

访问范围

需要以下任意访问权限: write_products read_products

消息

EVENT products/create

消息数据

productobject

产品信息。

- 收起属性

productIdnumber

产品唯一标识符。

titlestring

产品标题。

subTitlestring

产品副标题。

bodyHtmlstring

产品描述，支持 HTML 格式。

productTypestring

产品类型。枚举值：normal - 一般实物商品。

tagsarray

产品标签唯一标识符列表。

vendorstring

产品品牌厂商。

collectionsarray

产品系列唯一标识符列表。

statusstring

产品的状态。枚举值：active - 上架状态；inactive - 下架状态；archived - 归档状态；draft - 草稿状态。

imagesarray

产品图片信息。

+ 展开属性

isMultiVariantboolean

是否多变体，true 是多变体，false 不是多变体。

optionsarray

商品自定义属性信息，例如尺码、颜色和材料。

+ 展开属性

variantsarray

产品变体列表。

+ 展开属性

marketAssignsarray

市场分配列表。

+ 展开属性

productCategoryobject

产品类目。

+ 展开属性

salesChannelsarray

销售渠道信息。

+ 展开属性

products/create: 示例数据

json

{
  "product": {
    "isMultiVariant": "false",
    "salesChannels": [
      {
        "salesChannelCode": "onlineStore"
      }
    ],
    "images": [
      {
        "productId": "102745140756584",
        "src": "https://blaze.com/s/files/[email protected]?v=1716260620",
        "position": "1"
      }
    ],
    "productId": "102745140756584",
    "variants": [
      {
        "inventoryManagement": "true",
        "productId": "102744460756584",
        "costPrice": "3",
        "weight": "1",
        "compareOfPrice": "22",
        "inventoryQuantities": [
          {
            "locationId": "50002",
            "available": "666"
          }
        ],
        "price": "10",
        "options": [
          {
            "name": "size",
            "id": "10034623756584",
            "position": "1",
            "value": {
              "name": "L",
              "id": "10167791756584",
              "position": "1"
            }
          }
        ],
        "variantId": "107362030756584",
        "isDisabled": "false",
        "sku": "P001",
        "barcode": "AXOYX49XOPEX6",
        "weightUnit": "kg"
      }
    ],
    "marketAssigns": [
      {
        "isAssigned": "true",
        "marketId": "6016662702584"
      }
    ],
    "title": "shirt",
    "tags": "[102984300756584,102984300756585]",
    "productCategory": {
      "categoryName": "pet",
      "categoryId": "209148956145"
    },
    "subTitle": "wool shirt",
    "collections": "[107363170756584,107363170756585]",
    "vendor": "nike",
    "options": [
      {
        "name": "size",
        "id": "10034623756584",
        "position": "1",
        "value": [
          {
            "name": "L",
            "id": "10167791756584",
            "position": "1"
          }
        ]
      }
    ],
    "bodyHtml": "<p>wool shirt</p>",
    "productType": "normal",
    "status": "active"
  }
}

`EVENT` 产品更新

产品更新

访问范围

需要以下任意访问权限: write_products read_products

消息

EVENT products/update

消息数据

productobject

产品信息。

- 收起属性

productIdnumber

产品唯一标识符。

titlestring

产品标题。

subTitlestring

产品副标题。

bodyHtmlstring

产品描述，支持 HTML 格式。

productTypestring

产品类型。枚举值：normal - 一般实物商品。

tagsarray

产品标签唯一标识符列表。

vendorstring

产品品牌厂商。

collectionsarray

产品系列唯一标识符列表。

statusstring

产品的状态。枚举值：active - 上架状态；inactive - 下架状态；archived - 归档状态；draft - 草稿状态。

imagesarray

产品图片信息。

+ 展开属性

isMultiVariantboolean

是否多变体，true 是多变体，false 不是多变体。

optionsarray

商品自定义属性信息，例如尺码、颜色和材料。

+ 展开属性

variantsarray

产品变体列表。

+ 展开属性

marketAssignsarray

市场分配列表。

+ 展开属性

productCategoryobject

产品类目。

+ 展开属性

salesChannelsarray

销售渠道信息。

+ 展开属性

products/update: 示例数据

json

{
  "product": {
    "isMultiVariant": "false",
    "salesChannels": [
      {
        "salesChannelCode": "onlineStore"
      }
    ],
    "images": [
      {
        "productId": "102745140756584",
        "src": "https://blaze.com/s/files/[email protected]?v=1716260620",
        "position": "1"
      }
    ],
    "productId": "102745140756584",
    "variants": [
      {
        "inventoryManagement": "true",
        "productId": "102744460756584",
        "costPrice": "3",
        "weight": "1",
        "compareOfPrice": "22",
        "inventoryQuantities": [
          {
            "locationId": "50002",
            "available": "666"
          }
        ],
        "price": "10",
        "options": [
          {
            "name": "size",
            "id": "10034623756584",
            "position": "1",
            "value": {
              "name": "L",
              "id": "10167791756584",
              "position": "1"
            }
          }
        ],
        "variantId": "107362030756584",
        "isDisabled": "false",
        "sku": "P001",
        "barcode": "AXOYX49XOPEX6",
        "weightUnit": "kg"
      }
    ],
    "marketAssigns": [
      {
        "isAssigned": "true",
        "marketId": "6016662702584"
      }
    ],
    "title": "shirt",
    "tags": "[102984300756584,102984300756585]",
    "productCategory": {
      "categoryName": "pet",
      "categoryId": "209148956145"
    },
    "subTitle": "wool shirt",
    "collections": "[107363170756584,107363170756585]",
    "vendor": "nike",
    "options": [
      {
        "name": "size",
        "id": "10034623756584",
        "position": "1",
        "value": [
          {
            "name": "L",
            "id": "10167791756584",
            "position": "1"
          }
        ]
      }
    ],
    "bodyHtml": "<p>wool shirt</p>",
    "productType": "normal",
    "status": "active"
  }
}

关于产品

访问范围

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

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

核心功能

创建产品：添加新产品到系统中。
获取产品列表：检索所有产品的详细信息。
获取单个产品：根据产品 ID 检索特定产品的详细信息。
更新产品：修改现有产品的信息。
删除产品：从系统中删除特定产品。

应用场景

在线商店运营：店铺运营者可高效管理商品目录、实时更新商品详情、控制商品展示并协调库存变更，确保全渠道商品信息的准确性和及时性。
库存管理继承：运营团队可跨系统同步库存水平、配置自动库存更新规则、管理库存分配策略，在防止超卖的同时优化库存效率。
多渠道商品展示：电商团队可在移动应用和网站间分发统一的商品信息、管理富媒体内容、同步更新销售渠道，提供一致的商品体验。
商品表现分析：业务分析师可追踪商品指标、生成销售趋势报告、分析市场表现，支持数据驱动的库存和定价决策。

产品对象

产品业务域对象。

属性

`EVENT` 产品删除

产品删除

访问范围

需要以下任意访问权限: write_products read_products

消息

EVENT products/delete

`EVENT` 产品创建

产品创建

访问范围

需要以下任意访问权限: write_products read_products

消息

EVENT products/create

`EVENT` 产品更新

产品更新

访问范围

需要以下任意访问权限: write_products read_products

消息

EVENT products/update

产品

变体

系列

订单

退货

客户

店铺

折扣

应用

授权

关于产品

产品对象

属性

`EVENT` 产品删除

消息数据

`EVENT` 产品创建

消息数据

`EVENT` 产品更新

消息数据

关于产品

产品对象

属性

`EVENT` 产品删除

`EVENT` 产品创建

`EVENT` 产品更新

产品

变体

系列

订单

退货

客户

店铺

折扣

应用

授权

关于 产品 ​

产品 对象 ​

属性 ​

EVENT 产品删除 ​

消息数据

EVENT 产品创建 ​

消息数据

EVENT 产品更新 ​

消息数据

关于 产品 ​

产品 对象 ​

属性 ​

EVENT 产品删除 ​

EVENT 产品创建 ​

EVENT 产品更新 ​

关于产品

产品对象

属性

`EVENT` 产品删除

`EVENT` 产品创建

`EVENT` 产品更新

关于产品

产品对象

属性

`EVENT` 产品删除

`EVENT` 产品创建

`EVENT` 产品更新