List collections

GET

/api/v1/commerce/collections

const url = 'https://digize.com/api/v1/commerce/collections';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/commerce/collections \
  --header 'x-api-key: <x-api-key>'

Collections with the products in each: picked by hand, or matched by rules now.

Needs the commerce:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

rows

required

Array<object>

object

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
null

object

imageId

required

string

url

required

string

updatedAt

required

string format: date-time

total

required

number

Example

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

400

What was sent isn’t valid (invalid).

application/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.

application/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.

application/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).

application/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.

application/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"
  }
}