Skip to main content

GraphQL API extension for Scribd documents, PDFs, and video links

In this release, we have added an update that enhances the Product API with extended support for managing external resources. Users can now create and update:

  • Scribd document links
  • Video links (YouTube, Vimeo)
  • PDF links and uploads

All resources support localization across multiple languages (locales) and include robust validation mechanisms to ensure URL security and content quality. A new pdfFiles field has been introduced to eventually replace the legacy resources field.

Customer impact

  • Richer product content: Easily manage diverse external content (documents, videos, PDFs) in multiple locales.
  • Better end-user experience: Validation ensures links are secure and functional, reducing the risk of broken or unsafe URLs.
  • Performance optimization: Limits on PDF links help keep product pages responsive and organized.
  • Future-ready integration: New structured fields support a smoother transition from older resource formats.

Key changes

AspectDetails
Resource TypesAdded support for scribd documents, video links, and PDF files.
LocalizationResources can be localized across base and non-base locales.
ValidationEnforced HTTPS URLs, URL length limits, domain restrictions (YouTube, Vimeo), and file checks for PDFs.
Resource LimitsUp to 15 PDF links or uploads per product.
Product Field UpdatesIntroduced new pdfFiles field in preparation for deprecating resources.
Visibility ControlsOnly visible to Resellers toggle now applies across all locales.
Update StrategyResource updates are atomic and require full list replacements. No partial updates.

GraphQL API Enhancements

  • New fields:
    • externalResources inputs expanded in createProduct and updateProduct mutations to support Scribd, video, and PDF resources.
    • pdfFiles added to ProductExternalResources type as a new structured location for PDFs.
  • Validation rules:
    • Errors triggered on insecure URLs, malformed links, domain mismatches, or resource count violations.
  • Migration path:
    • Begin using pdfFiles now; support for the legacy resources field will be deprecated in a future release.

Feature enablement

No feature enablement is required.

Setting enablement

No setting enablement is required.

Documentation

Documentation will be updated with the release.

Was this page helpful?