Query collection information by ID

Requires read_products access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/products/collections/: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 product collection information based on collection IDs. Both manual and intelligent collections can be queried
Path Parameters
  • collection_id string required
    Category id
    Example: 12257170618007271602093384
Query Parameters
  • fields string
    Specify fields, separated by ','
    Example: created_at,title,id
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
  • collectionobject
    Collection information
  • body_html string
    Description
    Example: This is a description
  • 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
  • handle string
    Collection handle
    Example: collection-handle
  • id string
    Collection id
    Example: 12257170618007271602093385
  • path string
    The relative path of the product URL in the online store, max 512 characters.
    Example: /collections/spring
  • 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
  • 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, sale_price, compared_at_price, tag , inventory, vendor, variant_weight , variant_title , created_at , sales , view , add_to_cart , product_category, product_metafield_definition, type , product_taxonomy_node_id
    Example: product_metafield_definition
  • condition string
    Value of the corresponding condition variable
    Example: true
  • condition_object_id long
    The ID of the metafield object
    Example: 483749284
  • disjunctive boolean
    Relationship between the intelligent classification box and Product conditions true : Product meets any condition and can be incorporated into the intelligent classification false : Product must meet all conditions and must be fully compliant to be incorporated into this intelligent classification
    Example: true
  • collection_type string
    Collection type : custom , smart
    Example: smart
  • title string
    title
    Example: This is a title
  • 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-asc
  • created_at string
    Creation time
    Example: 2021-09-03T14:11:54+00:00
  • updated_at string
    Update time
    Example: 2021-09-03T14:11:54+00:00
  • template_path string
    Theme template
    Example: templates/sortation/detail.json
  • published_at string
    Time to post to the online store
    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
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/collections/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
Specify fields
Response
{
  "collection": {
    "title": "First Custom Collection",
    "created_at": "2023-06-12T14:19:35+08:00",
    "id": "12259764246208273857373144"
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.