Product

Object

actions

List of actions that can be performed based on the current state of the product.

attributes

List of attributes assigned to this product.

availableForPurchase

brand

Brand of the product

category

chargeTaxes

collections

List of collections for the product.

countableImages

Countable edges of images for the product

createdAt

currency

customFields

List of custom fields assigned to this product.

defaultVariant

description

descriptionHtml

destinationLocation

Products destination location.

documents

List of documents associated with the product.

externalId

externalSource

features

id

The ID of the object

imageById

Get a single product image by ID.

images

List of images for the product. With enabled `strict_product_image_handling` - shows only images that are owned by product owner

isAvailable

Whether the product is in stock and visible or not.

isAvailableForPurchase

Whether the product is available for purchase.

isDigital

isPriceOverrideAllowed

indicates whether we allow overriding the unit_price of variants in checkout and draft, quote, offer order lines

isPublished

Whether the product is published.

isShippingRequired

locations

List of all product's locations.

manufacturer

Manufacturer of the product

margin

metadata

List of public metadata items. Can be accessed without permissions.

minimalVariantPrice

The price of the cheapest variant (including discounts).

model

Product model code

mpn

Manufacturer Product Number

name

originLocation

Products origin location.

overrideCurrency

overridePrice

pricing

Lists the storefront product's pricing, the current price and discounts, only meant for displaying.

primaryLocation

Products primary location.

privateMetadata

List of private metadata items.Requires proper staff permissions to access.

productStatusLogs

List of logs for product status changes.

productType

publicationDate

purchaseCost

sales

List of sales associated with the product.

seller

seoDescription

seoTitle

slug

sortOrder

Product sort order in the specific collection or in microsite. Make sense only as a part of the parent 'collection(s)' or 'microsite(s)' queries.

sortPriorityWeight

The product's sorting priority weight in query results. A larger value indicates a higher priority. This field can be used in both ascending and descending sorting methods.

status

subStatus

taxType

A type of tax. Assigned by enabled tax gateway

thumbnail

The main thumbnail for a product.

updatedAt

variants

List of variants for the product.

visibleInListings

vouchers

List of vouchers associated with the product.

warehousesStats

Product stock stats combining all variants in all warehouses. Requires MANAGE_PRODUCTS permission.

weight