Add collection to sales channels

Requires write_product_listings access scope.

For more info , refer to:

[]

access permission

PUT https://{handle}.myshopline.com/admin/openapi/v20250601/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 required
[]
Category id 1
[]
Example: 12248721639068681442230282

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

Request Body

collection_listingobject
[]
collection information
collection_listing_id string
[]
collection id
[]
Example: 12248721639068681442230283

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

collection_listingobject
[]
Collection information
bannerobject
[]
Collection banner
alt string
[]
alt
[]
Example: This is the image alt
src string
[]
src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
body_html string
[]
Collection description
[]
Example: This is the description
collection_type string
[]
Collection type : custom , smart
[]
Example: smart
created_at string
[]
Creation time
[]
Example: 2021-09-03T14: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: collection-handle
id string
[]
Collection id
[]
Example: 12248721639068681442230284
imageobject
[]
Ccollection 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
[]
Condition variable
[]
Example: product_metafield_definition
condition string
[]
Conditions
[]
Example: true
condition_object_id long
[]
The ID of the metafield object
[]
Example: 483749284
relation string
[]
If-else statement
[]
Example: equals
sort_order string
[]
Hot 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-rat
[]
Example: add-to-cart-desc
template_path string
[]
Template path
[]
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

collection_listing_id — path required

Authorization — header required

Body

Body required

{
  "collection_listing": {
    "collection_listing_id": "12248721639068681442230283"
  }
}

Language

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