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/v20261201/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 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 eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
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
  • collection_listingsobject[]
    Collection list
  • title string
    Collection title
    Example: This is a collection title
  • 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
  • created_at string
    Creation time
    Example: 2021-09-02T14:11:54+00:00
  • updated_at string
    Update time
    Example: 2021-09-03T14:11:54+00:00
  • 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
  • rulesobject[]
    Smartly add condition
  • 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
  • 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
  • template_path string
    Theme template
    Example: templates/sortation/detail.json
  • 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
  • handle string
    Collection Handle
    Example: This is a collection Handle
  • published_scope string
    Set the sales channel , when the value is " web " , it means online stores
    Example: web
  • 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
  • body_html string
    Collection description
    Example: This is a collection description
  • collection_type string
    Collection type : custom- manual , smart- smart
    Example: smart
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

— header required
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/collection_listings.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Paging query
Response
{
  "collection_listings": [
    {
      "updated_at": "2023-08-28T19:05:42+08:00",
      "collection_type": "custom",
      "published_scope": "web",
      "title": "First Custom Collection",
      "sort_order": "manual",
      "created_at": "2023-06-12T14:19:35+08:00",
      "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>",
      "image": {
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a.png?w=1024&h=1024",
        "alt": "This is a alt"
      },
      "published_at": "2023-06-12T14:19:35+08:00",
      "handle": "first",
      "id": "12259764246208273857373144"
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2026 SHOPLINE Limited.