Create manual collection

Requires write_products access scope.

For more info, refer to:

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

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 eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

custom_collectionobject required

Collection information

body_html string

The description of the collection.

Example: This is a description.

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/e46e6189ed5641a3b179444cacdcdd2a.png

published_scope string

Set the sales channel , when the value is " web " , it means online stores

Example: web

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-desc

title string required

The title of collection.

Example: spring clothing

collectsobject[]

List of product relationships within the collection

product_id string

The ID of product.

Example: 16057850264845250791280282

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

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

custom_collectionobject

Manually collection information

title string

The title of collection.

Example: spring clothing

body_html string

The description of the collection.

Example: This is a description

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

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-desc

template_path string

The template of theme.

Example: templates/sortation/detail.json

created_at string

The creation date and time of the collection.

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

handle string

The handle of collection.

Example: spring-clothing

id string

The ID of collection.

Example: 12257170618007271602093384

published_at string

Time to post to online stores

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

updated_at string

The last modified date and time of the collection.

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

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

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "custom_collection": {
    "published_scope": "web",
    "title": "spring clothing",
    "banner": {
      "src": "https://img.myshopline.com/image/official/e46e6189ed5641a3b179444cacdcdd2a.png",
      "alt": "This is a image alt."
    },
    "body_html": "This is a description.",
    "collects": [
      {
        "product_id": "16057850264845250791280282"
      }
    ],
    "image": {
      "alt": "This is a image alt.",
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "sort_order": "updated-desc",
    "handle": "spring-clothing",
    "path": "/collections/spring"
  }
}

Language

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