Add product collection to sales channels

Event Group	Event Identification
collection_listings	collection_listings/add

Sales channel classification add notifications

Request Headers

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

collection_listingobject

Collection information
bannerobject

Collection banner
alt string

Image alt
Example: This is a image alt
src string

Image src
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
body_html string

Collection description
Example: This is a description
collection_type string

Collection type : custom- manual , smart- smart
Example: custom
created_at string

Creation time
Example: 2021-09-03T14:11:54+00:00
disjunctive string

The relationship between the conditions of the intelligent collection box and the Product is fixed . true : Product meets any conditions and can be incorporated into this intelligent collection ; false : Product must meet all conditions and must be fully compliant to be incorporated into this intelligent collection
Example: true
handle string

Collection Handle
Example: collection-handle
id string

id
Example: 12253400918743462093302234
imageobject

Collection images
column string

Image alt
Example: This is a image alt
src string

Image src
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
published_at string

Time to post to online stores
Example: 2021-09-03T14:11:54+00:00
published_scope string

Set the sales channel , when the value is " web " , it means online stores
Example: web
rulesobject[]

Smartly add condition
column string

Conditions variable , title : title , selling price : sale_price , original price : compared_at_price , tag : tag , inventory : inventory , supplier : vendor ,Weight : variant_weight , specification name : variant_title , created time : created_at , sales : sales , browsing : view , purchase : add_to_cart ,Custom type : type , standardized product type : product_taxonomy_node_id , field of origin : product_metafield_definition
Example: product_metafield_definition
condition string

Conditions
Example: true
relation string

The if-else statement is equal to : equals , not equal to : not_equals , the beginning is : starts_with , the end is : ends_with , including : contains , not included : not_contains ,Greater than : greater_than , less than : less_than
Example: equals
sort_order string

Sort by , hot sale : best-selling , product name from a-z : alpha-asc , product name from z-a : alpha-desc , new update time → old : updated-desc , old update time → new : updated-as
Example: updated-desc
template_path string

Theme template
Example: templates/sortation/detail.json
title string

Collection title
Example: This is a title
updated_at string

Update time
Example: 2021-09-03T14:11:54+00:00

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