Query intelligent collection attributes by ID

Requires read_products access scope.
For more info , refer to:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/products/smart_collections/:smart_collection_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 .
Query an intelligent product collection based on the ID
Path Parameters
  • smart_collection_id string required
    Intelligent collection id
    Example: 12257170618007271602093384
Query Parameters
  • fields string
    Return field , separated by ','
    Example: title,handle
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
Response
For more information about status codes, see Http status code.
Response Headers
  • traceId
    traceId
Response Body
  • smart_collectionobject
    Intelligent collection information
  • bannerobject
    Collection banner
  • alt string
    Image alt
    Example: This is a image alt
  • src string
    Image src
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • body_html string
    Collection description
    Example: I am a collection description
  • created_at string
    Creation time
    Example: 2021-09-03T14:11:54+00:00
  • disjunctive boolean
    The relationship between the conditions of the intelligent collection box and the Product is fixed . true : Product meets any conditions and can be incorporated into this intelligent collection ; false : Product must meet all conditions and must be fully compliant to be incorporated into this intelligent collection
    Example: true
  • handle string
    Collection handle
    Example: collection-handle
  • id string
    Collection id
    Example: 12257170618007271602093384
  • imageobject
    Collection images
  • alt string
    image alt
    Example: This is a image alt
  • src string
    Images src
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • path string
    The relative path of the product URL in the online store, max 512 characters.
    Example: /collections/spring
  • published_at string
    Time to post to online stores
    Example: 2021-09-03T14:11:54+00:00
  • published_scope string
    Set the sales channel , when the value is " web " , it means online stores
    Example: web
  • rulesobject[]
    Smartly add condition
  • column string
    Condition variable
    Example: product_metafield_definition
  • condition string
    Conditions
    Example: true
  • condition_object_id long
    The ID of the metafield object
    Example: 459302847
  • relation string
    If-else statement
    Example: equals
  • sort_order string
    Sort by , hot sale : best-selling , product name from a-z : alpha-asc , product name from z-a : alpha-desc , new update time → old : updated-desc ,Update time old → new : updated-asc , custom : manual
    Example: updated-asc
  • template_path string
    Theme template
    Example: templates/sortation/detail.json
  • title string
    Collection title
    Example: This is a title
  • updated_at string
    Update time
    Example: 2021-09-03T14:11:54+00:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— path required
— header required
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/products/smart_collections/smart_collection_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 collection
Response
{
  "smart_collection": {
    "banner": {
      "alt": "This is a alt",
      "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a.png?w=1024&h=1024"
    },
    "body_html": "<p>This is a desription</p>",
    "created_at": "2023-06-12T14:21:25+08:00",
    "disjunctive": false,
    "handle": "first-zn",
    "id": "12259764264680491895113144",
    "image": {
      "alt": "This is a alt",
      "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a.png?w=1024&h=1024"
    },
    "published_at": "2023-06-12T14:21:25+08:00",
    "published_scope": "web",
    "rules": [
      {
        "column": "tag",
        "condition": "T shirt",
        "relation": "equals"
      },
      {
        "column": "sale_price",
        "condition": "10.00",
        "relation": "greater_than"
      }
    ],
    "sort_order": "manual",
    "template_path": "templates/collection.html",
    "title": "First Smart Collection",
    "updated_at": "2023-08-28T19:34:00+08:00"
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.