About Product
Access scope
Multiple access scopes needed — refer to each endpoint for access scope requirements.
The Product domain is a core business module in Genstore. Through a series of RESTful interfaces, it provides comprehensive product information management, supporting product creation, retrieval, update, and deletion. The domain covers product basic information, product variants, inventory management, gift cards, product collections, and category search subdomains.
Products are the basic unit of sale in the store, encompassing all essential information such as name and description. The Product API allows developers and e-commerce platform managers to perform detailed operations on product information, including create, read, update, and delete (CRUD) actions. Each product entry includes all necessary details, making it available for display and purchase in the store.
Core Features
- Create Product: Add new products to the system.
- List Products: Retrieve detailed information for all products.
- Get Product: Fetch specific product information by product ID.
- Update Product: Modify existing product information.
- Delete Product: Remove specific products from the system.
Use Cases
- Online Store Operations: Store owners can efficiently manage their product catalogs, update item details in real-time, control product visibility, and coordinate inventory changes through the API, ensuring accurate and timely store information across all channels.
- Inventory Control Integration: Operations teams can synchronize inventory levels across multiple systems, configure automated stock updates, and manage stock allocation rules, preventing overselling while optimizing inventory efficiency.
- Multi-channel Product Display: E-commerce teams can distribute consistent product information across mobile apps and websites, manage rich media content, and synchronize updates across sales channels, delivering unified product experiences.
- Product Performance Analytics: Business analysts can track product metrics, generate sales trend reports, and analyze market performance through the API, enabling data-driven inventory and pricing decisions.
Endpoints
EVENT products/create: Product create
EVENT products/update: Products update
EVENT products/delete: Products Delete
Product Object
The product object.
Properties
{
"product": {
"isMultiVariant": "false",
"salesChannels": [
{
"salesChannelCode": "onlineStore"
}
],
"images": [
{
"productId": "102745140756584",
"src": "https://blaze.com/s/files/Main_c8ff0b5d-c712-429a-be00-b29bd55cbc9d_40x40@3x.jpg?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 Product create
Occurs whenever a product is added.
Access scope
Requires ANY of the following access scopes: write_products read_products
Topic
EVENT products/create
Event Data
{
"product": {
"isMultiVariant": "false",
"images": [
{
"productId": "102745140756584",
"src": "https://blaze.com/s/files/Main_c8ff0b5d-c712-429a-be00-b29bd55cbc9d_40x40@3x.jpg?v=1716260620",
"position": "1"
}
],
"productId": "102745140756584",
"customProductType": "",
"handle": "",
"updateTime": "",
"variants": [
{
"inventoryManagement": "true",
"productId": "102744460756584",
"inventoryPolicy": "",
"costPrice": "3",
"weight": "1",
"media": {
"productId": "102745140756584",
"src": "",
"position": ""
},
"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",
"url": "",
"tags": [
"NEWS",
"FASHION"
],
"productCategory": {
"parentCategoryId": "",
"leaf": "",
"categoryName": "pet",
"categoryId": "209148956145"
},
"subTitle": "wool shirt",
"collections": [
107363170756584,
107363170756585
],
"createTime": "",
"vendor": "nike",
"options": [
{
"values": [
{
"name": "L",
"id": "10167791756584",
"position": "1"
}
],
"name": "size",
"id": "10034623756584",
"position": "1"
}
],
"saleChannels": [
{
"saleChannelCode": "onlineStore"
}
],
"bodyHtml": "<p>wool shirt</p>",
"productType": "normal",
"status": "active"
}
}EVENT Products update
Occurs whenever a product is updated, ordered, or variants are added, removed or updated.
Access scope
Requires ANY of the following access scopes: write_products read_products
Topic
EVENT products/update
Event Data
{
"product": {
"isMultiVariant": "false",
"images": [
{
"productId": "102745140756584",
"src": "https://blaze.com/s/files/Main_c8ff0b5d-c712-429a-be00-b29bd55cbc9d_40x40@3x.jpg?v=1716260620",
"position": "1"
}
],
"productId": "102745140756584",
"customProductType": "",
"handle": "",
"updateTime": "",
"variants": [
{
"inventoryManagement": "true",
"productId": "102744460756584",
"inventoryPolicy": "",
"costPrice": "3",
"weight": "1",
"media": {
"productId": "102745140756584",
"src": "",
"position": ""
},
"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",
"url": "",
"tags": [
"NEWS",
"FASHION"
],
"productCategory": {
"parentCategoryId": "",
"leaf": "",
"categoryName": "pet",
"categoryId": "209148956145"
},
"subTitle": "wool shirt",
"collections": [
107363170756584,
107363170756585
],
"createTime": "",
"vendor": "nike",
"options": [
{
"values": [
{
"name": "L",
"id": "10167791756584",
"position": "1"
}
],
"name": "size",
"id": "10034623756584",
"position": "1"
}
],
"saleChannels": [
{
"saleChannelCode": "onlineStore"
}
],
"bodyHtml": "<p>wool shirt</p>",
"productType": "normal",
"status": "active"
}
}EVENT Products Delete
Occurs whenever a product is deleted.
Access scope
Requires ANY of the following access scopes: write_products read_products
Topic
EVENT products/delete
Event Data
{
"productId": "102745140756584"
}About Product
Access scope
Multiple access scopes needed — refer to each endpoint for access scope requirements.
The Product domain is a core business module in Genstore. Through a series of RESTful interfaces, it provides comprehensive product information management, supporting product creation, retrieval, update, and deletion. The domain covers product basic information, product variants, inventory management, gift cards, product collections, and category search subdomains.
Products are the basic unit of sale in the store, encompassing all essential information such as name and description. The Product API allows developers and e-commerce platform managers to perform detailed operations on product information, including create, read, update, and delete (CRUD) actions. Each product entry includes all necessary details, making it available for display and purchase in the store.
Core Features
- Create Product: Add new products to the system.
- List Products: Retrieve detailed information for all products.
- Get Product: Fetch specific product information by product ID.
- Update Product: Modify existing product information.
- Delete Product: Remove specific products from the system.
Use Cases
- Online Store Operations: Store owners can efficiently manage their product catalogs, update item details in real-time, control product visibility, and coordinate inventory changes through the API, ensuring accurate and timely store information across all channels.
- Inventory Control Integration: Operations teams can synchronize inventory levels across multiple systems, configure automated stock updates, and manage stock allocation rules, preventing overselling while optimizing inventory efficiency.
- Multi-channel Product Display: E-commerce teams can distribute consistent product information across mobile apps and websites, manage rich media content, and synchronize updates across sales channels, delivering unified product experiences.
- Product Performance Analytics: Business analysts can track product metrics, generate sales trend reports, and analyze market performance through the API, enabling data-driven inventory and pricing decisions.
Product Object
The product object.
Properties
EVENT Product create
Occurs whenever a product is added.
Access scope
Requires ANY of the following access scopes: write_products read_products
Topic
EVENT products/create
EVENT Products update
Occurs whenever a product is updated, ordered, or variants are added, removed or updated.
Access scope
Requires ANY of the following access scopes: write_products read_products
Topic
EVENT products/update
EVENT Products Delete
Occurs whenever a product is deleted.
Access scope
Requires ANY of the following access scopes: write_products read_products
Topic
EVENT products/delete