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/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 required
[]
Category id 1

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

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
[]
Image alt
[]
Example: This is the picture alt
src string
[]
Image 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 classification box and the Product is fixed . true : Product meets any conditions and can be incorporated into this intelligent classification ; false : Product must meet all conditions and must be fully compliant to be incorporated into this intelligent classification
[]
Example: true
handle string
[]
Handle
[]
Example: soration-handle
id string
[]
Collection id
[]
Example: 12248721639068681442230282
imageobject
[]
Collection image
alt string
[]
Image alt
[]
Example: This is the picture alt
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
published_at string
[]
Posted to " online store " time
[]
Example: 2021-09-03T14:11:54+00:00
published_scope string
[]
The launch range , when the value is " web " , indicates online stores
[]
Example: web
rulesobject[]
[]
Smartly add condition
column string
[]
Condition variable
[]
Example: tag
condition string
[]
Conditions
[]
Example: This is a tag condition
relation string
[]
If-else statement
[]
Example: equals
sort_order string
[]
Sorting
[]
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

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20210901

ParamOptions

collection_listing_id — path required

Authorization — header required

Body

Body required

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

Language

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

Error loading component.