INPUT_OBJECT
UpdateProductInput

Input type of UpdateProduct and UpdateWork products field
GraphQL Schema definition

input UpdateProductInput {
#   The Consonance unique identifier
id: Int!
#   ISBN-13 for the product
isbn: String
#   For products not eligible for an ISBN, store the GTIN-8, GTIN-12 (UPC), GTIN-13, 
#   or GTIN-14
gtin: String
#   The Amazon Standard Identification Number for the product
asin: String
#   The product's title prefix, if different from the parent work
prefix: String
#   The product's title without prefix, if different from the parent work
title: String
#   The product's subtitle, if different from the parent work
subtitle: String
#   The product's in-house reference
publishersReference: String
#   The product's legacy ID, used to provide compatibility with previous systems
internalReference: String
#   The product's DOI
productIdentifyingDoi: String
#   A unique identifier for the client performing the mutation
clientMutationId: String
#   Optional text to give a detailed description of the product form
productFormDescription: String
#   Client-specific field to accommodate a bookshop classification on the AI
bookshopClassification: String
#   Optional text to give a detailed description of the ebook's format
epubTypeDescription: String
#   Optional text to give the version of the ebook's format
epubTypeVersion: String
#   Optional text to give a note about the ebook's format
epubTypeNote: String
#   The date the product is released, not specific to a geographical market. This 
#   date is primarily used for planning, promotion and other business process 
#   purposes, and is not necessarily the first date for retail sales or fulfillment 
#   of pre-orders. In the absence of a sales embargo date, retail sales and 
#   pre-order fulfillment may begin as soon as stock is available to the retailer.
publicationDate: ISO8601Date
#   The date on which you expect to release the product. This is not used in ONIX or 
#   other feeds to the trade, so can be used for forward planning or for recording 
#   initial expectations that were later modified.
plannedPublicationDate: ISO8601Date
#   The date a publisher permits a new product to be announced to the book trade. 
#   Must be before the publication date. In the absence of a trade announcement 
#   date, the planned product may be announced to supply chain partners (but not 
#   necessarily made public) as soon as metadata is available. Your recipients may 
#   not obey the announcement date, even when they've received your instructions via 
#   ONIX.
tradeAnnouncementDate: ISO8601Date
#   The date a publisher permits a product to be announced to the general public. 
#   Must be before the publication date, and after the trade announcement date.  In 
#   the absence of an announcement date, the planned product may be announced to the 
#   public as soon as metadata is available. Your recipients may not obey the 
#   announcement date, even when they've received your instructions via ONIX.
publicAnnouncementDate: ISO8601Date
#   The date from which any embargo is lifted. If there is an embargo on retail 
#   sales before a certain date, this is the date from which the embargo is lifted 
#   and retail sales and fulfillment of pre-orders are permitted. In the absence of 
#   an embargo date, retail sales and pre-order fulfillment may begin as soon as 
#   stock, or product files for a digital product, is available to the retailer. 
#   Your recipients may not obey the embargo, even when they've received your 
#   instructions via ONIX.
onSaleDate: ISO8601Date
#   The date on which the product is declared to no longer be in print. Can be in 
#   the future; must be after the publication date.
outOfPrintDate: ISO8601Date
#   An [ONIX code](https://ns.editeur.org/onix/en/64) describing the publishing 
#   status of a product, as determined by the publisher and not specifically 
#   relating to a single geographical market e.g. "07": Out of print
onixPublishingStatusCode: ONIXPublishingStatusCode
#   Children's Book Marketing Category type or format code for the product
productCbmcTypeFormatCode: TypeFormat
#   A legacy code that describes the availability of the product from suppliers. 
#   This is an ONIX element that was dropped from ONIX 3.0 in favour of Product 
#   Availability. Only update it if you have good reason not to use the Product 
#   Availability code.
onixAvailabilityCode: ONIXAvailabilityCode
#   The modern way to describe the availability of the product from suppliers. 
#   Included in both ONIX 2.1 and 3.0.
onixProductAvailabilityCode: ONIXProductAvailabilityCode
#   Imprint id
imprintId: Int
#   A free text statement of the whole of the authorship of the work in the form in 
#   which the publisher intends it to be displayed.
productAuthorshipDescription: String
#   The product height in millimetres, including all packaging and boards
productHeightMm: Int
#   The product width in millimetres, including all packaging and boards
productWidthMm: Int
#   The page height in millimetres, excluding all packaging and boards
pageTrimHeightMm: Int
#   The page trim width in millimetres, excluding all packaging and boards
pageTrimWidthMm: Int
#   The product thickness in millimetres, including all packaging and boards
productThicknessMm: Int
#   The product weight in grams
unitWeightGr: Int
#   The product height in inches, including all packaging and boards
productHeightIn: Float
#   The product width in inches, including all packaging and boards
productWidthIn: Float
#   The page trim height in inches, excluding all packaging and boards
pageTrimHeightIn: Float
#   The page trim width in inches, excluding all packaging and boards
pageTrimWidthIn: Float
#   The product thickness in inches, including all packaging and boards
productThicknessIn: Float
#   The product weight in ounces
unitWeightOz: Float
#   An [ONIX 2.1 code](https://ns.editeur.org/onix36/en/10) for ebooks only, 
#   describing the ebook's format
onix21EpubTypeCode: ONIX21EpubTypeCode
#   An [ONIX 2.1 code](https://ns.editeur.org/onix36/en/7) describing the product's 
#   form
onix21ProductFormCode: ONIX21ProductFormCode
#   An [ONIX code](https://ns.editeur.org/onix/en/12) describing the trade category 
#   of the product
tradeCategoryCode: ONIXTradeCategoryCode
#   An [ONIX code](https://ns.editeur.org/onix/en/91) describing the country of 
#   manufacture of the product
countryOfManufactureCode: ONIXCountryCode
#   An [ONIX code](https://ns.editeur.org/onix/en/80) describing the packaging of 
#   the product
productPackagingCode: ONIXProductPackagingCode
#   An [ONIX code](https://ns.editeur.org/onix/en/175) describing the flowability of 
#   the product
onixEpubReflowabilityCode: ONIXEpubReflowabilityCode
#   An [ONIX code](https://ns.editeur.org/onix/en/175) describing the encoding
audioEncodingCode: ONIXAudioEncodingCode
#   An [ONIX code](https://ns.editeur.org/onix/en/175) describing the bit rate
audioBitRateCode: ONIXAudioBitRateCode
#   An [ONIX code](https://ns.editeur.org/onix/en/175) describing the audio channels
audioChannelsCode: ONIXAudioChannelsCode
#   The status to be applied by default to the work's prices, unless they or their 
#   product has a status set themselves.
onixPriceStatusCode: ONIXPriceStatusCode
#   An ONIX code indicating the tax rate type, from only the codes in [ONIX code 
#   list 62](https://ns.editeur.org/onix/en/62) which apply to GB prices.
gbVatCode: GbVatCode
#   Defaults to auto, but can instead be set to a different release type to see the 
#   effect on agency prices.
appleReleaseTypeOverride: AppleRelease
#   A list of codes sent in ONIX describing the position and type of barcode on the 
#   product.
barcodeCodes: [BarcodeCode!]
#   An array of shop record IDs to indicate which website shops the product should 
#   be sent to in feeds.
shopIds: [Int!]
#   A list of codes sent in ONIX describing the ebook content
productContentTypeCodes: [ONIXContentTypeCode!]
#   A list of codes sent in ONIX describing ebook accessibiltity features
onixEpubAccessibilityCodes: [ONIXEpubAccessibilityCode!]
#   A short, explanatory summary of the accessibility of the product, consistent 
#   with the details selected. Note both accessibility features, and any potential 
#   deficiencies.
epubAccessibilitySummary: String
#   A list of codes sent in ONIX detailing product forms
onix21ProductFormDetailCodes: [ONIX21ProductFormDetailCode!]
#   A Consonance system list of price types which the client expects to manage, 
#   which incorporate currency code, price type and price qualifier. This format is 
#   structured like CCC-TT-QQ where:
# 
#   * CCC is the currency.
#   * TT is a code for the price type e.g. 01 means RRP (from a list which is a 
#   subset of ONIX code list 58).
#   * QQ is the ONIX price type qualifier e.g. 05 means consumer (from a list which 
#   is a subset of ONIX code list 59).
# 
#   e.g. USD-01-05 is the USD consumer RRP price.
systemPrices: [PriceInput!]
#   The number of tracks on the audiobook product
tracks: Int
#   The number of items in the product, where the product contains multiple items of 
#   the same form. e.g. for a shrink-wrapped pack of three paperbacks, enter “3”.
numberOfPieces: Int
#   Applicable to physical products only, and indicates the quantity of products in 
#   each carton or binder’s pack
cartonQty: Int
#   Applicable to physical products only, and indicates the quantity of products on 
#   each complete pallet
palletQty: Int
#   The scale of a map, expressed as a ratio 1:nnnnn; only the number nnnnn is 
#   carried in the data element, without spaces or punctuation. For a map of scale 
#   1:25,000, input the number "25000". If the product comprises maps with two or 
#   more different scales then separate them with a space. Errors in entering a 
#   series of integers separated by spaces will be silently ignored.
mapScales: String
#   Optional and only appears if the client has asked us to enable this on their 
#   Consonance account
stockItemNumber: String
#   Optional and only appears if the client has asked us to enable this on their 
#   Consonance account
stockLocation: String
#   Used to define trade tariffs. Where possible, Consonance infers a code from the 
#   product form, BISAC, and Thema codes: this mutation accepts an 8-digit number to 
#   override the inferred value
hmrcCommodityCodeOverride: String
#   The product's BISAC returnable indicator code, from ONIX code list 66.
bisacReturnsCodeCode: String
#   A code of 6, 8, or 10 digits, assigned to classify products for international 
#   trade. Defined by the World Customs Organization as part of the Harmonized 
#   Commodity Description and Coding System.
wcoHarmonizedSystemCode: String
#   The total number of pages in a book, including unnumbered pages, front matter, 
#   back matter, etc. This includes any blank pages at the back that carry no 
#   content and are present only for convenience of printing and binding.
productionPageCount: Int
#   The highest-numbered page in a single numbered sequence of main content, usually 
#   the highest Arabic-numbered page in a book; or, for books without page numbers 
#   or (rarely) with multiple numbered sequences of main content, the total number 
#   of pages that carry the main content of the book. Note that this may include 
#   numbered but otherwise blank pages (e.g. pages inserted to ensure chapters start 
#   on a recto page) and may exclude unnumbered (but contentful) pages such as those 
#   in inserts/plate sections. It should exclude pages of back matter (e.g. any 
#   index) even when their numbering sequence continues from the main content. 
#   Either this or the "Content page count" is the preferred page count for most 
#   books for the general reader.
mainContentPageCount: Int
#   The total number of numbered (usually Roman-numbered) pages that precede the 
#   main content of a book. This usually consists of various work and imprint pages, 
#   table of contents, an introduction, preface, foreword, etc.
frontMatterPageCount: Int
#   The total number of numbered (often Roman-numbered) pages that follow the main 
#   content of a book. This usually consists of an afterword, appendices, endnotes, 
#   index, etc. It excludes blank (or advertising) pages that are present only for 
#   convenience of printing and binding.
backMatterPageCount: Int
#   The sum of all Roman- and Arabic-numbered pages. Note that this may include 
#   numbered but otherwise blank pages (eg pages inserted to ensure chapters start 
#   on a recto page) and may exclude unnumbered (but contentful) pages such as those 
#   in inserts/plate sections. It is the sum of the "Main content", "Front matter", 
#   and "Back matter" page counts.
totalNumberedPages: Int
#   The sum of all Roman- and Arabic-numbered and contentful unnumbered pages. Sum 
#   of page counts with codes 00, 03, 04 and 12, and also the sum of 05 and 12.
contentPageCount: Int
#   The total number of unnumbered pages with content inserted within the main 
#   content of a book – for example inserts/plate sections that are not numbered.
totalUnnumberedInsertPageCount: Int
#   An indication of the total number of pages in a book or other printed product. 
#   This is not intended to represent a precise count of numbered and unnumbered 
#   pages. It is usually sufficient to take the number from the last numbered page. 
#   If there are two or more separate numbering sequences (e.g. xviii + 344), the 
#   numbers in each sequence may be added together to make an overall total (in this 
#   case 362), but do not count unnumbered pages except if the book does not have 
#   numbered pages at all. For multi-volume books, enter the total for all the 
#   volumes combined.
approximatePageCount: Int
#   An indication of the actual number of pages in a digital book. Only applies to 
#   fixed-format ebooks and PDFs.
absolutePageCount: Int
#   The principal font, and optionally font size, used for body text, when this is a 
#   significant aspect of product description e.g. for some Bibles, and for large 
#   print products
featureTextFont: String
#   A statement asserting that the product is made from paper produced using 
#   environmentally-conscious technology
featurePaperEnvironmentalStatement: String
#   An [ONIX code](https://ns.editeur.org/onix/en/76) describing the DVD region
onixDvdRegionCode: ONIXDvdRegionCode
#   An [ONIX code](https://ns.editeur.org/onix/en/143) describing choking hazard 
#   warning codes
onixCpsiaChokingHazardWarningCode: ONIXCpsiaChokingHazardWarningCode
#   An [ONIX code](https://ns.editeur.org/onix/en/184) describing toy safety codes
onixEuToySafetyHazardWarningCode: ONIXEuToySafetyHazardWarningCode
#   An [ONIX code](https://ns.editeur.org/onix/en/98) describing the main colour of 
#   the cover
featureColourOfCoverCode: ONIXColourCode
#   An [ONIX code](https://ns.editeur.org/onix/en/98) describing the colour of the 
#   book edge
featureColourOfPageEdgeCode: ONIXColourCode
#   An [ONIX code](https://ns.editeur.org/onix/en/99) describing special cover 
#   material
featureSpecialCoverMaterialCode: ONIXSpecialCoverMaterialCode
#   The in-house edition assigned to the product
inHouseEditionId: Int
#   The in-house format assigned to the product. This may update other fields e.g. 
#   product form
inHouseFormatId: Int
#   The number and type of illustrations. The text may also include other content 
#   items, e.g. maps, bibliography, tables, index etc.
illustrationsNote: String
#   The total number of illustrations in a book or other printed product.
# 
#   The more informative free text field "IllustrationsNote" and/or the use of 
#   "Ancillary Content" are strongly preferred, but some ONIX recipients may accept 
#   only this simple count.
numberOfIllustrations: Int
#   Edition numbers should be at work level. Only used for legacy numbers.
edition: Int
#   Typically used for revisions to ebooks, this is the number of a numbered 
#   revision within an edition number. To be used only where a publisher uses such 
#   two-level numbering to indicate revisions which do not constitute a new edition 
#   under a new ISBN or other distinctive product identifier.
editionVersionNumber: Int
#   A short, free-text description of a version or edition. When used, the Edition 
#   Statement must carry a complete description of the nature of the edition, i.e. 
#   it should not be treated as merely supplementary to an Edition Type Code or an 
#   Edition Number. The Edition Statement should be strictly limited to describing 
#   features of the content of the edition, and should not include aspects such as 
#   rights or market restrictions which are properly covered elsewhere.
editionStatement: String
#   A list of the product's ONIX edition type codes
onixEditionTypeCodes: [ONIXEditionTypeCode!]
#   Illustration and other content types for the product
productAncillaryContentsOverride: [UpdateAncillaryContentInput!]
#   The ID of the replaced product
replacedProductId: Int
#   The ID of the product that this product is a special edition of
specialEditionOfId: Int
#   The number of words of natural language text
wordCount: Int
#   The size of the file in bytes
fileSize: BigInt
#   Whether the product — audiobook or ebook — is watermarked
digitalWatermarking: Boolean
#   Indicates that the product is available to be sent in appropriate ONIX feeds.
allowOnixExports: Boolean
#   Adds a sales restriction to ONIX exports, indicating that the ISBN is assigned 
#   for internal publisher use only, and that the product is not to be listed. This 
#   automatically prevents the product from being included in any ONIX feeds, unless 
#   arranged with us by contacting support.
salesRestrictionInternalUseOnly: Boolean
#   A code to denote any Digital Rights Management restrictions affecting the 
#   product
digitalRightsManagementCode: DigitalRightsManagementCode
#   The number of pages in the matching print product
numberOfPagesInPrintCounterpart: Int
#   The total duration of the audio book in time
duration: DurationInput
#   Duration in time of introductory matter. This is the "running time" equivalent 
#   of the "Front matter page count", and comprises any significant amount of 
#   running time represented by announcements, titles, introduction or other 
#   material prefacing the main content.
durationOfIntroductoryMatter: DurationInput
#   Duration in time of the main content. This is the "running time" equivalent of 
#   the "Main content page count", and excludes time represented by announcements, 
#   titles, introduction or other prefatory material or "back matter".
durationOfMainContent: DurationInput
#   Description of the number of copies already sold
copiesSoldAnnouncement: String
#   Description of the number of copies which will be printed
printRunAnnouncement: String
#   Description of the reprint history
reprintDetailsAnnouncement: String
#   Communicates to Simon & Schuster your target date for the initial print run
initialPrintDate: ISO8601Date
#   Communicates to Simon & Schuster your target sell-through for the initial print 
#   run
initialPrintSellthroughGoal: Int
}
UpdateProductInput

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
