AppGetCollection

GET

/apps/catalog/collections/{id}

const url = 'https://your-store.myciqra.com/apps/catalog/collections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://your-store.myciqra.com/apps/catalog/collections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Required scope: read_collections — an installation token without it receives 403.

Authorizations

bearerAuth
read_collections

Parameters

Path Parameters

required

string format: uuid

Responses

200

application/json

object

description

required

null | string

required

string format: uuid

isFeatured

required

boolean

name

required

string

position

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

productIds

required

Array<string>

rules

required

object

conditions

required

Array<object>

object

field

required

Allowed values: Category Tag Price CreatedWithinDays OnSale

operator

required

Allowed values: Equals NotEquals LessThan GreaterThan Contains

value

required

string

match

required

Allowed values: All Any

slug

required

null | string

type

required

Allowed values: Manual Smart

Example

{
  "rules": {
    "conditions": [
      {
        "field": "Category",
        "operator": "Equals"
      }
    ],
    "match": "All"
  },
  "type": "Manual"
}

404

Not Found