Create smart collection

Requires write_products access scope.

For more info , refer to:

[]

access permission

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

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 collection relevant information

bannerobject

[]

The banner image of the collection.

alt string

[]

Words or phrases that share the characteristics or content of images.

[]

Example: This is a image alt

src string

[]

The image's location represented as a URL.

[]

Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png

body_html string

[]

The description of the collection.

[]

Example: This is a description

disjunctive boolean

[]

Relationship between the intelligent collection box and Product conditions.

value	description
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

[]

The handle of collection.

[]

Example: spring-clothing

imageobject

[]

The image of collection.

alt string

[]

Words or phrases that share the characteristics or content of images.

[]

Example: This is a image alt

src string

[]

The image's location represented as a URL.

[]

Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png

path string

[]

The relative path of the collection URL in the online store, max 512 characters.

[]

Example: /collections/spring

published_scope string

[]

Set the launch range , when the value is " web " , it means online stores

[]

Example: web

rulesobject[] required

[]

Rule list for smart collections

column string required

[]

Conditions variable

Value	Description
title	The title of the product.
sale_price	The original price of the product variant.
compared_at_price	The price of the product variant.
tag	The tags of product.
inventory	Total inventory across all variants.
vendor	The vendor of product.
variant_weight	The weight of the product variant.
variant_title	The title of the product variant.
created_at	The creation date and time of the product.
sales	The product's sales.
view	The views of product.
add_to_cart	The product's add-to-cart count.
type	Merchant-defined product type.
product_taxonomy_node_id	The product's standardized product type.
product_metafield_definition	The value of a product metafield

[]

Example: product_metafield_definition

condition string

[]

The value of the condition.

[]

Example: true

condition_object_id long

[]

The ID of the metafield object.

[]

Example: 459302847

relation string required

[]

Conditional Statements

Value	Description
equals	Represents "equal to"
not_equals	Represents "not equal to"
starts_with	Represents "starts with" (prefix match)
ends_with	Represents "ends with" (suffix match)
contains	Represents "contains" (inclusion)
not_contains	Represents "does not contain" (exclusion)
greater_than	Represents "greater than"
less_than	Represents "less than"

[]

Example: equals

sort_order string

[]

Specify the sorting order of products within the collection.

value	description
best-selling	Sorted by best-selling products.
alpha-asc	Sorted in ascending alphabetical order (A - Z).
alpha-desc	Sorted in descending alphabetical order (Z - A).
updated-desc	Sorted by update date in descending order (newest to oldest).
updated-asc	Sorted by update date in ascending order (oldest to newest).
manual	Sorted by the order manually set by the merchant.

[]

Example: updated-asc

title string required

[]

Collection title

[]

Example: spring clothing

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

smart_collectionobject

[]

Collection information

bannerobject

[]

The banner image of the collection.

alt string

[]

Words or phrases that share the characteristics or content of images.

[]

Example: This is a image alt

src string

[]

The image's location represented as a URL.

[]

Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png

body_html string

[]

The description of the collection.

[]

Example: This is a description

created_at string

[]

The creation date and time of the collection.

[]

Example: 2021-09-03T14:11:54+00:00

disjunctive boolean

[]

Relationship between the intelligent collection box and Product conditions.

value	description
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

[]

The handle of collection.

[]

Example: spring-clothing

id string

[]

The ID of collection.

[]

Example: 12257170618007271602093384

imageobject

[]

The image of collection.

alt string

[]

Words or phrases that share the characteristics or content of images.

[]

Example: This is a image alt

src string

[]

The image's location represented as a URL.

[]

Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png

published_at string

[]

Time to post to online stores

[]

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[]

[]

Rule list for smart collections.

column string

[]

Conditions variable

Value	Description
title	The title of the product.
sale_price	The original price of the product variant.
compared_at_price	The price of the product variant.
tag	The tags of product.
inventory	Total inventory across all variants.
vendor	The vendor of product.
variant_weight	The weight of the product variant.
variant_title	The title of the product variant.
created_at	The creation date and time of the product.
sales	The product's sales.
view	The views of product.
add_to_cart	The product's add-to-cart count.
type	Merchant-defined product type.
product_taxonomy_node_id	The product's standardized product type.
product_metafield_definition	The value of a product metafield

[]

Example: product_metafield_definition

condition string

[]

The value of the condition.

[]

Example: true

condition_object_id long

[]

The ID of the metafield object

[]

Example: 459302847

relation string

[]

Conditional Statements

Value	Description
equals	Represents "equal to"
not_equals	Represents "not equal to"
starts_with	Represents "starts with" (prefix match)
ends_with	Represents "ends with" (suffix match)
contains	Represents "contains" (inclusion)
not_contains	Represents "does not contain" (exclusion)
greater_than	Represents "greater than"
less_than	Represents "less than"

[]

Example: equals

sort_order string

[]

Specify the sorting order of products within the collection.

value	description
best-selling	Sorted by best-selling products.
alpha-asc	Sorted in ascending alphabetical order (A - Z).
alpha-desc	Sorted in descending alphabetical order (Z - A).
updated-desc	Sorted by update date in descending order (newest to oldest).
updated-asc	Sorted by update date in ascending order (oldest to newest).
manual	Sorted by the order manually set by the merchant.

[]

Example: updated-asc

template_path string

[]

The template of theme.

[]

Example: templates/sortation/detail.json

title string

[]

The title of collection.

[]

Example: spring clothing

updated_at string

[]

The last modified date and time of the collection.

[]

Example: 2021-09-03T14:11:54+00:00

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "smart_collection": {
    "banner": {
      "alt": "This is a image alt",
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "body_html": "This is a description",
    "disjunctive": true,
    "handle": "spring-clothing",
    "image": {
      "alt": "This is a image alt",
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "path": "/collections/spring",
    "published_scope": "web",
    "rules": [
      {
        "column": "product_metafield_definition",
        "condition": "true",
        "condition_object_id": 459302847,
        "relation": "equals"
      }
    ],
    "sort_order": "updated-asc",
    "title": "spring clothing"
  }
}

Language

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