Product added to a sales channel

Event Group	Event Identification
product_listings	product_listings/add

Occurs whenever a product is added to a sales channel.

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.

Example: orders/edited
X-Shopline-Hmac-Sha256 string required

The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.

Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
X-Shopline-Shop-Domain string required

The store domain.

Example: example.myshopline.com
X-Shopline-Shop-Id string required

The store ID.

Example: 1610418123456
X-Shopline-Merchant-Id string required

The merchant ID.

Example: 2000001234
X-Shopline-API-Version string required

The API version.

Example: v20250601
X-Shopline-Webhook-Id string required

The ID of this Webhook event.

Example: b54557e48a5fbf7d70bcd043

Request Body

product_listingobject

The product information.
body_html string

The product description.
combined_listingobject

A combined listing object that stores the associated parent product ID and child product IDs.
combined_listing_children_ids array

A list of child product IDs in the combined listing.
Example: ["16057850264845250791280282","16057850264845250333280282"]
parent_product_id string

The parent product ID in the combined listing.
Example: 16050375155238626683133099
combined_listing_role string

The role of the product in a combined listing. Valid values are:

parent: Parent product of the combined listing.

child: Child product of the combined listing.

no_role: Non-combined standalone product.
created_at string

The date and time when the product was created. Format: ISO 8601.
Example: 2025-03-06T02:20:26+08:00
handle string

The semantically unique identifier for the product, which is generated based on title by default.
Example: product
id string

The unique identifier for the product.
Example: 16057850264845250791280282
imagesobject[]

A list of product images.

DEPRECATED：This parameter is deprecated from API version v20260301.
alt string

The alternative textual description of the product image, usually a word or phrase with the characteristics or content of the image.
Example: This is an image alt.
src string

The link to the product image.
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
optionsobject[]

A list of product options.
id string

The unique identifier for the option.
Example: 16158068291703878544960282
name string

The name of the option.
Example: Color
option_valuesobject[]

A list of product option values.
id string

The unique identifier for the option value.
Example: 16050375155238626683133099
value string

The option value.
Example: red
product_id string

The unique identifier for the product corresponding to the option.
Example: 16057850264845250791280282
values array

A list of option values.
Example: ["red","green","white"]
values_images map

The mapping relationship between the option values and the corresponding image URLs.
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.
Example: RISK, HIDDEN
product_category string

The product category customized by the merchant.
Example: Electronics
product_type string

The source of the product. Valid values are:

NORMAL: Products maintained in the SHOPLINE Admin

POD_TEMPORARY: Temporary products on the POD app

TEMPORARY: Other temporary products
published_at string

The date and time when the product was published to the online store. Format: ISO 8601.
Example: 2025-03-06T02:20:26+08:00
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. It is distinct from product.id returned by SHOPLINE.
Example: S00000001
standard_category_id string

The unique identifier for the standard product category.
Example: 3237
status string

The status of the product. Valid values are:

active: Product published

draft: Product unpublished

archived: Product archived
subtitle string

The subtitle of the product.
Example: This is a subtitle
tags string

A list of tags of the product.
Example: tag1, tag2
template_path string

The theme template of the product.
Example: templates/product.product_template_name.json
title string

The name of the product.
Example: This is a Product title
updated_at string

The date and time when the product was last updated. Format: ISO 8601.
Example: 2025-03-06T02:20:26+08:00
variantsobject[]

A list of product variants.
barcode string

The barcode of the variant.
Example: T0000001
compare_at_price string

The original price of the variant. The value is rounded to two decimal places.
Example: 129.99
id string

The unique identifier for the variant.
Example: 18057850264851626133510282
imageobject

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.
Example: This is an image alt.
src string

The link to the variant image.
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
inventory_policy string

The overselling policy for the variant. Valid values are:

deny: Does not allow overselling.

continue: Allow overselling.

inventory_quantity integer

The total inventory quantity at all storage locations.
Example: 99
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.
Example: red
option2 string

Information of the second option of the variant.
Example: xl
option3 string

Information of the third option of the variant.
Example: cotton
option4 string

Information of the fourth option of the variant.
Example: short
option5 string

Information of the fifth option of the variant.
Example: casual
price string

The selling price of the variant. The value is rounded to two decimal places.
Example: 90.22
product_id string

The unique identifier for the product corresponding to the variant.
Example: 16057850264845250791280282
required_shipping boolean

Indicates whether the variant requires shipping.

true: Shipping is required.

false: Shipping is not required.

sku string

The product SKU. It is distinct from variant.id returned by SHOPLINE.
Example: S000000001
taxable boolean

Indicates whether the variant is subject to tax.

true: Tax is required.

false: Tax is not required.

title string

The name of the variant, concatenated from its option values.
Example: red · xl
weight string

The weight of the variant. The value is rounded up to two decimal places.
Example: 0.23
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.
Example: SHOPLINE

Status Codes

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.

Was this article helpful to you?

SHOPLINE

Legal