Add Product to sales channels
| Event Group | Event Identification |
|---|---|
| product_listings | product_listings/add |
Add Product to sales channels
Request Headers
- X-Shopline-Topic string requiredThe unique identifier for the event.Example:
orders/edited - X-Shopline-Hmac-Sha256 string requiredThe 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 requiredThe store domain.Example:
example.myshopline.com - X-Shopline-Shop-Id string requiredThe store ID.Example:
1610418123456 - X-Shopline-Merchant-Id string requiredThe merchant ID.Example:
2000001234 - X-Shopline-API-Version string requiredThe API version.Example:
v20250601 - X-Shopline-Webhook-Id string requiredThe ID of this Webhook event.Example:
b54557e48a5fbf7d70bcd043
Request Body
product_listingobject
Product informationbody_html stringProduct descriptionExample:This is a descriptioncreated_at stringProduct create timeExample:2023-03-02T18:18:42.883+0800handle stringGlobal unique Product handleExample:proudct-handleid stringProduct IDExample:16058287356753559620272670imagesobject[]
Product main image listingalt stringPicture altExample:This is a image altsrc stringImage URLExample:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngoptionsobject[]
Option listid stringOption idExample:16158288104774469113452670name stringOption nameExample:Coloroption_valuesobject[]
List of option values.id stringThe ID of option value.Example:16247051995358890915900034value stringThe option value.Example:Redproduct_id stringDuiying id correspondingExample:16058287356753569620272670values arrayList of options valueExample:["[\"Red\", \"Green\", \"White\"]"]values_images mapOption value chartExample:{}product_behavior stringProduct behaviorExample:RISK,HIDDENproduct_category stringProduct polymer typeExample:Electronicproduct_type stringProduct typeExample:Electronicpublished_at stringTime to post to online storesExample:2023-03-02T18:18:42.883+0800published_scope stringLaunch range , " web " means online storesExample:webspu stringSize s puExample:S000000001status stringProduct status : active- on shelf , draft- off shelf , archived- filingExample:activesubtitle stringProduct summaryExample:This is a subtitletags stringTag , multiple separated by ','Example:tag1,tag2template_path stringTheme templateExample:templates/products/detail.jsontitle stringProduct titleExample:This is a titleupdated_at stringProduct update timeExample:2023-03-02T18:18:42.883+0800variantsobject[]
Style listbarcode stringBar codeExample:B0000000001compare_at_price stringOriginal priceExample:1id stringStyle idExample:18058288104774469113432670imageobject
Style chartalt stringPicture altExample:This is a image altsrc stringImages srcExample:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pnginventory_policy stringAllows oversold , continue or not : allowed , deny : not allowedExample:continueinventory_quantity integerSuoyou summary of all locationsExample:1inventory_tracker booleanTrack inventory or notExample:trueoption1 stringValue for the first option that this style corresponds toExample:Redoption2 stringValue for the second option that this style corresponds toExample:Loption3 stringValue for the third option that this style corresponds tooption4 stringValue of the fourth option that this style corresponds tooption5 stringValue for the fifth option that this style corresponds toprice stringSelling priceExample:1product_id stringDuiying id correspondingExample:16058287356753569620272670required_shipping booleanShipping or notsku stringSkuExample:B0000001taxable booleanTax or not?title stringStyle titleExample:Red/Lweight stringWeightExample:1weight_unit stringWeight unit , g : g , kg : kg , lb : lb , oz : ozExample:gvendor stringProduct manufacturerExample:Shopline
Status Codes
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OKFor more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?