Update a Collection

Request

Path Params

id

string

required

The ID of the Collection.

Body Params application/json

title

string

optional

The title of the collection.

handle

string

optional

An optional handle to be used in slugs. If none is provided, the kebab-case version of the title will be used.

metadata

object

optional

An optional set of key-value pairs to hold additional information.

Example

{
    "title": "string",
    "handle": "string",
    "metadata": {}
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/admin/collections/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "handle": "string",
    "metadata": {}
}'

Responses

🟢200OK

application/json

Body

collection

object (Product Collection)

required

A Product Collection allows grouping together products for promotional purposes. For example, an admin can create a Summer collection, add products to it, and showcase it on the storefront.

id

string

required

The product collection's ID

Example:

pcol_01F0YESBFAZ0DV6V831JXWH0BG

title

string

required

The title that the Product Collection is identified by.

Example:

Summer Collection

handle

string | null

required

A unique string that identifies the Product Collection - can for example be used in slug structures.

Example:

summer-collection

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

products

array [object]

optional

The details of the products that belong to this product collection.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

Example

{
    "collection": {
        "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
        "title": "Summer Collection",
        "handle": "summer-collection",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "products": [
            {}
        ],
        "metadata": {
            "car": "white"
        }
    }
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error