Source
Extensibility & developer surface — found from sitemap — VTEX
Checked for VTEX on 10 Nov 2026
- Page
- https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-api-schema
- Checked
- 10 Nov 2026, 06:45 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:9dd69a76478e410d4b5ffcf0291ba4fd4d825b36dec00078a289cf698ad4330d
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
API schema extension Report an error
“This guide will teach you how to extend VTEX and third-party APIs to suit your store's needs.”
-
Graphql based Report an error
“Since FastStore uses GraphQL, you need to include type definitions and resolvers to fetch the desired data.”
-
Extension folder structure Report an error
“The src/graphql/vtex/resolvers and src/graphql/vtex/typeDefs paths are mandatory, but you can organize the files inside those directories as you wish.”
-
Typedefs format Report an error
“The typeDefs files must have a .graphql extension. Also, index.ts is necessary for resolvers but not required for typeDefs.”
-
Typescript support Report an error
“Note that you can leverage the use of TypeScript by typing the root param as StoreProductRoot:”
-
Custom search sort version Report an error
“FastStore 4.9.0 and later versions can resolve extra StoreSort values.”
-
Custom sort key locations Report an error
“The same key must appear in three places: The StoreSort extension. api.customSortMap in discovery.config.js. The registerCustomSortKeys call in the storefront.”
-
Custom sort map priority Report an error
“FastStore checks customSortMap before the built-in sort values. A key in this map overrides the default mapping for that key.”
-
Custom sort builtin control limitation Report an error
“The built-in Product Gallery sort control renders the default StoreSort values. A key that exists only in customSortMap does not appear in that control.”
-
Unmapped sort behavior Report an error
“A StoreSort value missing from customSortMap and from the built-in map returns a bad request with the message Unknown sort value. Keys inherited from Object.prototype, such as constructor, are rejected the same way.”
-
Third party extension structure Report an error
“If you already have the directory structure created in the Extending VTEX API schemas, add the thirdParty folder inside src/graphql.”
-
Third party query mutation Report an error
“When developing a third-party extension, it's essential to create a Query or Mutation schema. This schema is crucial for generating new query entry points to access data.”
-
Dev server command Report an error
“Use the command yarn dev in the terminal to run the development server and monitor changes effectively.”
Scores citing this record
- The B2B Seller Extensibility & developer surface
- The Data Protection Officer Extensibility & developer surface
- The Developer Extensibility & developer surface
- The Merchant Extensibility & developer surface
- The Operations Lead Extensibility & developer surface
- The Skeptic Extensibility & developer surface