Skip to main content
View Markdown

ProductChannelListing Object

Represents product channel listing.

type ProductChannelListing implements Node {
  id: ID!
  publicationDate: Date @deprecated
  publishedAt: DateTime
  isPublished: Boolean!
  channel: Channel!
  visibleInListings: Boolean!
  availableForPurchase: Date @deprecated
  availableForPurchaseAt: DateTime
  discountedPrice: Money
  purchaseCost: MoneyRange
  margin: Margin
  isAvailableForPurchase: Boolean
  pricing(address: AddressInput): ProductPricingInfo
}

Fields​

id ● ID!​

The ID of the product channel listing.

publishedAt ● DateTime​

The product publication date time.

isPublished ● Boolean!​

Indicates if the product is published in the channel.

channel ● Channel!​

The channel in which the product is listed.

visibleInListings ● Boolean!​

Indicates product visibility in the channel listings.

availableForPurchaseAt ● DateTime​

The product available for purchase date time.

discountedPrice ● Money​

The price of the cheapest variant (including discounts).

purchaseCost ● MoneyRange​

Purchase cost of product.

Requires the MANAGE_PRODUCTSpermission.

margin ● Margin​

Range of margin percentage value.

Requires the MANAGE_PRODUCTSpermission.

isAvailableForPurchase ● Boolean​

Refers to a state that can be set by admins to control whether a product is available for purchase in storefronts in this channel. This does not guarantee the availability of stock. When set to False, this product is still visible to customers, but it cannot be purchased.

pricing ● ProductPricingInfo​

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

address ● AddressInput​

Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses Shop.companyAddress or fallbacks to server's settings.DEFAULT_COUNTRY configuration.

Show deprecatedHide deprecated

publicationDate ● Date​

DEPRECATED

Use the publishedAt field to fetch the publication date.

availableForPurchase ● Date​

DEPRECATED

Use the availableForPurchaseAt field to fetch the available for purchase date.

Interfaces​

Node​

An object with an ID

Member Of​

Product object