Query specify collection in sales channels
GET https://{handle}.myshopline.com/admin/openapi/v20210901/collection_listings/:collection_listing_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
.Path Parameters
- collection_listing_id string requiredcollection id
Request Headers
- Content-Type requiredThe value of this field is fixed to
application/json; charset=utf-8
- Authorization string requiredThe 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
- 200
- 401
- 429
For more information about status codes, see Http status code.
Response Headers
traceId
traceId
Response Body
collection_listingobject
collection informationbannerobject
collection banneralt stringalt of imagesrc stringsrc of image , the length cannot exceed 240body_html stringcollection descriptioncollection_type stringcollection type : custom , smartcreated_at stringCreation timedisjunctive booleanSmart relationship between add conditions :- and : true
- or : false
handle stringcollection Handleid stringcollection idimageobject
collection imagesalt stringalt of imagesrc stringsrc of image , the length cannot exceed 240published_at stringPosted to " online store " timepublished_scope stringThe launch range , when the value is " web " , indicates online storesrulesobject[]
Smartly add conditioncolumn stringCondition variablecondition stringConditionsrelation stringIf-else statementsort_order stringHot sale : best-selling product name from a-z : alpha-asc product name from z-a : alpha-desc update time new → old : updated-desc update time old → new : updated-asc custom created time new → old : created-desc created time old → new : created-asc sku minimum selling price ascending : price-asc sku minimum selling price descending : price-desc browse in almost 90 days descending : vIew-desc added purchase in nearly 90 days descending : add-to-cart-desc CONVERSION RATES descending : conversion-rattemplate_path stringtitle stringcollection titleupdated_at stringUpdate time
API Explorer
Debugger
Was this article helpful to you?
Error loading component.