Update manual collection

Requires write_products access scope.
For more info , refer to:
PUT https://{handle}.myshopline.com/admin/openapi/v20250601/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 collection
Path Parameters
  • custom_collection_id string required
    The ID of 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
  • custom_collectionobject required
    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/e46e6189ed5641a3b179444cacdcdd2a.png
  • body_html string
    The description of the collection.
    Example: This is a description.
  • collectsobject[]
    List of product relationships within the collection
  • position integer
    The location of the product in the collection, starts from 1.
    Example: 1
  • 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 product URL in the online store, max 512 characters. :::tip{title="tip"} 1. No action is taken if this field is empty. :::
    Example: /collections/spring
  • 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.
    valuedescription
    best-sellingSorted by best-selling products.
    alpha-ascSorted in ascending alphabetical order (A - Z).
    alpha-descSorted in descending alphabetical order (Z - A).
    updated-descSorted by update date in descending order (newest to oldest).
    updated-ascSorted by update date in ascending order (oldest to newest).
    manualSorted by the order manually set by the merchant.
    Example: updated-desc
  • title string
    The title of collection.
    Example: spring clothing
Response
For more information about status codes, see Http status code.
Response Headers
  • traceId
    traceId
Response Body
  • custom_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
  • 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 the online store
    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
  • sort_order string
    Specify the sorting order of products within the collection.
    valuedescription
    best-sellingSorted by best-selling products.
    alpha-ascSorted in ascending alphabetical order (A - Z).
    alpha-descSorted in descending alphabetical order (Z - A).
    updated-descSorted by update date in descending order (newest to oldest).
    updated-ascSorted by update date in ascending order (oldest to newest).
    manualSorted by the order manually set by the merchant.
    Example: updated-desc
  • 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
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— path required
— header required

Body

required
{
  "custom_collection": {
    "banner": {
      "alt": "This is a image alt.",
      "src": "https://img.myshopline.com/image/official/e46e6189ed5641a3b179444cacdcdd2a.png"
    },
    "body_html": "This is a description.",
    "collects": [
      {
        "position": 1,
        "product_id": "16057850264845250791280282"
      }
    ],
    "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",
    "sort_order": "updated-desc",
    "title": "spring clothing"
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.