Query manual collection attributes by ID

Requires read_products access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/products/custom_collections/:custom_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 a manual product collection based on the ID
Path Parameters
  • custom_collection_id string required
    Manual 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
  • custom_collectionobject
    Manually collection information
  • template_path string
    Theme template
    Example: templates/sortation/detail.json
  • title string
    Collection name
    Example: This is a title
  • updated_at string
    Update time
    Example: 2021-09-03T14:11:54+00:00
  • bannerobject
    Collection banner
  • alt string
    Image alt
    Example: This is a image alt
  • src string
    Image src
    Example: https://img.myshopline.com/image/official/e46e6189dd4641a3b179444cacdcdd2a.png
  • imageobject
    Collection images
  • src string
    Image src
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • alt string
    Image alt
    Example: This is a image alt
  • 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
  • body_html string
    Collection description
    Example: This is a description
  • created_at string
    Creation time
    Example: 2021-09-03T14:11:54+00:00
  • handle string
    Collection handle
    Example: collection-handle
  • id string
    Collection id
    Example: 12257170618007271602093384
  • path string
    The relative path of the product URL in the online store, max 512 characters.
    Example: /collections/spring
  • 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
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— path required
— header required
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/products/custom_collections/custom_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
{
  "custom_collection": {
    "sort_order": "manual",
    "template_path": "templates/collection.html",
    "banner": {
      "alt": "This is a alt",
      "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a.png?w=1024&h=1024"
    },
    "handle": "first",
    "updated_at": "2023-08-28T19:34:00+08:00",
    "body_html": "<p>This is a desription</p>",
    "published_at": "2023-06-12T14:19:35+08:00",
    "title": "First Custom Collection",
    "id": "12259764246208273857373144",
    "image": {
      "alt": "This is a alt",
      "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a.png?w=1024&h=1024"
    },
    "published_scope": "web",
    "created_at": "2023-06-12T14:19:35+08:00"
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.