Magidoc

Product
Object

Represents an individual item for sale in the storefront.

Fields

#

actions

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

attributes

Non-null

List of attributes assigned to this product.

availableForPurchase

brand

Brand of the product

category

chargeTaxes

Non-null

collections

List of collections for the product.

countableImages

Countable edges of images for the product

createdAt

Non-null

cumulativePrice

Cumulative price of all products in grouped product.

cumulativeStock

Available stock for grouped product.

currency

Non-null

customFields

Non-null

List of custom fields assigned to this product.

defaultVariant

description

Non-null

descriptionHtml

Non-null

descriptionJson

Non-null

destinationLocation

Products destination location.

documents

List of documents associated with the product.

externalId

externalSource

features

groupedProducts

List of all grouped products.

id

ID !
Non-null

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

Non-null

isPriceOverrideAllowed

Non-null

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

isPublished

Non-null

Whether the product is published.

isShippingRequired

Non-null

locations

List of all product's locations.

manufacturer

Manufacturer of the product

margin

metadata

Non-null

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

Non-null

originLocation

Products origin location.

overrideCurrency

Non-null

overridePrice

Non-null

pricing

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

primaryLocation

Products primary location.

privateMetadata

Non-null

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

productConfiguration

Product configuration indicator.

productType

publicationDate

purchaseCost

seller

seoDescription

seoTitle

slug

Non-null

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

Non-null

subStatus

Non-null

taxType

A type of tax. Assigned by enabled tax gateway

thumbnail

The main thumbnail for a product.

updatedAt

url

Non-null

The storefront URL for the product.

variants

List of variants for the product.

visibleInListings

Non-null

warehousesStats

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

weight

Interfaces

#

Also implements Node , ObjectWithMetadata .

Usages

#

References

#