Sales plan group update
Event Group | Event Identification |
---|---|
sellingplan | sellingplan/update |
Update sales program group
Request Headers
- X-Shopline-Topic string requiredEvent operation identificationExample:
orders/edited
- X-Shopline-Hmac-Sha256 string requiredSignatureExample:
XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
- X-Shopline-Shop-Domain string requiredShop domainExample:
shophub.myshopline.com
- X-Shopline-Shop-Id string requiredShop IDExample:
1610418123456
- X-Shopline-Merchant-Id string requiredMerchant IDExample:
2000001234
- X-Shopline-API-Version string requiredVersionExample:
v20210901
- X-Shopline-Webhook-Id string requiredMessage IDExample:
b54557e48a5fbf7d70bcd043
Request Body
- app_id stringSales channel idExample:
c41ac9e6736785502d2333d1b1153aca795075c4
- description stringDescriptionExample:
This is a description
- id stringSales plan group idExample:
14056200245844372441100009
- merchant_code stringShow the name to the sellerExample:
Subscription plan group default name
- name stringSales program group nameExample:
Subscription plan group default name
- options arrayList of sales program group optionsExample:
["delivery every 1 months", "delivery every 2 months", "delivery every 3 months"]
- position integerDisplay locationExample:
1
- products arrayBangding id list for bindingExample:
["16057039432335097907370282"]
selling_plansobject[]
Sales program listbilling_policyobject
Billing strategypolicy_type stringStrategy type , RECURRING : periodic billing strategyExample:RECURRING
recurringobject
Periodic billing strategy contentinterval stringBilling frequency unit , DAY、MONTH、WEEK、YEARExample:DAY
interval_count integerBilling intervalExample:10
max_cycles integerMaximum billing cycleExample:1
min_cycles integerMinimum billing cycleExample:1
description stringSales plan descriptionExample:This is a description
id stringSales plan idExample:14156213099368001129110062
name stringSales program nameExample:delivery every 1 weeks
options arrayList of sales program optionsExample:["Delivery every 10 days"]
position integerDisplay position , the smaller the more frontExample:1
pricing_policiesobject[]
Price policyfixedobject
Fixed price policy contentadjustment_type stringDiscount type , FIXED_AMOUNT : minus , PERCENTAGE : discountExample:FIXED_AMOUNT
adjustment_valueobject
Discount valuefixed_value stringDeduction fixed amountExample:10
percentage stringSubtraction percentageExample:10
policy_type stringStrategy type , FIXED : fixed price strategyExample:FIXED
Response
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?