Batch query intelligent collection

Requires read_products access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/products/smart_collections.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 .

[]

Batch query for intelligent collection information in the store. You can use this API to query all or specific intelligent classification descriptions, conditions, IDs, and other related information in your store. If the queried intelligent classification does not exist, an empty set will be returned.

Query Parameters

fields string
[]
Return field , separated by ','
[]
Example: title,handle
handle string
[]
The collection handle, a unique identifier automatically generated based on the collection title. Changing the collection title will not update the handle.
[]
Example: collection-handle
ids string
[]
collection id , multiple separated by ','
[]
Example: 12257170618007271602093384, 12257170618007271602083384
limit integer
[]
Limit of query , default 50 , can not exceed 250
[]
Example: 100
page_info string
[]
The call party does not require use and attention to this field , automatically encapsulated by Shopline
[]
Example: eyJzaW5jZUlkIjoiMTIyNTcxNzA2MTgwMDcyNzE2MDIwOTMzODQiLCJkaXJlY3Rpb24iOiJuZXh0In0=
since_id string
[]
Start with specify collection id query
[]
Example: 12257170618007271602093384
title string
[]
Collection title
[]
Example: This is a title
updated_at_max string
[]
Update time before xxx ( format see IOS8601 )
[]
Example: 2021-09-03T14:11:54+00:00
updated_at_min string
[]
Update time starts with xxx ( format see IOS8601 )
[]
Example: 2021-09-04T14:11:54+00:00

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

link
[]
Page-turning information
traceId
[]
traceId

Response Body

smart_collectionsobject[]
[]
Intelligent collection
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: This is a description
created_at string
[]
Create time of the intelligent collection. The time format follows the ISO 8601 international standard.
[]
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
[]
The collection handle, a unique identifier automatically generated based on the collection title. Changing the collection title will not update the 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
[]
Image 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. The time format follows the ISO 8601 international standard.
[]
Example: 2021-09-03T14:11:54+00:00
published_scope string
[]
Set the launch range , when the value is " web " , it means online stores
[]
Example: web
rulesobject[]
[]
Set the sales channel , when the value is " web " , it means online stores
column string
[]
Condition variable
[]
Example: product_metafield_definition
condition string
[]
Conditions
[]
Example: true
condition_object_id long
[]
The ID of the metafield object
[]
Example: 483749284
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 of the intelligent collection. The time format follows the ISO 8601 international standard.
[]
Example: 2021-09-03T14:11:54+00:00

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

fields — query

handle — query

ids — query

limit — query

page_info — query

since_id — query

title — query

updated_at_max — query

updated_at_min — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/products/smart_collections.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal