Skip to main content
Version: Canary 🚧

ProductChannelListing

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​

ProductChannelListing.id ● ID! non-null scalar​

The ID of the product channel listing.

ProductChannelListing.publicationDate ● Date deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0. Use the publishedAt field to fetch the publication date.

ProductChannelListing.publishedAt ● DateTime scalar​

The product publication date time.

Added in Saleor 3.3

ProductChannelListing.isPublished ● Boolean! non-null scalar​

Indicates if the product is published in the channel.

ProductChannelListing.channel ● Channel! non-null object​

The channel in which the product is listed.

ProductChannelListing.visibleInListings ● Boolean! non-null scalar​

Indicates product visibility in the channel listings.

ProductChannelListing.availableForPurchase ● Date deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0. Use the availableForPurchaseAt field to fetch the available for purchase date.

ProductChannelListing.availableForPurchaseAt ● DateTime scalar​

The product available for purchase date time.

Added in Saleor 3.3

ProductChannelListing.discountedPrice ● Money object​

The price of the cheapest variant (including discounts).

ProductChannelListing.purchaseCost ● MoneyRange object​

Purchase cost of product.

Requires MANAGE_PRODUCTSpermission.

ProductChannelListing.margin ● Margin object​

Range of margin percentage value.

Requires MANAGE_PRODUCTSpermission.

ProductChannelListing.isAvailableForPurchase ● Boolean scalar​

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.

ProductChannelListing.pricing ● ProductPricingInfo object​

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

ProductChannelListing.pricing.address ● AddressInput input​

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.

Interfaces​

Node interface​

An object with an ID

Member of​

Product object

Was this page helpful?