Skip to content

AppListProducts

GET
/apps/catalog/products
curl --request GET \
--url 'https://your-store.myciqra.com/apps/catalog/products?skip=0&take=50' \
--header 'Authorization: Bearer <token>'

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

skip
integer | string format: int32
0 /^-?(?:0|[1-9]\d*)$/
take
integer | string format: int32
default: 50 /^-?(?:0|[1-9]\d*)$/

OK

Media typeapplication/json
object
items
required
Array<object>
object
categoryId
required
null | string format: uuid
categoryName
required
null | string
currency
required
null | string
id
required
string format: uuid
kind
required
Allowed values: Physical Digital GiftWrap Bundle
maxPrice
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
minPrice
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
name
required
string
slug
required
null | string
status
required
Allowed values: Active Draft Archived
tags
required
Array<string>
thumbnailAlt
required
null | string
thumbnailUrl
required
null | string
totalInventory
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
updatedAt
required
string format: date-time
variantCount
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
skip
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
take
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
total
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
Example
{
"items": [
{
"kind": "Physical",
"status": "Active"
}
]
}