OBJECT

ElectronicBookProduct

A textual or graphical book product in electronic form, such as one delivered via PDF or EPUB file formats, or viewable online as HTML

link GraphQL Schema definition

  • type ElectronicBookProduct implements Product {
  • # The total number of pages of the product, counting the cover as page 1. Used
  • # only for digital publications delivered with fixed pagination.
  • absolutePageCount: Int
  • # The edition statement applied specifically to this product, not inherited from
  • # the work
  • actualEditionStatement: String
  • # Whether the product is approved for inclusion in ONIX
  • allowOnixExports: Boolean!
  • # The agency prices inferred from the release type and the prices on the work,
  • # based on exchange rates as of the end of last month.
  • appleReleaseTypeAgencyPrices: [String!]
  • # The Apple release type that the system will use. When 'automatic', this shows
  • # the inferred release type.
  • appleReleaseTypeOverride: String
  • # The Apple release type that the system will use. When 'automatic', this shows
  • # the inferred release type.
  • appleReleaseTypeResultCode: String
  • # The reasons why this release type is being used
  • appleReleaseTypeResultReasons: [String!]
  • # An indication of the total number of pages in a 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
  • # The product's ASIN
  • asin: String
  • # A free text statement of the whole of the authorship of the work (or the
  • # product, if overrides exist) in the form in which the publisher intends it to be
  • # displayed.
  • authorshipDescription: String
  • # Client-specific field to accommodate a bookshop classification for the AI
  • bookshopClassification: String
  • # The products that this product contains
  • containedProductParts: [ProductPart!]!
  • # A list of contributions made by contacts to the product
  • contributions: [Contribution!]!
  • # Description of the number of copies already sold
  • copiesSoldAnnouncement: String
  • # The code of any Digital Rights Management restrictions affecting the product
  • digitalRightsManagementCode: DigitalRightsManagementCode
  • # Any Digital Rights Management restrictions affecting the product
  • digitalRightsManagementValue: String
  • # Whether the product — audiobook or ebook — is watermarked
  • digitalWatermarking: Boolean
  • # The link to the DOI
  • doiLink: String
  • # Edition numbers should be at work level. Only used for legacy numbers.
  • edition: 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. May be
  • # inherited from the work.
  • editionStatement: String
  • # 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, explanatory summary of the accessibility of the product, consistent
  • # with the details selected. Note both accessibility features, and any potential
  • # deficiencies.
  • epubAccessibilitySummary: String
  • # A detailed description of the ebook's format
  • epubTypeDescription: String
  • # A note about the ebook's type
  • epubTypeNote: String
  • # The version of the ebook's format
  • epubTypeVersion: String
  • # The size of the digital file, in bytes
  • fileSize: BigInt
  • # The size of the digital file, in bytes
  • filesizeBytes: Int @deprecated( reason: "Renamed to `fileSize` for consistency" )
  • # The countries in which the product is for sale
  • forSaleCountryCodes: [ONIXCountryCode!]!
  • # The title of the product with ISBN and edition
  • formattedTitle: String
  • # The full title, including prefix. This is constructed by Consonance from the
  • # title and title prefix of the work (or the product if overrides exist).
  • fullTitle: String!
  • # 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!
  • # The product's GTIN
  • gtin: String
  • # The unique Consonance identifier
  • id: Int!
  • # The number and type of illustrations. The text may also include other content
  • # items, e.g. maps, bibliography, tables, index etc.
  • #
  • # If present, this overrides the work level illustrations note.
  • illustrationsNote: String
  • # The imprint or brand name
  • #
  • # ### EDItEUR advice
  • # There is often significant confusion over the nature of the imprint and
  • # publisher. In almost all cases, this can be clarified through understanding that
  • # the imprint is merely a brand name, whereas the publisher is a legal entity of
  • # some kind (often but not necessarily a commercial organisation). The uncertainty
  • # arises because the organisation may use its own name as its brand – this is
  • # almost always the case with small publishers. And naturally, when one publisher
  • # acquires another, one organisation disappears, but its brand name may live on as
  • # a brand of the acquiring publisher. Over time, large publishers acquire a
  • # portfolio of brands or imprints.
  • #
  • # Further uncertainty can arise where a series or collection of products becomes
  • # very large – does it become a brand in its own right? Ultimately, identities can
  • # be arranged in a hierarchy, from the narrowest (the title of a single book),
  • # through sub-series and series with their collection titles, to the imprint or
  • # brand which may encompass many books and collections of books, to a publisher
  • # with one or many brands, and eventually to the broadest (a conglomerate that
  • # owns several publishing companies. A workable rule of thumb is that the imprint
  • # is the broadest entity in that hierarchy that is not a legal entity, and the
  • # publisher is the narrowest entity that is a legal entity.
  • imprint: Imprint
  • # The in-house edition assigned to the product
  • inHouseEdition: InHouseEdition
  • # The in-house format assigned to the product
  • inHouseFormat: InHouseFormat
  • # The product's internal reference
  • internalReference: String
  • # Whether the product is for sale worldwide or not
  • isForSaleWorldwide: Boolean!
  • # The product's ISBN-13
  • isbn: ISBN!
  • # A list of marketing texts
  • #
  • # Arguments
  • # variantIn: Marketing text variant is any of
  • marketingTexts(variantIn: [MarketingTextVariant!]): [MarketingText!]!
  • # The countries in which the product is not for sale
  • notForSaleCountryCodes: [ONIXCountryCode!]!
  • # 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.
  • # If present, this overrides the work level illustrations note.
  • numberOfIllustrations: Int
  • # The total number of pages in the print counterpart of a digital product
  • # delivered without fixed pagination. The total number of pages is equivalent to
  • # the 'Content page count'.
  • numberOfPagesInPrintCounterpart: Int
  • # 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 product's ebook type, expressed in the ONIX 2.1 format
  • onix21EpubType: ONIXCode!
  • # The ONIX 2.1 code describing the product's ebook format
  • onix21EpubTypeCode: ONIX21EpubTypeCode!
  • # The product's form, expressed in the ONIX 2.1 format
  • onix21ProductForm: ONIXCode!
  • # The product's ONIX 2.1 product form
  • onix21ProductFormCode: ONIX21ProductFormCode!
  • # The product's ONIX 2.1 product form detail codes
  • onix21ProductFormDetailCodes: [ONIX21ProductFormDetailCode!]!
  • # The product's form, expressed in the ONIX 2.1 format
  • onix21ProductFormDetails: [ONIXCode!]
  • # A legacy way to describe the availability of the product from suppliers. This is
  • # an ONIX element that was dropped from ONIX 3.0 in favour of Product
  • # Availability.
  • onixAvailability: ONIXCode
  • # 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.
  • onixAvailabilityCode: ONIXAvailabilityCode
  • # The codes for the types of the version or edition
  • onixEditionTypeCodes: [ONIXEditionTypeCode!]!
  • # The types of the version or edition
  • onixEditionTypes: [ONIXCode!]!
  • # The ebook's accessibility features
  • onixEpubAccessibility: [ONIXCode!]
  • # The ONIX code describing the ebook's accessibility features
  • onixEpubAccessibilityCodes: [ONIXEpubAccessibilityCode!]
  • # The product's ebook reflowability status, expressed in the ONIX format
  • onixEpubReflowability: ONIXCode
  • # The ONIX code describing the ebook's reflowability
  • onixEpubReflowabilityCode: ONIXEpubReflowabilityCode
  • # The [ONIX code list 61](https://ns.editeur.org/onix/en/61) indicating values for
  • # a price status
  • onixPriceStatus: ONIXCode!
  • # A code from [ONIX code list 61](https://ns.editeur.org/onix/en/61) indicating
  • # the price status
  • onixPriceStatusCode: ONIXPriceStatusCode!
  • # The modern way to describe the availability of the product from suppliers. This
  • # is related to, but different from, the publishing status, in that particular
  • # availabilities are generally associated with particular publishing statuses.
  • # Included in both ONIX 2.1 and 3.0.
  • onixProductAvailability: ONIXCode
  • # A code that describes the availability of the product from suppliers. Included
  • # in both ONIX 2.1 and 3.0.
  • onixProductAvailabilityCode: ONIXProductAvailabilityCode
  • # The publishing status of the product
  • onixPublishingStatus: ONIXCode!
  • # 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!
  • # 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
  • # The date on which you expect to release the product
  • plannedPublicationDate: ISO8601Date
  • # The date on which you expect to release the product, in a string formatted
  • # according to directives specified
  • # [here](https://apidock.com/ruby/DateTime/strftime)
  • #
  • # Arguments
  • # directives: [Not documented]
  • plannedPublicationDateString(directives: String!): String
  • # The product the system believes is the previous edition of this one
  • previousEdition: Product
  • # A list of prices
  • #
  • # Arguments
  • # priceSearch: Search for prices based on their attributes
  • prices(priceSearch: PriceSearchAttributes): [Price!]!
  • # Illustration and other content types
  • productAncillaryContentsOverride: [AncillaryContent!]!
  • # A free text statement of the whole of the authorship of the product in the form
  • # in which the publisher intends it to be displayed
  • productAuthorshipDescription: String
  • # Children's Book Marketing Category type or format for the product
  • productCbmcTypeFormat: ChildrensBookMarketingCategoryTypeFormat
  • # Content type codes for a digital audiobook or ebook
  • productContentTypeCodes: [ONIXContentTypeCode!]
  • # Content types for a digital audiobook or ebook
  • productContentTypes: [ONIXCode!]
  • # Optional text to give a detailed description of the form of the product
  • productFormDescription: String
  • # The product's DOI
  • productIdentifyingDoi: String
  • # 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 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 the product is released, in a string formatted according to directives
  • # specified [here](https://apidock.com/ruby/DateTime/strftime)
  • #
  • # Arguments
  • # directives: [Not documented]
  • publicationDateString(directives: String!): String
  • # The product's in-house reference
  • publishersReference: String
  • # Where this product replaces one other than the previous edition. Typically this
  • # is used where a new work is available on the same subject as a previously
  • # published work, or where a new edition has different product types to the
  • # previous edition (for example, where a new edition is available only as an
  • # eBook, and the previous edition was print only).
  • replacedProduct: Product
  • # The id of the replaced product
  • replacedProductId: Int
  • # A Consonance system list of product forms whose prices cannot be edited with the
  • # usual interface.
  • requiresComplexPrices: Boolean!
  • # Whether the product is internal only
  • salesRestrictionInternalUseOnly: Boolean!
  • # A description of the product's territorial sales rights
  • salesRightsDescription: String!
  • # The shops to which the product is linked.
  • #
  • # To return only the products or works that are linked to a shop or shops, use the
  • # shopSearch attribute on products or works.
  • shops: [Shop!]
  • # The product that this product is a special edition of
  • specialEditionOf: Product
  • # The id of the product that this product is a special edition of
  • specialEditionOfId: Int
  • # The work's subtitle (or the product's, if overrides exist)
  • subtitle: String
  • # The supporting resources for the product, such as a cover or jacket image
  • supportingResources: [SupportingResource!]!
  • # 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: [SystemPrice!]
  • # The work's title prefix (or the product's, if overrides exist)
  • titlePrefix: String
  • # The title of the product with ISBN and proprietary edition code
  • titleWithProprietaryEdition: String
  • # The work's title without its prefix (or the product's, if overrides exist)
  • titleWithoutPrefix: String!
  • # 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 web links for the product
  • webLinks: [WebLink!]!
  • # The approximate number of words in the product
  • wordCount: Int
  • # The product's parent work
  • work: Work!
  • # The unique Consonance identifier for the product's work
  • workId: Int!
  • }

link Require by

This element is not required by anyone