OBJECT
Advert

An advert
GraphQL Schema definition

type Advert implements Node {
# This field returns option type values set to the advert.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
advertOptionValues(
after: String,
before: String,
first: Int,
last: Int
): AdvertOptionValueConnection! 
# Availability of the advert
availability: [AdvertAvailabilityEnum!]! 
# The additional cost of shipping the advert domestically, which is added to the 
# Sellers base domestic shipping rate.
baseDomesticShippingCost: Float 
# The additional cost of shipping the advert internationally, which is added to 
# the Sellers base international shipping rate.
baseInternationalShippingCost: Float 
# Terms & conditions text to display on the advert.
bookingTerms: String 
brand: Brand 
# Brand labels before being mapped to a canonical brand. (Includes the original 
# values for both unmapped and mapped brands)
brandBeforeMapping: [String!]! 
catalogRulesErrors: [CatalogRulesError!] 
# Optional product code for the advert.
code: String 
condition: AdvertConditionEnum! 
createdAt: ISO8601DateTime! 
# Custom form template information for the advert
customFormTemplate: CustomFormTemplate 
# A thumbnail image for an associated customIframeUrl
customIframeThumbnail: Image 
# A link to a video hosted on one of a number of supported custom domains. Contact 
# Marketplacer support for a full list of supported domains.If supplying a 
# customIframeUrl, you must also supply a customIframeThumbnail.
customIframeUrl: String 
# Description provided by seller as markdown
description: String 
# Description converted to HTML
descriptionHtml: String 
# Image to display on the advert tile.
displayImage: Image 
# Whether to display the given advert.
displayable: Boolean! 
# PDF documents for information on advert
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
documents(after: String, before: String, first: Int, last: Int): AdvertDocumentsConnection 
domesticShippingCost: Float @deprecated( reason: "Use `base_domestic_shipping_cost` instead."  )
# This field returns option values from single-select option types.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
dropdownOptionValues(
after: String,
before: String,
first: Int,
last: Int
): OptionalOptionValueConnection! @deprecated( reason: "This field is deprecated in favour of AdvertOptionValues."  )
# Price used for editing by sellers
editablePrice: Decimal 
# Price used for editing by sellers Denominated in cents.
editablePriceCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
"  )
# Price used for editing by sellers In string with currency symbol.
# 
# Arguments
# currency: Currency in which to display money fields. Defaults 
# to the currency of the marketplace's home country.
editablePriceFormatted(currency: String): String 
# Price used for editing by sellers
editableSalePrice: Decimal 
# Price used for editing by sellers Denominated in cents.
editableSalePriceCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
"  )
# Price used for editing by sellers In string with currency symbol.
# 
# Arguments
# currency: Currency in which to display money fields. Defaults 
# to the currency of the marketplace's home country.
editableSalePriceFormatted(currency: String): String 
errorMessages: [ErrorMessage!]! 
# An ID that is managed the retailer.
externalId: String 
# A collection of key / value pair external IDs that can be added to the Advert 
# using externalIdUpsert and advertUpsert.
externalIds: [ExternalID!]! 
# This field returns option values from multi-select option types.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
featureOptionValues(
after: String,
before: String,
first: Int,
last: Int
): OptionValueConnection! @deprecated( reason: "This field is deprecated in favour of AdvertOptionValues."  )
# This field returns values from free-text option types.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
freetextOptionValues(
after: String,
before: String,
first: Int,
last: Int
): FreetextOptionValueConnection! @deprecated( reason: "This field is deprecated in favour of AdvertOptionValues."  )
# Title for display (may include Brand and Model Year depending on configuration)
fullTitle: String! 
gender: AdvertGenderEnum 
# Golden Product associated to this advert
goldenProduct: GoldenProduct 
# Do any of the variants have duplicate barcodes Only accessible to users: 
# admin_authorized, api_key_users. And admin users with permissions: 'Manage 
# product catalog', 'Full GraphQL API access'.
hasDuplicateBarcodes: Boolean 
hasFreeDomesticShipping: Boolean 
hasFreeInternationalPostage: Boolean @deprecated( reason: "Use `has_free_international_shipping` instead."  )
hasFreeInternationalShipping: Boolean 
hasFreePostage: Boolean @deprecated( reason: "Use `has_free_domestic_shipping` instead."  )
# Whether advert has invalid variants
hasInvalidVariants: Boolean! 
id: ID! 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
images(after: String, before: String, first: Int, last: Int): ImagesConnection! 
internationalShippingCost: Float @deprecated( reason: "Use `base_international_shipping_cost` instead."  )
internationalShippingEnabled: Boolean 
# Whether the advert is to be featured above other adverts. Only used in Full 
# Stack configurations.
isFeatured: Boolean 
# Whether the advert is currently part of an active promotion.
isPromoted: Boolean 
# The individual item tax rate on advert.
itemTaxRate: Decimal 
# Human readable version of the ID.
legacyId: Int! 
# Lowest non-sale price available for the item.
lowestOriginalPrice: String 
# Lowest non-sale price available for the item. Denominated in cents.
lowestOriginalPriceCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use lowestOriginalPrice instead. This field will be removed no earlier than July 1st, 2025."  )
# Lowest non-sale price available for the item in session currency. Useful for 
# display purpose only as all monetary transactions will be charged in the 
# marketplace currency.
lowestOriginalPriceInSessionCurrency: String 
# Absolute lowest price (sale price or original price) available for the item.
lowestPrice: String 
# Absolute lowest price (sale price or original price) available for the item. 
# Denominated in cents.
lowestPriceCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use lowestPrice instead. This field will be removed no earlier than July 1st, 2025."  )
# Absolute lowest price (sale price or original price) available for the item in 
# session currency. Useful for display purpose only as all monetary transactions 
# will be charged in the marketplace currency.
lowestPriceInSessionCurrency: String 
# Maximum purchase quantity allowed for successful checkout
maxPurchaseQuantity: Int 
# Price Unit as a Configurable Unit of Measure
measurementPriceUnit: MeasurementUnit 
# Metadata key/values Only accessible to users: admin_authorized, 
# seller_authorized. And admin users with permissions: 'Manage product catalog', 
# 'Full GraphQL API access'.
metadata: [Metadatum!]! 
# Minimum purchase quantity required for successful checkout
minPurchaseQuantity: Int 
# Represents an associated Golden Record as defined in the Central Product 
# Database (CPD). An advert will only have an associated model if it was created 
# as part of the CPD backfill process, otherwise it will be null.
model: Model 
# The status of an advert, determined by the relationship of the advert and it's 
# sellers online status
online: Boolean! 
# Country of origin in ISO 2 format
originCountryCode: String 
# Original price formatted as a string (e.g. 'From $30')
originalPriceFormatted: String @deprecated( reason: "Using this field may trigger significant slowdowns. Deprecated in favour of the `original_price_formatted` on ES Adverts"  )
pagePath: String! 
# Used when the price of an advert can vary, e.g. prices starting from etc.
priceType: AdvertPriceTypeEnum 
# Unit of measure or time associated with the advert.
priceUnit: AdvertPriceUnitEnum 
# This field returns key-value pairs of single-select and free-text option type 
# values.
productDetails: [KeyValue!] @deprecated( reason: "This field is deprecated in favour of AdvertOptionValues."  )
productFeatures: [String!] 
# The name of the most recent active promotion that this advert is part of.
promotionText: String 
# Whether seller published an advert.
published: Boolean! 
# Rating reviews
rating: AdvertRating 
# The recommended retail price (RRP) for the item.
recommendedRetailPrice: String 
# The recommended retail price (RRP) for the item. Denominated in cents.
recommendedRetailPriceCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
"  )
# The recommended retail price (RRP) for the item. In string with currency symbol.
# 
# Arguments
# currency: Currency in which to display money fields. Defaults 
# to the currency of the marketplace's home country.
recommendedRetailPriceFormatted(
currency: String
): String 
# Does this advert require vetting. (See "vetted" field) Only accessible to users: 
# admin_authorized, seller_authorized, api_key_users. And admin users with 
# permissions: 'Manage product catalog', 'Full GraphQL API access'.
requiresVetting: Boolean! 
# Time when requires vetting is set to true Only accessible to users: 
# admin_authorized, seller_authorized, api_key_users. And admin users with 
# permissions: 'Manage product catalog', 'Full GraphQL API access'.
requiresVettingAt: ISO8601DateTime 
# End of the period in which the sale price is valid (or null) Only accessible to 
# users: admin_authorized, seller_authorized, api_key_users. And admin users with 
# permissions: 'Manage product catalog', 'Full GraphQL API access'.
salePriceEndAt: ISO8601DateTime 
# Sale price formatted as a string e.g. ('Now from $21')
salePriceFormatted: String @deprecated( reason: "Using this field may trigger significant slowdowns. Deprecated in favour of the `sale_price_formatted` on ES Adverts"  )
# Start of the period in which the sale price is valid (or null) Only accessible 
# to users: admin_authorized, seller_authorized, api_key_users. And admin users 
# with permissions: 'Manage product catalog', 'Full GraphQL API access'.
salePriceStartAt: ISO8601DateTime 
# The channels where the advert can be purchased, e.g. on-line, click and collect 
# etc.
saleType: AdvertSaleTypeEnum 
# Additional taxons to permit the advert to appear in a wider variety of search 
# results.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
secondaryTaxons(after: String, before: String, first: Int, last: Int): TaxonConnection! 
seller: Seller! 
# The direct shipping parcel information for the advert
shippingParcel: ShippingParcel 
# Either a direct parcel information or inferred from taxon
shippingParcelToUse: ShippingParcel 
# Brand Sizing Chart. Warning: this can be slow for many records.
sizeMatrix: SizeMatrix 
# Text descriptions of advert specifications.
specifications: String 
# HTML descriptions of advert specifications.
specificationsHtml: String 
# System generated value that represents the overall status of the advert, e.g. 
# "Online" Only accessible to users: admin_authorized, seller_authorized, 
# api_key_users. And admin users with permissions: 'Manage product catalog', 'Full 
# GraphQL API access'.
statusText: String 
taxCode: String 
# The Taxon (or Category) that an Advert belongs to - eg. Bikes, Shoes, Wigs
taxon: Taxon! @deprecated( reason: "This field will error if we display an Advert that does not have a Taxon - ie. the Advert has been importedfrom an external source and not yet mapped to a Taxon. Deprecated in favour of taxonNullable. Will be removed 2022-05-01"  )
# Taxon labels before being mapped to a canonical taxon. (Includes the original 
# values for both unmapped and mapped taxons)
taxonBeforeMapping: [String!]! 
# The Taxon (or Category) that an Advert belongs to - eg. Bikes, Shoes, Wigs.
taxonNullable: Taxon 
# Whether therapeutic goods labelling is enabled on variants.
therapeuticGoodsLabellingEnabled: Boolean! 
# Whether therapeutic goods labelling is enabled on the vertical.
therapeuticGoodsLabellingVisible: Boolean! 
# Title of the advert, excludes auto appended fields like Brand.
title: String! 
# The total cost of shipping one item domestically. Denominated in cents. Each 
# additional item in an order will incur the shipping cost returned in the 
# baseDomesticShippingCost field
totalDomesticShippingCostCents: Int 
# The total cost of shipping one item internationally. Denominated in cents. Each 
# additional item in an order will incur the shipping cost returned in the 
# baseInternationalShippingCost field
totalInternationalShippingCostCents: Int 
updatedAt: ISO8601DateTime! 
url: String 
# Variants returned are ordered by position
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
# displayableOnly: Whether to only fetch variants that are 
# displayable (e.g. are valid, have inventory available)
variants(
after: String,
before: String,
first: Int,
last: Int,
displayableOnly: Boolean
): VariantConnection! 
# Has this advert been vetted. NOTE: Is only relevant if requiresVetting is true 
# Only accessible to users: admin_authorized, seller_authorized, api_key_users. 
# And admin users with permissions: 'Manage product catalog', 'Full GraphQL API 
# access'.
vetted: Boolean! 
# Whether the advert has undergone vetting and been rejected.
vettingRejected: Boolean! 
# The reason why the advert was rejected.
vettingRejectedReason: String 
# The wholesale price for the item.
wholesalePrice: String 
# The wholesale price for the item. Denominated in cents.
wholesalePriceCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
"  )
# The wholesale price for the item. In string with currency symbol.
# 
# Arguments
# currency: Currency in which to display money fields. Defaults 
# to the currency of the marketplace's home country.
wholesalePriceFormatted(currency: String): String 
# Wholesale promo price of the advert
wholesalePromoPrice: Decimal 
# Wholesale promo price of the advert Denominated in cents.
wholesalePromoPriceCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
"  )
# End of the period in which the wholesale promo price is valid (or null)
wholesalePromoPriceEndAt: ISO8601DateTime 
# Wholesale promo price of the advert In string with currency symbol.
# 
# Arguments
# currency: Currency in which to display money fields. Defaults 
# to the currency of the marketplace's home country.
wholesalePromoPriceFormatted(currency: String): String 
# Start of the period in which the wholesale promo price is valid (or null)
wholesalePromoPriceStartAt: ISO8601DateTime 
# When relevant, the model year of the product.
year: Int 
youtubeVideoId: String 
youtubeVideoUrl: String 
}
Advert

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
