Create a sales plan group

Requires write_selling_plan_group access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260301/selling_plan_groups/selling_plan_group.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
  • merchant_code string
    Code to show to seller
    Example: Subscription plan group default name
  • name string required
    Name of sales program group to show buyers
    Example: Subscription plan group default name
  • options array
    List of sales plan group options
    Example: ["[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]"]
  • position integer
    Display position , the smaller the more front
    Example: 1
  • product_ids array
    Product listing for binding
    Example: ["[\"16057039432335097907370282\"]"]
  • selling_plans_to_createobject[] required
    List of sales plans created
  • description string
    Description of sales plan to show to buyers
    Example: This is a description
  • name string required
    Name of sales plan to show to buyers
    Example: Subscription plan group default name
  • options array
    List of sales plan options
    Example: ["[\"Delivery every 10 days\"]"]
  • 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 amount , value range : [ 0 , 99999999999.99] , precision retention of two decimal points , rounding
    Example: 10
  • percentage string
    Deduction percentage , value range : [ 0 , 100] , precision retention whole number , rounding
    Example: 10.5
  • policy_type string
    Strategy type : FIXED- fixed price strategy
    Example: FIXED
  • billing_policyobject required
    Billing strategy
  • policy_type string
    Strategy type : RECURRING- periodic billing strategy
    Example: RECURRING
  • recurringobject
    Periodic billing strategy
  • interval string
    Billing frequency unit : DAY、MONTH、WEEK、YEAR , default MONTH
    Example: DAY
  • interval_count integer
    Billing interval , default is 1
    Example: 10
  • max_cycles integer
    Maximum billing cycle
    Example: 1
  • min_cycles integer
    Minimum billing cycle
    Example: 1
  • description string
    Show the description to the seller
    Example: This is a description
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • selling_plan_groupobject
    Sales plan group
  • id string
    Sales plan group id
    Example: 14156200245844372441120009
  • position integer
    Display position , the smaller the more front
    Example: 1
  • description string
    Show the description to the seller
    Example: This is a description
  • merchant_code string
    Name of the sales plan group to show to the seller
    Example: Subscription plan group default name
  • name string
    Sales plan group name
    Example: Subscription plan group default name
  • product_ids array
    Product id list for binding
    Example: ["[\"16057039432335097907370282\"]"]
  • app_id string
    Sales channel id
    Example: c41ac9e6736785502d2333d1b1153aca795075c3
  • options array
    List of sales program group options
    Example: ["[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]"]
  • selling_plansobject[]
    Sales program list
  • id string
    Sales plan id
    Example: 14156200245844372441120009
  • name string
    Name of sales plan to show to buyers
    Example: delivery every 1 weeks
  • options array
    List of sales plan options
    Example: ["[\"Delivery every 10 days\"]"]
  • position integer
    Display position , the smaller the more front
    Example: 1
  • pricing_policiesobject[]
    Price policy
  • fixedobject
    Fixed price policy content
  • adjustment_valueobject
    Discount value
  • fixed_value string
    Deduction amount , value range : [ 0 , 99999999999.99] , precision retention of two decimal points , rounding
    Example: 10
  • percentage string
    Deduction percentage , value range : [ 0 , 100] , precision retention whole number , rounding
    Example: 10.5
  • adjustment_type string
    Discount type : FIXED_AMOUNT- minus , PERCENTAGE- discount
    Example: FIXED_AMOUNT
  • policy_type string
    Strategy type : FIXED- fixed price strategy
    Example: FIXED
  • billing_policyobject
    Billing strategy
  • policy_type string
    Strategy type : RECURRING- periodic billing strategy
    Example: RECURRING
  • recurringobject
    Periodic billing strategy
  • interval string
    Billing frequency unit : DAY、MONTH、WEEK、YEAR , default MONTH
    Example: DAY
  • interval_count integer
    Billing interval , default is 1
    Example: 10
  • max_cycles integer
    Maximum billing cycle
    Example: 1
  • min_cycles integer
    Minimum billing cycle
    Example: 1
  • description string
    Description of sales plan to show to buyers
    Example: This is a description
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required

Body

required
{
  "options": [
    "[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]"
  ],
  "position": 1,
  "product_ids": [
    "[\"16057039432335097907370282\"]"
  ],
  "selling_plans_to_create": [
    {
      "description": "This is a description",
      "name": "Subscription plan group default name",
      "options": [
        "[\"Delivery every 10 days\"]"
      ],
      "position": 1,
      "pricing_policies": [
        {
          "fixed": {
            "adjustment_type": "FIXED_AMOUNT",
            "adjustment_value": {
              "percentage": "10.5",
              "fixed_value": "10"
            }
          },
          "policy_type": "FIXED"
        }
      ],
      "billing_policy": {
        "recurring": {
          "interval": "DAY",
          "interval_count": 10,
          "max_cycles": 1,
          "min_cycles": 1
        },
        "policy_type": "RECURRING"
      }
    }
  ],
  "description": "This is a description",
  "merchant_code": "Subscription plan group default name",
  "name": "Subscription plan group default name"
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/selling_plan_groups/selling_plan_group.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Create
Request
{
  "merchant_code": "Subscriptionplangroupdefaultname",
  "options": [
    "deliveryevery1months"
  ],
  "position": 1,
  "product_ids": [
    "16060878916899800731963144"
  ],
  "app_id": "c41ac9e6736785502d2333d1b1153aca795075c4",
  "description": "Thisisadescription",
  "name": "Subscriptionplangroupdefaultname",
  "selling_plans_to_create": [
    {
      "description": "Thisisadescription",
      "id": "14156200245844372441120009",
      "name": "deliveryevery1weeks",
      "options": [
        "Deliveryevery10days"
      ],
      "position": 1,
      "pricing_policies": [
        {
          "fixed": {
            "adjustment_value": {
              "fixed_value": "10",
              "percentage": "10.5"
            },
            "adjustment_type": "FIXED_AMOUNT"
          },
          "policy_type": "FIXED"
        }
      ],
      "billing_policy": {
        "policy_type": "RECURRING",
        "recurring": {
          "min_cycles": 1,
          "interval": "DAY",
          "interval_count": 10,
          "max_cycles": 1
        }
      }
    }
  ],
  "id": "14156200245844372441120009"
}
Response
{
  "selling_plan_group": {
    "description": "Thisisadescription",
    "position": 1,
    "selling_plans": [
      {
        "description": "Thisisadescription",
        "id": "14160881232364316992693144",
        "name": "deliveryevery1weeks",
        "options": [
          "Deliveryevery10days"
        ],
        "position": 1,
        "pricing_policies": [
          {
            "fixed": {
              "adjustment_type": "FIXED_AMOUNT",
              "adjustment_value": {
                "fixed_value": "10.00"
              }
            },
            "policy_type": "FIXED"
          }
        ],
        "billing_policy": {
          "policy_type": "RECURRING",
          "recurring": {
            "max_cycles": 1,
            "min_cycles": 1,
            "interval": "DAY",
            "interval_count": 10
          }
        }
      }
    ],
    "id": "14060881232364316992673144",
    "product_ids": [
      "16060878916899800731963144"
    ],
    "merchant_code": "Subscriptionplangroupdefaultname",
    "options": [
      "deliveryevery1months"
    ],
    "app_id": "111afe2f9baceb93004af92b1276582619f1db26",
    "name": "Subscriptionplangroupdefaultname"
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.