Create a sales plan group

Requires write_selling_plan_group access scope.
For more info , refer to:
POST https://{handle}.myshopline.com/admin/openapi/v20250601/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 required
    The value of this field is fixed to application/json; charset=utf-8
  • Authorization string required
    The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
  • description string
    Show the description to the seller
    Example: This is a description
  • 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
  • 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
    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
Response
For more information about status codes, see Http status code.
Response Headers
  • traceId
    traceId
Response Body
  • selling_plan_groupobject
    Sales plan group
  • app_id string
    Sales channel id
    Example: c41ac9e6736785502d2333d1b1153aca795075c3
  • description string
    Show the description to the seller
    Example: This is a description
  • id string
    Sales plan group id
    Example: 14156200245844372441120009
  • 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
  • options array
    List of sales program 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 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
  • 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
  • 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_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
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— header required

Body

required
{
  "description": "This is a description",
  "merchant_code": "Subscription plan group default name",
  "name": "Subscription plan group default name",
  "options": [
    "[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]"
  ],
  "position": 1,
  "product_ids": [
    "[\"16057039432335097907370282\"]"
  ],
  "selling_plans_to_create": [
    {
      "billing_policy": {
        "policy_type": "RECURRING",
        "recurring": {
          "interval": "DAY",
          "interval_count": 10,
          "max_cycles": 1,
          "min_cycles": 1
        }
      },
      "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": {
              "fixed_value": "10",
              "percentage": "10.5"
            }
          },
          "policy_type": "FIXED"
        }
      ]
    }
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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
{
  "app_id": "c41ac9e6736785502d2333d1b1153aca795075c4",
  "description": "Thisisadescription",
  "id": "14156200245844372441120009",
  "merchant_code": "Subscriptionplangroupdefaultname",
  "name": "Subscriptionplangroupdefaultname",
  "options": [
    "deliveryevery1months"
  ],
  "position": 1,
  "product_ids": [
    "16060878916899800731963144"
  ],
  "selling_plans_to_create": [
    {
      "billing_policy": {
        "policy_type": "RECURRING",
        "recurring": {
          "interval": "DAY",
          "interval_count": 10,
          "max_cycles": 1,
          "min_cycles": 1
        }
      },
      "description": "Thisisadescription",
      "id": "14156200245844372441120009",
      "name": "deliveryevery1weeks",
      "options": [
        "Deliveryevery10days"
      ],
      "position": 1,
      "pricing_policies": [
        {
          "fixed": {
            "adjustment_type": "FIXED_AMOUNT",
            "adjustment_value": {
              "fixed_value": "10",
              "percentage": "10.5"
            }
          },
          "policy_type": "FIXED"
        }
      ]
    }
  ]
}
Response
{
  "selling_plan_group": {
    "app_id": "111afe2f9baceb93004af92b1276582619f1db26",
    "description": "Thisisadescription",
    "id": "14060881232364316992673144",
    "merchant_code": "Subscriptionplangroupdefaultname",
    "name": "Subscriptionplangroupdefaultname",
    "options": [
      "deliveryevery1months"
    ],
    "position": 1,
    "product_ids": [
      "16060878916899800731963144"
    ],
    "selling_plans": [
      {
        "billing_policy": {
          "policy_type": "RECURRING",
          "recurring": {
            "interval": "DAY",
            "interval_count": 10,
            "max_cycles": 1,
            "min_cycles": 1
          }
        },
        "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"
          }
        ]
      }
    ]
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.