--- title: "Add Product to sales channels" description: "Add Product to sales channels" doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/webhook/sales-channels/add-product-to-sales-channels' md: 'https://developer.shopline.com/docs/webhook/sales-channels/add-product-to-sales-channels.md' --- # Add Product to sales channels Add Product to sales channels - **API Version:** v20270301 - **API Type:** Webhook - **API Protocol:** RESTful ## Request ### Request Headers * `X-Shopline-Topic` string (required) The unique identifier for the event. * `X-Shopline-Hmac-Sha256` string (required) The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data. * `X-Shopline-Shop-Domain` string (required) The store domain. * `X-Shopline-Shop-Id` string (required) The store ID. * `X-Shopline-Merchant-Id` string (required) The merchant ID. * `X-Shopline-API-Version` string (required) The API version. * `X-Shopline-Webhook-Id` string (required) The ID of this Webhook event. ### Request Body * `product_listing` object Product information * `body_html` string Product description * `created_at` string Product create time * `handle` string Global unique Product handle * `id` string Product ID * `images` array Product main image listing * `alt` string Picture alt * `src` string Image URL * `options` array Option list * `id` string Option id * `name` string Option name * `option_values` array List of option values. * `id` string The ID of option value. * `value` string The option value. * `product_id` string Duiying id corresponding * `values` array List of options value * `values_images` map Option value chart * `product_behavior` string Product behavior * `product_category` string Product polymer type * `product_type` string Product type * `published_at` string Time to post to online stores * `published_scope` string Launch range , " web " means online stores * `spu` string Size s pu * `status` string Product status : active- on shelf , draft- off shelf , archived- filing * `subtitle` string Product summary * `tags` string Tag , multiple separated by ',' * `template_path` string Theme template * `title` string Product title * `updated_at` string Product update time * `variants` array Style list * `barcode` string Bar code * `compare_at_price` string Original price * `id` string Style id * `image` object Style chart * `alt` string Picture alt * `src` string Images src * `inventory_policy` string Allows oversold , continue or not : allowed , deny : not allowed * `inventory_quantity` integer Suoyou summary of all locations * `inventory_tracker` boolean Track inventory or not * `option1` string Value for the first option that this style corresponds to * `option2` string Value for the second option that this style corresponds to * `option3` string Value for the third option that this style corresponds to * `option4` string Value of the fourth option that this style corresponds to * `option5` string Value for the fifth option that this style corresponds to * `price` string Selling price * `product_id` string Duiying id corresponding * `required_shipping` boolean Shipping or not * `sku` string Sku * `taxable` boolean Tax or not？ * `title` string Style title * `weight` string Weight * `weight_unit` string Weight unit , g : g , kg : kg , lb : lb , oz : oz * `vendor` string Product manufacturer ## Response ### Status Codes * `200` After receiving a webhook notification from SHOPLINE, you must respond with the following format: ``` HTTP/1.1 200 OK ``` For more information about how to subscribe to webhooks and webhook response rules, refer to [Webhook overview](https://developer.shopline.com/docs/apps/api-instructions-for-use/webhooks/overview.md). ### Response Body #### 200 _No response body_ ## OpenAPI Definition ```json { "description": "Add Product to sales channels", "externalDocs": { "description": "| Event Group | Event Identification |\n| :------: | :------: |\n|product_listings |product_listings/add |\n", "url": "", "errorTableDescription": "" }, "operationId": "JzwSl7sH", "parameters": [ { "name": "X-Shopline-Topic", "in": "header", "description": "The unique identifier for the event.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Topic", "description": "The unique identifier for the event.", "type": "string", "example": "orders/edited" }, "example": "orders/edited" }, { "name": "X-Shopline-Hmac-Sha256", "in": "header", "description": "The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Hmac-Sha256", "description": "The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data.", "type": "string", "example": "XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=" }, "example": "XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=" }, { "name": "X-Shopline-Shop-Domain", "in": "header", "description": "The store domain.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Shop-Domain", "description": "The store domain.", "type": "string", "example": "example.myshopline.com" }, "example": "example.myshopline.com" }, { "name": "X-Shopline-Shop-Id", "in": "header", "description": "The store ID.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Shop-Id", "description": "The store ID.", "type": "string", "example": "1610418123456" }, "example": "1610418123456" }, { "name": "X-Shopline-Merchant-Id", "in": "header", "description": "The merchant ID.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Merchant-Id", "description": "The merchant ID.", "type": "string", "example": "2000001234" }, "example": "2000001234" }, { "name": "X-Shopline-API-Version", "in": "header", "description": "The API version.", "required": true, "style": "string", "schema": { "name": "X-Shopline-API-Version", "description": "The API version.", "type": "string", "example": "v20250601" }, "example": "v20250601" }, { "name": "X-Shopline-Webhook-Id", "in": "header", "description": "The ID of this Webhook event.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Webhook-Id", "description": "The ID of this Webhook event.", "type": "string", "example": "b54557e48a5fbf7d70bcd043" }, "example": "b54557e48a5fbf7d70bcd043" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "product_listing": { "name": "product_listing", "description": "Product information", "type": "object", "properties": { "body_html": { "name": "body_html", "description": "Product description", "type": "string", "example": "This is a description" }, "created_at": { "name": "created_at", "description": "Product create time", "type": "string", "example": "2023-03-02T18:18:42.883+0800" }, "handle": { "name": "handle", "description": "Global unique Product handle", "type": "string", "example": "proudct-handle" }, "id": { "name": "id", "description": "Product ID", "type": "string", "example": "16058287356753559620272670" }, "images": { "name": "images", "description": "Product main image listing", "type": "array", "items": { "name": "images", "description": "Product main image listing", "type": "object", "properties": { "alt": { "name": "alt", "description": "Picture alt", "type": "string", "example": "This is a image alt" }, "src": { "name": "src", "description": "Image URL", "type": "string", "example": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "example": { "alt": "This is a image alt", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "example": [ "" ] }, "options": { "name": "options", "description": "Option list", "type": "array", "items": { "name": "options", "description": "Option list", "type": "object", "properties": { "id": { "name": "id", "description": "Option id", "type": "string", "example": "16158288104774469113452670" }, "name": { "name": "name", "description": "Option name", "type": "string", "example": "Color" }, "option_values": { "name": "option_values", "description": "List of option values.", "type": "array", "items": { "name": "option_values", "description": "List of option values.", "type": "object", "properties": { "id": { "name": "id", "description": "The ID of option value.", "type": "string", "example": "16247051995358890915900034" }, "value": { "name": "value", "description": "The option value.", "type": "string", "example": "Red" } }, "example": { "id": "16247051995358890915900034", "value": "Red" } }, "example": [ "" ] }, "product_id": { "name": "product_id", "description": "Duiying id corresponding", "type": "string", "example": "16058287356753569620272670" }, "values": { "name": "values", "description": "List of options value", "type": "array", "items": { "name": "values", "description": "List of options value", "type": "string", "example": "[\"Red\", \"Green\", \"White\"]" }, "example": [ "[\"Red\", \"Green\", \"White\"]" ] }, "values_images": { "name": "values_images", "description": "Option value chart", "type": "map", "example": {} } }, "example": { "id": "16158288104774469113452670", "name": "Color", "option_values": [ "" ], "product_id": "16058287356753569620272670", "values": [ "[\"Red\", \"Green\", \"White\"]" ], "values_images": {} } }, "example": [ "" ] }, "product_behavior": { "name": "product_behavior", "description": "Product behavior", "type": "string", "example": "RISK,HIDDEN" }, "product_category": { "name": "product_category", "description": "Product polymer type", "type": "string", "example": "Electronic" }, "product_type": { "name": "product_type", "description": "Product type", "type": "string", "example": "Electronic" }, "published_at": { "name": "published_at", "description": "Time to post to online stores", "type": "string", "example": "2023-03-02T18:18:42.883+0800" }, "published_scope": { "name": "published_scope", "description": "Launch range , \" web \" means online stores", "type": "string", "example": "web" }, "spu": { "name": "spu", "description": "Size s pu", "type": "string", "example": "S000000001" }, "status": { "name": "status", "description": "Product status : active- on shelf , draft- off shelf , archived- filing", "type": "string", "example": "active" }, "subtitle": { "name": "subtitle", "description": "Product summary", "type": "string", "example": "This is a subtitle" }, "tags": { "name": "tags", "description": "Tag , multiple separated by ','", "type": "string", "example": "tag1,tag2" }, "template_path": { "name": "template_path", "description": "Theme template", "type": "string", "example": "templates/products/detail.json" }, "title": { "name": "title", "description": "Product title", "type": "string", "example": "This is a title" }, "updated_at": { "name": "updated_at", "description": "Product update time", "type": "string", "example": "2023-03-02T18:18:42.883+0800" }, "variants": { "name": "variants", "description": "Style list", "type": "array", "items": { "name": "variants", "description": "Style list", "type": "object", "properties": { "barcode": { "name": "barcode", "description": "Bar code", "type": "string", "example": "B0000000001" }, "compare_at_price": { "name": "compare_at_price", "description": "Original price", "type": "string", "example": "1" }, "id": { "name": "id", "description": "Style id", "type": "string", "example": "18058288104774469113432670" }, "image": { "name": "image", "description": "Style chart", "type": "object", "properties": { "alt": { "name": "alt", "description": "Picture alt", "type": "string", "example": "This is a image alt" }, "src": { "name": "src", "description": "Images src", "type": "string", "example": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "example": { "alt": "This is a image alt", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "inventory_policy": { "name": "inventory_policy", "description": "Allows oversold , continue or not : allowed , deny : not allowed", "type": "string", "example": "continue" }, "inventory_quantity": { "name": "inventory_quantity", "description": "Suoyou summary of all locations", "type": "integer", "example": 1 }, "inventory_tracker": { "name": "inventory_tracker", "description": "Track inventory or not", "type": "boolean", "example": true }, "option1": { "name": "option1", "description": "Value for the first option that this style corresponds to", "type": "string", "example": "Red" }, "option2": { "name": "option2", "description": "Value for the second option that this style corresponds to", "type": "string", "example": "L" }, "option3": { "name": "option3", "description": "Value for the third option that this style corresponds to", "type": "string", "example": "" }, "option4": { "name": "option4", "description": "Value of the fourth option that this style corresponds to", "type": "string", "example": "" }, "option5": { "name": "option5", "description": "Value for the fifth option that this style corresponds to", "type": "string", "example": "" }, "price": { "name": "price", "description": "Selling price", "type": "string", "example": "1" }, "product_id": { "name": "product_id", "description": "Duiying id corresponding", "type": "string", "example": "16058287356753569620272670" }, "required_shipping": { "name": "required_shipping", "description": "Shipping or not", "type": "boolean", "example": false }, "sku": { "name": "sku", "description": "Sku", "type": "string", "example": "B0000001" }, "taxable": { "name": "taxable", "description": "Tax or not？", "type": "boolean", "example": false }, "title": { "name": "title", "description": "Style title", "type": "string", "example": "Red/L" }, "weight": { "name": "weight", "description": "Weight", "type": "string", "example": "1" }, "weight_unit": { "name": "weight_unit", "description": "Weight unit , g : g , kg : kg , lb : lb , oz : oz", "type": "string", "example": "g" } }, "example": { "barcode": "B0000000001", "compare_at_price": "1", "id": "18058288104774469113432670", "image": { "alt": "This is a image alt", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" }, "inventory_policy": "continue", "inventory_quantity": 1, "inventory_tracker": true, "option1": "Red", "option2": "L", "option3": "", "option4": "", "option5": "", "price": "1", "product_id": "16058287356753569620272670", "required_shipping": false, "sku": "B0000001", "taxable": false, "title": "Red/L", "weight": "1", "weight_unit": "g" } }, "example": [ "" ] }, "vendor": { "name": "vendor", "description": "Product manufacturer", "type": "string", "example": "Shopline" } }, "example": { "body_html": "This is a description", "created_at": "2023-03-02T18:18:42.883+0800", "handle": "proudct-handle", "id": "16058287356753559620272670", "images": [ "" ], "options": [ "" ], "product_behavior": "RISK,HIDDEN", "product_category": "Electronic", "product_type": "Electronic", "published_at": "2023-03-02T18:18:42.883+0800", "published_scope": "web", "spu": "S000000001", "status": "active", "subtitle": "This is a subtitle", "tags": "tag1,tag2", "template_path": "templates/products/detail.json", "title": "This is a title", "updated_at": "2023-03-02T18:18:42.883+0800", "variants": [ "" ], "vendor": "Shopline" } } }, "example": { "product_listing": { "body_html": "This is a description", "created_at": "2023-03-02T18:18:42.883+0800", "handle": "proudct-handle", "id": "16058287356753559620272670", "images": [ "" ], "options": [ "" ], "product_behavior": "RISK,HIDDEN", "product_category": "Electronic", "product_type": "Electronic", "published_at": "2023-03-02T18:18:42.883+0800", "published_scope": "web", "spu": "S000000001", "status": "active", "subtitle": "This is a subtitle", "tags": "tag1,tag2", "template_path": "templates/products/detail.json", "title": "This is a title", "updated_at": "2023-03-02T18:18:42.883+0800", "variants": [ "" ], "vendor": "Shopline" } } } } }, "required": true }, "responses": { "200": { "description": "After receiving a webhook notification from SHOPLINE, you must respond with the following format: \n\n``` HTTP/1.1 200 OK ```\n\nFor more information about how to subscribe to webhooks and webhook response rules, refer to [Webhook overview](https://developer.shopline.com/docs/apps/api-instructions-for-use/webhooks/overview.md)." } }, "info": { "title": "Add Product to sales channels", "version": "v20270301" } } ```