Create smart collection

Requires write_products access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20230301/products/smart_collections.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 .

[]

Create smart classification

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

smart_collectionobject required
[]
Intelligent classification information
bannerobject
[]
Collection banner figure
alt string
[]
Collection banner chart alt information
[]
Example: I am banner picture alt
src string
[]
Image URL
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
body_html string
[]
Collection description
[]
Example: I am a classified description
disjunctive boolean
[]
Smart the relationship between the added conditions is in accordance with any conditions : true multiple conditions must be in compliance with : false
[]
Example: true
handle string
[]
Collection Handle
[]
Example: I am a classified handle
imageobject
[]
Collection images
alt string
[]
Image alt
[]
Example: I am classified picture alt
src string
[]
Image URL
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
published_scope string
[]
Set the launch range , when the value is " web " , it means online stores
[]
Example: web
rulesobject[] required
[]
Smartly add condition
column string required
[]
Conditions variable Product title : title , selling price : sale_price , original price : compared_at_price , tag : tag , inventory : inventory , supplier : vendor ,Weight : variant_weight , specification name : variant_title , created time : created_at , sales : sales , browsing : view , purchase : add_to_cart ,Product type : product_category
[]
Example: tag
condition string
[]
Value of the corresponding condition variable
[]
Example: tag1
relation string required
[]
If-else statement ,Equal to : equa ls does not mean : not_equals starts with : starts_with ends with : ends_with includes : contains does not contain : not_contains greater than : g realR_than less than : less_than
[]
Example: equals
sort_order string
[]
Sorting, Best selling: 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: manual
[]
Example: updated-asc
title string required
[]
Collection title
[]
Example: I am a category title

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

smart_collectionobject
[]
Intelligent classification information
bannerobject
[]
Collection banner
alt string
[]
Image alt
[]
Example: I am banner picture alt
src string
[]
Image URL
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
body_html string
[]
Collection description
[]
Example: I am a classified description
created_at string
[]
Creation time
[]
Example: 2021-09-03T14:11:54+00:00
disjunctive boolean
[]
Relationship between conditions
[]
Example: true
handle string
[]
Collection handle
[]
Example: I am a classified handle
id string
[]
Collection id
[]
Example: 123
imageobject
[]
Collection images
alt string
[]
Image alt
[]
Example: I am classified picture alt
src string
[]
Image URL
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
published_at string
[]
Post 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
[]
Value of the corresponding condition variable
[]
Example: tag1
relation string
[]
If-else statement
[]
Example: equals
sort_order string
[]
Sorting
[]
Example: updated-asc
template_path string
[]
Theme template
[]
Example: templates/sortation/detail.json
title string
[]
Category title
[]
Example: I am a classified 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/v20230301

ParamOptions

Authorization — header required

Body

Body required

{
  "smart_collection": {
    "banner": {
      "alt": "I am banner picture alt",
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "body_html": "I am a classified description",
    "disjunctive": true,
    "handle": "I am a classified handle",
    "image": {
      "alt": "I am classified picture alt",
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "published_scope": "web",
    "rules": [
      {
        "column": "tag",
        "condition": "tag1",
        "relation": "equals"
      }
    ],
    "sort_order": "updated-asc",
    "title": "I am a category title"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20230301/products/smart_collections.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.