Sales plan group creation

Event GroupEvent Identification
sellingplansellingplan/create
Create a sales program group
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
  • app_id string
    Sales channel id
    Example: c41ac9e6736785502d2333d1b1153aca795075c4
  • description string
    Description
    Example: This is a description
  • id string
    Sales plan group id
    Example: 14056200245844372441100009
  • merchant_code string
    Show the name to the seller
    Example: Subscription plan group default name
  • name string
    Sales program group name
    Example: Subscription plan group default name
  • options array
    List of sales program group options
    Example: ["[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]"]
  • position integer
    Display location
    Example: 1
  • product_variant_ids array
    List of variant IDs.
    Example: ["[\"18065954560435138250532015\"]"]
  • products array
    Bangding id list for binding
    Example: ["[\"16057039432335097907370282\"]"]
  • selling_plansobject[]
    Sales program list
  • billing_policyobject
    Billing strategy
  • policy_type string
    Strategy type , RECURRING : periodic billing strategy
    Example: RECURRING
  • recurringobject
    Periodic billing strategy content
  • interval string
    Billing frequency unit , DAY、MONTH、WEEK、YEAR
    Example: DAY
  • interval_count integer
    Billing interval
    Example: 10
  • max_cycles integer
    Maximum billing cycle
    Example: 1
  • min_cycles integer
    Minimum billing cycle
    Example: 1
  • description string
    Sales plan description
    Example: This is a description
  • id string
    Sales plan id
    Example: 14156213099368001129110062
  • name string
    Sales program name
    Example: delivery every 1 weeks
  • options array
    List of sales program options
    Example: ["[\"Delivery every 10 days\"]\n"]
  • position integer
    Display position , the smaller the more front
    Example: 1
  • pricing_policiesobject[]
    Price policy
  • fixedobject
    Fixed price policy content
  • adjustment_type string
    Discount type , FIXED_AMOUNT : minus , PERCENTAGE : discount
    Example: FIXED_AMOUNT
  • adjustment_valueobject
    Discount value
  • fixed_value string
    Deduction fixed amount
    Example: 10
  • percentage string
    Subtraction percentage
    Example: 10
  • policy_type string
    Strategy type , FIXED : fixed price strategy
    Example: FIXED
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
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.