Query intelligent collection attributes by ID

Requires read_products access scope.

For more info, refer to:

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

smart_collectionobject

Intelligent collection information
template_path string

Theme template
Example: templates/sortation/detail.json
id string

Collection id
Example: 12257170618007271602093384
rulesobject[]

Smartly add condition
condition string

Conditions
Example: true
condition_object_id long

The ID of the metafield object
Example: 459302847
relation string

If-else statement
Example: equals
column string

Condition variable
Example: product_metafield_definition
updated_at string

Update time
Example: 2021-09-03T14:11:54+00:00
bannerobject

Collection banner
src string

Image src
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
alt string

Image alt
Example: This is a image alt
handle string

Collection handle
Example: collection-handle
path string

The relative path of the product URL in the online store, max 512 characters.
Example: /collections/spring
created_at string

Creation time
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
body_html string

Collection description
Example: I am a collection description
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
title string

Collection title
Example: This is a title
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
published_at string

Time to post to online stores
Example: 2021-09-03T14:11:54+00:00
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

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

smart_collection_id — path required

Authorization — header required

fields — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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'

Was this article helpful to you?

SHOPLINE

Legal