Query collection of sales channels

Requires read_product_listings access scope.

For more info , refer to:

[]

access permission

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

limit integer
[]
Limit of query, default 50 , can not exceed 500
[]
Example: 50

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

collection_listingsobject[]
[]
Collection list
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 collection description
collection_type string
[]
Collection type : custom- manual , smart- smart
[]
Example: smart
created_at string
[]
Creation time
[]
Example: 2021-09-02T14: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: This is a collection Handle
id string
[]
Collection id
[]
Example: 12248721639068681442230282
imageobject
[]
Collection images
alt string
[]
Image alt
[]
Example: This is the image alt
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
published_at string
[]
Time to post to the online store
[]
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
[]
Conditions variable , title : title , selling price : sale_price , original price : compared_at_price , tag : tag , inventory : inventory , supplier : vendor ,Weight : variant_weight , specification name : variant_title , created time : created_at , sales : sales , browsing : view , purchase : add_to_cart ,Custom type : type , standardized product type : product_taxonomy_node_id , field of origin : product_metafield_definition
[]
Example: tag
condition string
[]
Conditions
[]
Example: This is a tag condition value
condition_object_id long
[]
The ID of the metafield object
[]
Example: 483749285
relation string
[]
The if-else statement is equal to : equals , not equal to : not_equals , the beginning is : starts_with , the end is : ends_with , including : contains , not included : not_contains ,Greater than : greater_than , less than : less_than
[]
Example: equals
sort_order string
[]
Product name , 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-desc
template_path string
[]
Theme template
[]
Example: templates/sortation/detail.json
title string
[]
Collection title
[]
Example: This is a collection title
updated_at string
[]
Update time
[]
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

limit — query

Language

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