Add collection to sales channels

Requires write_product_listings access scope.

For more info, refer to:

PUT https://{handle}.myshopline.com/admin/openapi/v20261201/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 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 eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Request Body

collection_listingobject

collection information
collection_listing_id string

collection id
Example: 12248721639068681442230283

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

collection_listingobject

Collection information
published_at string

Time to post to the online store
Example: 2021-09-03T14:11:54+00:00
title string

Collection title
Example: This is a collection title
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
id string

Collection id
Example: 12248721639068681442230284
collection_type string

Collection type : custom , smart
Example: smart
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
rulesobject[]

Smartly add condition
condition string

Conditions
Example: true
condition_object_id long

The ID of the metafield object
Example: 483749284
relation string

If-else statement
Example: equals
column string

Condition variable
Example: product_metafield_definition
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
handle string

Collection Handle
Example: collection-handle
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
published_scope string

Set the sales channel , when the value is " web " , it means online stores
Example: web
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
template_path string

Template path
Example: templates/sortation/detail.json

API Explorer

Debugger

Examples

Base URL

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

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/v20261201/collection_listings/collection_listing_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal