Update a collection

PUT

/api/v1/commerce/collections/{id}

curl --request PUT \
  --url https://digize.com/api/v1/commerce/collections/example \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "title": "example", "handle": "example", "description": "example", "kind": "manual", "match": "all", "rules": [ { "field": "category", "operator": "is", "value": "example" } ], "productIds": [ "example" ], "sort": "best_selling", "published": true, "color": "primary", "imageId": "example" }'

• Digize

Saves a collection’s details, rules or products.

Needs the commerce:write permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 64 characters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

title

required

string

<= 120 characters

handle

string

<= 80 characters

description

string

<= 5000 characters

kind

required

string

Allowed values: manual automated

match

string

Allowed values: all any

rules

Array<object>

<= 20 items

object

field

required

string

Allowed values: category tag vendor price stock

operator

required

string

Allowed values: is is_not contains greater_than less_than

value

required

Text, or for price and stock a number: price in minor units.

string

<= 120 characters

productIds

A manual collection’s products, in order.

Array<string>

<= 1000 items

sort

string

Allowed values: best_selling title price_asc price_desc newest manual

published

boolean

color

string

Allowed values: primary accent secondary success warning info destructive

imageId

Any of:

string

string

<= 120 characters

null

null

Responses

200

Done

Media typeapplication/json

object

id

required

string

title

required

string

handle

required

string

description

required

string

kind

required

string

Allowed values: manual automated

match

required

string

Allowed values: all any

rules

required

Array<object>

object

field

required

string

Allowed values: category tag vendor price stock

operator

required

string

Allowed values: is is_not contains greater_than less_than

value

required

Text, or for price and stock a number: price in minor units.

string

<= 120 characters

productIds

required

Array<string>

sort

required

string

Allowed values: best_selling title price_asc price_desc newest manual

published

required

boolean

color

required

string

Allowed values: primary accent secondary success warning info destructive

image

required

Any of:

object

object

imageId

required

string

url

required

string

null

null

updatedAt

required

string format: date-time

Example

{
  "kind": "manual",
  "match": "all",
  "rules": [
    {
      "field": "category",
      "operator": "is"
    }
  ],
  "sort": "best_selling",
  "color": "primary"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}