Skip to main content
objectProduct

Fields

_id
String!
name
String

Display name.

shortName
String

Short label for compact UI (cards, tags).

slug
String

URL-friendly identifier.

status
String

Lifecycle status, e.g. active, disabled, draft.

code
String

Stable SKU-like code, unique within the workspace.

type
String

Product type / kind, e.g. product, service.

description
String

Long-form description (may contain HTML).

barcodes
[String]

Barcode values associated with this product.

unitPrice
Float

Regular unit price, in currency.

salePrice
Float

Discounted price, when on sale. Falls back to unitPrice when unset.

costPrice
Float

Internal cost price, for margin reporting.

currency
String

ISO currency code for all price fields.

categoryId
String

ProductCategory this product belongs to.

customFieldsData
JSON

Custom field values keyed by field id. See Field.

customFieldsDataByFieldCode
JSON

Custom field values keyed by stable field code.

createdAt
Date
updatedAt
Date
publishedAt
Date
createdBy
String
updatedBy
String
getTags
[Tag]

Resolved Tag objects for tagIds.

tagIds
[String]

Tag ids attached to this product.

attachment

Primary product image.

attachmentMore

Additional images.

media

Combined media gallery (images and other attachments).

vendorId
String

Supplying Company id, when tracked.

workspaceId
String
uom
String

Base unit of measure, e.g. piece, kg.

subUoms
JSON

Alternate units of measure with conversion factors.

vendor
taxType
String

Tax classification for this product.

taxCode
String

Tax code passed to external tax calculation.

sku
String

Stock keeping unit, separate from code.

externalUrl
String

Link to the product on an external storefront, when synced.

source
String

Origin system for imported/synced products (e.g. a connected store platform).

mpn
String

Manufacturer part number.

gtin
String

Global Trade Item Number (barcode standard).

requireShipping
Boolean

Whether this product requires physical shipping.

channels
[String]

Sales channels this product is published to.

unlimitedQuantity
Boolean

When true, stock is not tracked and the product is always orderable.

saleStart
Date

When the salePrice becomes active.

saleEnd
Date

When the salePrice expires.

maxPerOrder
Int

Maximum quantity allowed in a single order.

maxPerCustomer
Int

Maximum quantity allowed per customer overall.

isAvailable
Boolean

Whether the product can currently be purchased.

hideQuantity
Boolean

When true, hides remaining stock count from customers.

productOptions

Option definitions (e.g. color, size) used to generate productVariants.

productVariants

Purchasable variants, each with its own price and stock.

priceRange

Min/max price across productVariants, when hasVariants is true.

hasVariants
Boolean

Whether this product is sold via productVariants rather than a single price.

hasCatalogWarning
Boolean

Whether the catalog integration flagged an issue with this product (e.g. missing required field for a channel).

weight
Float

Shipping weight, in weightUnit.

weightUnit
String

Unit for weight, e.g. kg, lb.

Physical package dimensions.

Stock tracking configuration and current quantity.

SEO title, description, slug, and keywords for storefront pages.

آخر تعديل في ١١ أغسطس ٢٠٢٦