--- title: "Product created" description: "Occurs whenever a product is created." doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/webhook/product/product-created' md: 'https://developer.shopline.com/docs/webhook/product/product-created.md' --- # Product created Occurs whenever a product is created. - **API Version:** v20270301 - **API Type:** Webhook - **API Protocol:** RESTful ## Request ### Request Headers * `Content-Type` string (required) The field must be set to the fixed value `application/json; charset=utf-8`. * `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 * `body_html` string The product description. * `created_at` string The date and time when the product was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `handle` string The semantically unique identifier for the product, which is generated based on `title` by default. * `id` string The unique identifier for the product. * `image` object The cover image of the product. * `alt` string The alternative textual description of the image, usually a word or phrase with the characteristics or content of the image. * `src` string The link to the image, represented as a URL. * `images` array A list of product images. * `alt` string The alternative textual description of the product image, usually a word or phrase with the characteristics or content of the image. * `src` string The link to the product image, represented as a URL. * `options` array A list of product options. * `id` string The unique identifier for the option. * `name` string The name of the option. * `option_values` array A list of product option values. * `id` string The unique identifier for the option value. * `value` string The option value. * `product_id` string The unique identifier for the product corresponding to the option. * `values` array A list of option values. * `values_images` map The mapping relationship between the option value and the corresponding image URL. * `path` string The relative path of the product page. * `product_behavior` string Used to identify the special behavior of the product. This field returns a value only under certain conditions. For example, if the product has potential risks, the field returns a value. * `product_category` string The product category customized by the merchant. * `product_type` string The source of the product. Valid values are: - `NORMAL` : products maintained in the SHOPLINE Admin - `POD_TEMPORARY` : temporary products on the Product Option Customizer&ProductBundler app - `TEMPORARY` : other temporary products * `published_at` string The date and time when the product was published. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `published_scope` string The published scope of product sales channels. The value of this field is fixed to `web`, indicating an online store. * `spu` string The identifier customized for the product by the merchant. * `status` string The status of the product. Valid values are: - `active`: products on shelves - `draft`: products off shelves - `archived`: products archiving * `subtitle` string The subtitle of the product. * `tags` string A list of tags of the product. * `template_path` string The theme template of the product. * `title` string The title of the product. * `updated_at` string The date and time when the product was last updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `variants` array A list of product variants. * `barcode` string The barcode of the variant. * `compare_at_price` string The original price of the variant. The value is rounded to two decimal places. * `id` string The unique identifier for the variant. * `image` object The image of the variant. * `alt` string The alternative textual description of the variant image, usually a word or phrase with the characteristics or content of the image. * `src` string The link to the variant image, represented as a URL. * `inventory_item_id` string The unique identifier for the inventory item. * `inventory_policy` string Indicates whether the variant is allowed to be oversold. - `deny`: Does not allow overselling. - `continue`: Allow overselling. * `inventory_quantity` integer The total inventory quantity at all storage locations. * `inventory_tracker` boolean Indicates whether the inventory tracking is enabled. - ` true`: Inventory tracking is enabled. - ` false`: Inventory tracking is not enabled. * `option1` string Information of the first option of the variant. * `option2` string Information of the second option of the variant. * `option3` string Information of the third option of the variant. * `option4` string Information of the fourth option of the variant. * `option5` string Information of the fifth option of the variant. * `price` string The selling price of the variant. The value is rounded to two decimal places. * `product_id` string The unique identifier for the product corresponding to the variant. * `required_shipping` boolean Indicates whether the variant is required to be shipped. - `true`: Shipping is required. - `false`: Shipping is not required. * `sku` string The identifier customized for the product variant by the merchant. * `taxable` boolean Indicates whether the variant is subject to tax. - `true`: Tax is required. - `false`: Tax is not required. * `title` string The title of the variant, assembled from the option value of the variant. * `weight` string The weight of the variant. The value is rounded up if it exceeds two decimal places. * `weight_unit` string The unit of weight for the variant. Valid values are: - `g`: gram - `kg`: kilogram - `lb`: pound - `oz`: ounce - `zh_kg`: kilogram * `vendor` string The brand or vendor of the product. ## 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 { "tags": [ "Product created" ], "description": "Occurs whenever a product is created. ", "externalDocs": { "description": "| Event Group | Event Identification |\n| :------: | :------: |\n|products |products/create |\n", "url": "", "errorTableDescription": "" }, "operationId": "D996ADYa", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The field must be set to the fixed value `application/json; charset=utf-8`.", "required": true, "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "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": { "name": "body", "type": "object", "properties": { "body_html": { "name": "body_html", "description": "The product description. ", "type": "string" }, "created_at": { "name": "created_at", "description": "The date and time when the product was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2025-03-06T02:20:26+08:00" }, "handle": { "name": "handle", "description": "The semantically unique identifier for the product,\nwhich is generated based on `title` by default.", "type": "string", "example": "product-handle" }, "id": { "name": "id", "description": "The unique identifier for the product.", "type": "string", "example": "16057850264845250791280282" }, "image": { "name": "image", "description": "The cover image of the product.", "type": "object", "properties": { "alt": { "name": "alt", "description": "The alternative textual description of the image, usually a word or phrase with the characteristics or content of the image.", "type": "string", "example": "This is an image alt." }, "src": { "name": "src", "description": "The link to the image, represented as a URL.", "type": "string", "example": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "example": { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "images": { "name": "images", "description": "A list of product images.", "type": "array", "items": { "type": "object", "properties": { "alt": { "name": "alt", "description": "The alternative textual description of the product image, usually a word or phrase with the characteristics or content of the image.", "type": "string", "example": "This is an image alt." }, "src": { "name": "src", "description": "The link to the product image, represented as a URL.", "type": "string", "example": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "example": { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "example": [ { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } ] }, "options": { "name": "options", "description": "A list of product options.", "type": "array", "items": { "type": "object", "properties": { "id": { "name": "id", "description": "The unique identifier for the option.", "type": "string", "example": "16158068291703878544960282" }, "name": { "name": "name", "description": "The name of the option.", "type": "string", "example": "Color" }, "option_values": { "name": "option_values", "description": "A list of product option values.", "type": "array", "items": { "type": "object", "properties": { "id": { "name": "id", "description": "The unique identifier for the option value.", "type": "string", "example": "16050375155238626683133099" }, "value": { "name": "value", "description": "The option value.", "type": "string", "example": "Red" } }, "example": { "id": "16050375155238626683133099", "value": "Red" } }, "example": [ { "id": "16050375155238626683133099", "value": "Red" } ] }, "product_id": { "name": "product_id", "description": "The unique identifier for the product corresponding to the option.", "type": "string", "example": "16057850264845250791280282" }, "values": { "name": "values", "description": "A list of option values.", "type": "array", "items": { "type": "string", "example": "[\"Red\", \"Green\", \"White\"]" }, "example": [ "[\"Red\", \"Green\", \"White\"]" ] }, "values_images": { "name": "values_images", "description": "The mapping relationship between the option value and the corresponding image URL.", "type": "map", "example": { "Red": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } } }, "example": { "id": "16158068291703878544960282", "name": "Color", "option_values": [ { "id": "16050375155238626683133099", "value": "Red" } ], "product_id": "16057850264845250791280282", "values": [ "[\"Red\", \"Green\", \"White\"]" ], "values_images": { "Red": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } } }, "example": [ { "id": "16158068291703878544960282", "name": "Color", "option_values": [ { "id": "16050375155238626683133099", "value": "Red" } ], "product_id": "16057850264845250791280282", "values": [ "[\"Red\", \"Green\", \"White\"]" ], "values_images": { "Red": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } } ] }, "path": { "name": "path", "description": "The relative path of the product page.", "type": "string", "example": "/products/clothes" }, "product_behavior": { "name": "product_behavior", "description": "Used to identify the special behavior of the product. This field returns a value only under certain conditions. \n\nFor example, if the product has potential risks, the field returns a value. ", "type": "string", "example": "RISK,HIDDEN" }, "product_category": { "name": "product_category", "description": "The product category customized by the merchant.", "type": "string", "example": "Electronic" }, "product_type": { "name": "product_type", "description": "The source of the product. Valid values are:\n- `NORMAL` : products maintained in the SHOPLINE Admin\n- `POD_TEMPORARY` : temporary products on the Product Option Customizer&ProductBundler app\n- `TEMPORARY` : other temporary products", "type": "string" }, "published_at": { "name": "published_at", "description": "The date and time when the product was published. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2025-03-06T02:20:26+08:00" }, "published_scope": { "name": "published_scope", "description": "The published scope of product sales channels. The value of this field is fixed to `web`, indicating an online store. ", "type": "string" }, "spu": { "name": "spu", "description": "The identifier customized for the product by the merchant.", "type": "string", "example": "S00000001" }, "status": { "name": "status", "description": "The status of the product. Valid values are:\n- `active`: products on shelves\n- `draft`: products off shelves\n- `archived`: products archiving", "type": "string" }, "subtitle": { "name": "subtitle", "description": "The subtitle of the product.", "type": "string", "example": "This is a subtitle" }, "tags": { "name": "tags", "description": "A list of tags of the product.", "type": "string", "example": "tag1,tag2" }, "template_path": { "name": "template_path", "description": "The theme template of the product.", "type": "string", "example": "templates/product.product_template_name.json" }, "title": { "name": "title", "description": "The title of the product.", "type": "string", "example": "This is a product title" }, "updated_at": { "name": "updated_at", "description": "The date and time when the product was last updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2025-03-06T02:20:26+08:00" }, "variants": { "name": "variants", "description": "A list of product variants.", "type": "array", "items": { "type": "object", "properties": { "barcode": { "name": "barcode", "description": "The barcode of the variant.", "type": "string", "example": "T00000001" }, "compare_at_price": { "name": "compare_at_price", "description": "The original price of the variant. The value is rounded to two decimal places.", "type": "string", "example": "129.99" }, "id": { "name": "id", "description": "The unique identifier for the variant.", "type": "string", "example": "18057039439794751459380282" }, "image": { "name": "image", "description": "The image of the variant.", "type": "object", "properties": { "alt": { "name": "alt", "description": "The alternative textual description of the variant image, usually a word or phrase with the characteristics or content of the image.", "type": "string", "example": "This is an image alt." }, "src": { "name": "src", "description": "The link to the variant image, represented as a URL.", "type": "string", "example": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "example": { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } }, "inventory_item_id": { "name": "inventory_item_id", "description": "The unique identifier for the inventory item.", "type": "string", "example": "59854602422372317075" }, "inventory_policy": { "name": "inventory_policy", "description": "Indicates whether the variant is allowed to be oversold.\n- `deny`: Does not allow overselling.\n- `continue`: Allow overselling.", "type": "string" }, "inventory_quantity": { "name": "inventory_quantity", "description": "The total inventory quantity at all storage locations.", "type": "integer", "example": 99 }, "inventory_tracker": { "name": "inventory_tracker", "description": "Indicates whether the inventory tracking is enabled.\n- ` true`: Inventory tracking is enabled.\n- ` false`: Inventory tracking is not enabled.", "type": "boolean" }, "option1": { "name": "option1", "description": "Information of the first option of the variant.", "type": "string", "example": "red" }, "option2": { "name": "option2", "description": "Information of the second option of the variant.", "type": "string", "example": "xl" }, "option3": { "name": "option3", "description": "Information of the third option of the variant.", "type": "string", "example": "cotton" }, "option4": { "name": "option4", "description": "Information of the fourth option of the variant.", "type": "string", "example": "short" }, "option5": { "name": "option5", "description": "Information of the fifth option of the variant.", "type": "string", "example": "casual" }, "price": { "name": "price", "description": "The selling price of the variant. The value is rounded to two decimal places.", "type": "string", "example": "90.22" }, "product_id": { "name": "product_id", "description": "The unique identifier for the product corresponding to the variant.", "type": "string", "example": "16057039432335097907370282" }, "required_shipping": { "name": "required_shipping", "description": "Indicates whether the variant is required to be shipped.\n- `true`: Shipping is required.\n- `false`: Shipping is not required.", "type": "boolean" }, "sku": { "name": "sku", "description": "The identifier customized for the product variant by the merchant. ", "type": "string", "example": "S00000001" }, "taxable": { "name": "taxable", "description": "Indicates whether the variant is subject to tax.\n- `true`: Tax is required.\n- `false`: Tax is not required.", "type": "boolean" }, "title": { "name": "title", "description": "The title of the variant, assembled from the option value of the variant.", "type": "string", "example": "red · xl" }, "weight": { "name": "weight", "description": "The weight of the variant. The value is rounded up if it exceeds two decimal places.", "type": "string", "example": "0.23" }, "weight_unit": { "name": "weight_unit", "description": "The unit of weight for the variant. Valid values are:\n- `g`: gram\n- `kg`: kilogram\n- `lb`: pound\n- `oz`: ounce\n- `zh_kg`: kilogram", "type": "string" } }, "example": { "barcode": "T00000001", "compare_at_price": "129.99", "id": "18057039439794751459380282", "image": { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" }, "inventory_item_id": "59854602422372317075", "inventory_policy": null, "inventory_quantity": 99, "inventory_tracker": null, "option1": "red", "option2": "xl", "option3": "cotton", "option4": "short", "option5": "casual", "price": "90.22", "product_id": "16057039432335097907370282", "required_shipping": null, "sku": "S00000001", "taxable": null, "title": "red · xl", "weight": "0.23", "weight_unit": null } }, "example": [ { "barcode": "T00000001", "compare_at_price": "129.99", "id": "18057039439794751459380282", "image": { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" }, "inventory_item_id": "59854602422372317075", "inventory_policy": null, "inventory_quantity": 99, "inventory_tracker": null, "option1": "red", "option2": "xl", "option3": "cotton", "option4": "short", "option5": "casual", "price": "90.22", "product_id": "16057039432335097907370282", "required_shipping": null, "sku": "S00000001", "taxable": null, "title": "red · xl", "weight": "0.23", "weight_unit": null } ] }, "vendor": { "name": "vendor", "description": "The brand or vendor of the product.", "type": "string", "example": "SHOPLINE" } }, "example": { "body_html": null, "created_at": "2025-03-06T02:20:26+08:00", "handle": "product-handle", "id": "16057850264845250791280282", "image": { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" }, "images": [ { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } ], "options": [ { "id": "16158068291703878544960282", "name": "Color", "option_values": [ { "id": "16050375155238626683133099", "value": "Red" } ], "product_id": "16057850264845250791280282", "values": [ "[\"Red\", \"Green\", \"White\"]" ], "values_images": { "Red": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" } } ], "path": "/products/clothes", "product_behavior": "RISK,HIDDEN", "product_category": "Electronic", "product_type": null, "published_at": "2025-03-06T02:20:26+08:00", "published_scope": null, "spu": "S00000001", "status": null, "subtitle": "This is a subtitle", "tags": "tag1,tag2", "template_path": "templates/product.product_template_name.json", "title": "This is a product title", "updated_at": "2025-03-06T02:20:26+08:00", "variants": [ { "barcode": "T00000001", "compare_at_price": "129.99", "id": "18057039439794751459380282", "image": { "alt": "This is an image alt.", "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png" }, "inventory_item_id": "59854602422372317075", "inventory_policy": null, "inventory_quantity": 99, "inventory_tracker": null, "option1": "red", "option2": "xl", "option3": "cotton", "option4": "short", "option5": "casual", "price": "90.22", "product_id": "16057039432335097907370282", "required_shipping": null, "sku": "S00000001", "taxable": null, "title": "red · xl", "weight": "0.23", "weight_unit": null } ], "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)." } }, "method": "post", "info": { "title": "Product created", "version": "v20270301" } } ```