INPUT_OBJECT

AdvertInput

link GraphQL Schema definition

  • input AdvertInput {
  • title: String
  • brandId: ID
  • # Will create a source mapping and attempt auto mapping of brand. You
  • # can use either brandId or brandMappings but not both. brandMappings
  • # accepts a collection of strings, where the 1st successful match will
  • # be used. A successful match is where we have a match to an existing
  • # brand mapping, or the string matches the brand name exactly.
  • # NOTE: this was called map_brand in the v2 API.
  • brandMappings: [String!]
  • taxonId: ID
  • # Will create a source mapping and attempt auto mapping of taxon. You
  • # can use either taxonId or taxonMappings but not both. taxonMappings
  • # accepts a collection of strings, where the 1st successful match will
  • # be used. A successful match is where we have a match to an existing
  • # taxon mapping.
  • # NOTE: this was called map_taxon in the v2 API.
  • taxonMappings: [String!]
  • description: String
  • price: String
  • salePrice: String
  • saleType: AdvertSaleTypeEnum
  • priceType: AdvertPriceTypeEnum
  • priceUnit: AdvertPriceUnitEnum
  • specifications: String
  • productFeatures: [String!]
  • youtubeVideoUrl: String
  • customIframeUrl: String
  • # Optional product code for the advert.
  • code: String
  • # Optional external id to identify the product
  • externalId: String
  • # Metadata key/value pairs.
  • metadata: [KeyValueInput!]
  • # External IDs key/value pairs.
  • externalIds: [KeyValueInput!]
  • # Optional gender that is attributed to the product
  • gender: AdvertGenderEnum
  • # Maximum purchase quantity allowed for successful checkout
  • maxPurchaseQuantity: Int
  • # Minimum purchase quantity allowed for successful checkout
  • minPurchaseQuantity: Int
  • # The additional cost of shipping the product domestically, which is added to the
  • # Sellers base domestic shipping rate.
  • baseDomesticShippingCost: String
  • # The additional cost of shipping the product internationally, which is added to
  • # the Sellers base international shipping rate.
  • baseInternationalShippingCost: String
  • attemptAutoPublish: Boolean
  • vetted: Boolean
  • vettingRejectedReason: String
  • customIframeThumbnail: ImageInput
  • variants: [VariantInput!]
  • images: [ImageInput!]
  • # PDF documents relating to the advert
  • documents: [AdvertDocumentInput!]
  • # DEPRECATED: This argument is deprecated in favour of AdvertOptionValues. Option
  • # value ids for multi-select option types
  • featureOptionValueIds: [ID!]
  • # DEPRECATED: This argument is deprecated in favour of AdvertOptionValues.
  • # Key-value pairs of single-select and free-text option type values.
  • productDetails: [KeyValueInput!]
  • # Advert option values of the advert. If this argument is given, advert option
  • # values will be updated to match the input and delete the missing ones.
  • advertOptionValues: [AdvertOptionValueInput!]
  • shippingParcelAttributes: ShippingParcelInput
  • recommendedRetailPrice: String
  • wholesalePrice: String
  • salePriceStartAt: ISO8601DateTime
  • salePriceEndAt: ISO8601DateTime
  • wholesalePromoPrice: String
  • wholesalePromoPriceStartAt: ISO8601DateTime
  • wholesalePromoPriceEndAt: ISO8601DateTime
  • therapeuticGoodsLabellingEnabled: Boolean
  • taxCode: String
  • itemTaxRate: Decimal
  • hasFreeDomesticShipping: Boolean
  • }

link Require by