Update manual collection

Requires write_products access scope.

For more info , refer to:

[]

access permission

PUT https://{handle}.myshopline.com/admin/openapi/v20231201/products/custom_collections/:custom_collection_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 .

[]

Update manual classification

Path Parameters

custom_collection_id string required
[]
Manual classification ID
[]
Example: 12248721639068681442230282

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

custom_collectionobject required
[]
Collection information
bannerobject
[]
Collection banner image
alt string
[]
Image alt
[]
Example: This is a image alt
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
body_html string
[]
Collection description
[]
Example: This is a description
collectsobject[]
[]
Relational list
position integer
[]
The location of the product in the collection, starts from 1
[]
Example: 1
product_id string
[]
Product id
[]
Example: 16057850264845250791280240
handle string
[]
Collection Handle
[]
Example: collection-handle
imageobject
[]
Collection images
alt string
[]
Image alt
[]
Example: This is a image alt
src string
[]
Image src
[]
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
sort_order string
[]
Product name , sort by , hot sale : best-selling , product name from a-z : alpha-asc , product name from z-a : alpha-desc , new update time → old : updated-desc ,Update time old → new : updated-asc , custom : manual
[]
Example: updated-asc
title string
[]
Collection title
[]
Example: This is a title

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

custom_collectionobject
[]
Collection information
bannerobject
[]
Collection banner
alt string
[]
Image alt
[]
Example: This is a image alt
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
body_html string
[]
Collection description
[]
Example: This is a description
created_at string
[]
Creation time
[]
Example: 2021-09-03T14:11:54+00:00
handle string
[]
Collection handle
[]
Example: collection-handle
id string
[]
Collection id
[]
Example: 12248721639068681442230282
imageobject
[]
Collection images
alt string
[]
Image alt
[]
Example: This is a image alt
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
published_at string
[]
Time to post to the online store
[]
Example: 2021-09-03T14:11:54+00:00
published_scope string
[]
Set the launch range , when the value is " web " , it means online stores
[]
Example: web
sort_order string
[]
Sort by , hot sale : best-selling , product name from a-z : alpha-asc , product name from z-a : alpha-desc , new update time → old : updated-desc ,Update time old → new : updated-asc , custom : manual
[]
Example: updated-asc
template_path string
[]
Theme template
[]
Example: templates/sortation/detail.json
title string
[]
Collection title
[]
Example: This is a title
updated_at string
[]
Update time
[]
Example: 2021-09-03T14:11:54+00:00

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

custom_collection_id — path required

Authorization — header required

Body

Body required

{
  "custom_collection": {
    "banner": {
      "alt": "This is a image alt",
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "body_html": "This is a description",
    "collects": [
      {
        "position": 1,
        "product_id": "16057850264845250791280240"
      }
    ],
    "handle": "collection-handle",
    "image": {
      "alt": "This is a image alt",
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "published_scope": "web",
    "sort_order": "updated-asc",
    "title": "This is a title"
  }
}

Language

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