AppGetProduct

GET

/apps/catalog/products/{id}

curl --request GET \
  --url https://your-store.myciqra.com/apps/catalog/products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

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

Authorizations

• bearerAuth
  read_products

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

OK

Media typeapplication/json

object

bundleComponents

Array<object>

object

allowedVariants

Array<object>

object

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

productBundleComponentId

string format: uuid

productVariantId

string format: uuid

tenantId

string format: uuid

updatedAt

null | string format: date-time

componentProductId

string format: uuid

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

position

integer | string format: int32

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

productId

string format: uuid

tenantId

string format: uuid

updatedAt

null | string format: date-time

category

One of:

null

null

object

object

banners

Array<object>

object

description

null | string

imageUrl

required

string

mainTitle

null | string

mobileImageUrl

null | string

title

null | string

children

Array<object> recursive

createdAt

string format: date-time

defaultSort

null | string

deletedAt

null | string format: date-time

description

null | string

footerHtml

null | string

heading

null | string

id

string format: uuid

isDeleted

boolean

isFeatured

boolean

name

required

string

parent

One of:

null

null

recursive object

object recursive

parentId

null | string format: uuid

position

integer | string format: int32

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

publishedAt

null | string format: date-time

redirectUrl

null | string

slug

null | string

templateSuffix

null | string

tenantId

string format: uuid

translations

object

key

additional properties

object

banners

Array<object> | null

object

description

null | string

imageUrl

required

string

mainTitle

null | string

mobileImageUrl

null | string

title

null | string

description

null | string

footerHtml

null | string

heading

null | string

name

null | string

updatedAt

null | string format: date-time

categoryId

null | string format: uuid

contentBlocks

Array<object>

object

html

required

string

key

required

string

title

required

string

countdownDiscountPercent

null | number | string format: double

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

countdownEndsAt

null | string format: date-time

countdownStartsAt

null | string format: date-time

createdAt

string format: date-time

deletedAt

null | string format: date-time

description

null | string

digitalAssets

Array<object>

object

contentType

required

string

createdAt

string format: date-time

deletedAt

null | string format: date-time

fileName

required

string

id

string format: uuid

isDeleted

boolean

productId

string format: uuid

sizeBytes

integer | string format: int64

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

storageKey

required

string

tenantId

string format: uuid

updatedAt

null | string format: date-time

downloadExpiryDays

null | integer | string format: int32

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

downloadLimit

null | integer | string format: int32

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

groupKey

null | string

id

string format: uuid

isDeleted

boolean

kind

Allowed values: Physical Digital GiftWrap Bundle

media

Array<object>

object

aiGenerated

boolean

altText

null | string

assetId

null | string format: uuid

contentType

required

string

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

position

integer | string format: int32

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

productId

string format: uuid

productVariantId

null | string format: uuid

sizeBytes

integer | string format: int64

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

storageKey

required

string

tenantId

string format: uuid

updatedAt

null | string format: date-time

url

required

string

metaDescription

null | string

metaTitle

null | string

name

required

string

options

Array<object>

object

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

name

required

string

position

integer | string format: int32

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

productId

string format: uuid

tenantId

string format: uuid

translations

object

key

additional properties

object

name

null | string

updatedAt

null | string format: date-time

values

Array<object>

object

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

position

integer | string format: int32

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

productOptionId

string format: uuid

swatchHex

null | string

swatchImageKey

null | string

tenantId

string format: uuid

translations

object

key

additional properties

object

value

null | string

updatedAt

null | string format: date-time

value

required

string

personalizationFields

Array<object>

object

createdAt

string format: date-time

deletedAt

null | string format: date-time

helpText

null | string

id

string format: uuid

isDeleted

boolean

key

required

string

label

required

string

maxLength

null | integer | string format: int32

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

maxValue

null | number | string format: double

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

minValue

null | number | string format: double

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

options

Array<object>

object

label

required

string

surcharge

number | string format: double

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

value

required

string

placeholder

null | string

position

integer | string format: int32

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

productId

string format: uuid

required

boolean

surcharge

number | string format: double

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

tenantId

string format: uuid

translations

object

key

additional properties

object

helpText

null | string

label

null | string

optionLabels

null | object

placeholder

null | string

type

Allowed values: Text Textarea Select Checkbox Number Date

updatedAt

null | string format: date-time

position

integer | string format: int32

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

productCategories

Array<object>

object

categoryId

string format: uuid

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

productId

string format: uuid

tenantId

string format: uuid

updatedAt

null | string format: date-time

publishedAt

null | string format: date-time

purchaseCount

integer | string format: int32

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

ratingAverage

number | string format: double

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

ratingCount

integer | string format: int32

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

refundable

boolean

returnWindowDays

null | integer | string format: int32

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

sizeGuideHtml

null | string

slug

null | string

specifications

Array<object>

object

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

name

required

string

position

integer | string format: int32

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

productId

string format: uuid

tenantId

string format: uuid

translations

object

key

additional properties

object

name

null | string

value

null | string

updatedAt

null | string format: date-time

value

required

string

status

Allowed values: Active Draft Archived

tags

Array<string>

taxClass

One of:

null

null

object

object

code

required

string

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

name

required

string

taxJarProductTaxCode

null | string

tenantId

string format: uuid

updatedAt

null | string format: date-time

taxClassId

null | string format: uuid

tenantId

string format: uuid

translations

object

key

additional properties

object

contentBlocks

Array<object> | null

object

html

required

string

key

required

string

title

required

string

description

null | string

metaDescription

null | string

metaTitle

null | string

name

null | string

updatedAt

null | string format: date-time

variants

Array<object>

object

barcode

null | string

compareAtPrice

null | number | string format: double

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

createdAt

string format: date-time

currency

required

string

deletedAt

null | string format: date-time

hasDimensions

boolean

heightMm

null | integer | string format: int32

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

id

string format: uuid

inventory

Array<object>

object

available

integer | string format: int32

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

concurrencyStamp

string format: uuid

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

onHand

integer | string format: int32

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

productVariantId

string format: uuid

reserved

integer | string format: int32

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

tenantId

string format: uuid

updatedAt

null | string format: date-time

warehouseId

string format: uuid

isDeleted

boolean

isOnSale

boolean

lengthMm

null | integer | string format: int32

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

optionValues

Array<object>

object

createdAt

string format: date-time

deletedAt

null | string format: date-time

id

string format: uuid

isDeleted

boolean

productOptionValueId

string format: uuid

productVariantId

string format: uuid

tenantId

string format: uuid

updatedAt

null | string format: date-time

price

number | string format: double

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

productId

string format: uuid

sku

required

string

tenantId

string format: uuid

updatedAt

null | string format: date-time

weightGrams

integer | string format: int32

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

widthMm

null | integer | string format: int32

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

Example

{
  "kind": "Physical",
  "personalizationFields": [
    {
      "options": [
        {
          "surcharge": 0
        }
      ],
      "type": "Text"
    }
  ],
  "status": "Active"
}

404

Not Found