Query sales program group details

Requires read_selling_plan_group access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/selling_plan_group/:selling_plan_group_id.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 .
Path Parameters
  • selling_plan_group_id string required
    Sales plan group id
    Example: 14056200245844372441100010
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
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 details
  • description string
    Description
    Example: This is a description
  • app_id string
    Sales channel id
    Example: c41ac9e6736785502d2333d1b1153aca795075c4
  • id string
    Sales plan group id
    Example: 14056200245844372441100009
  • name string
    Sales plan group name
    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 location
    Example: 1
  • merchant_code string
    Show the name to the seller
    Example: Subscription plan group default name
  • product_ids array
    product id list for binding
    Example: ["[\"16057039432335097907370282\"]"]
  • selling_plansobject[]
    Sales plan list
  • 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.5
  • 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 content
  • min_cycles integer
    Minimum billing cycle
  • interval string
    Billing frequency unit : DAY、MONTH、WEEK、YEAR
    Example: DAY
  • interval_count integer
    Billing interval , default is 1
    Example: 10
  • max_cycles integer
    Maximum billing cycle
    Example: 1
  • description string
    Sales plan description
    Example: This is a description
  • id string
    Sales plan id
    Example: 14156200245844372441120009
  • name string
    Sales plan name
    Example: Delivery every 10 days
  • options array
    List of sales plan options
    Example: ["[\"Delivery every 10 days\"]"]
  • position integer
    Display position , the smaller the more front
    Example: 1
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— path required
— header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/selling_plan_group/selling_plan_group_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Query details
Response
{
  "selling_plan_group": {
    "merchant_code": "Subscription plan group default name",
    "options": [
      "delivery every 1 months"
    ],
    "position": 1,
    "product_ids": [
      "16060878906566210188893144"
    ],
    "name": "Subscription plan group default name",
    "app_id": "111afe2f9baceb93004af92b1276582619f1db26",
    "description": "This is a description",
    "id": "14060881260524538485193144",
    "selling_plans": [
      {
        "options": [
          "Delivery every 10 days"
        ],
        "position": 1,
        "pricing_policies": [
          {
            "fixed": {
              "adjustment_value": {
                "fixed_value": "10.00"
              },
              "adjustment_type": "FIXED_AMOUNT"
            },
            "policy_type": "FIXED"
          }
        ],
        "billing_policy": {
          "policy_type": "RECURRING",
          "recurring": {
            "interval_count": 10,
            "max_cycles": 1,
            "min_cycles": 1,
            "interval": "DAY"
          }
        },
        "description": "This is a description",
        "id": "14160881260524538485213144",
        "name": "delivery every 1 weeks"
      }
    ]
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.