Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
Data Model
vtex.rewriter
Version: 1.70.0
Latest version: 1.70.0

Rewriter stores route data in VBase and exposes it through the GraphQL schema in graphql/schema.graphql.

RouteLocator

Identifies a route entry.

  • from: original URL path.
  • binding: VTEX binding identifier.

Redirect

Represents an HTTP redirect route.

  • Stored in the redirects VBase bucket.
  • Located by RouteLocator.
  • Includes source path, target URL, redirect type, binding, and optional expiration metadata.
  • Takes precedence over internal routes during request resolution.

Internal

Represents a transparent route rewrite to a Store Framework entity.

  • Stored in the internals VBase bucket.
  • Located by RouteLocator.
  • Includes source path, entity id, entity type, declarer, binding, and route metadata.
  • May participate in reverse indexes for entity-to-route lookups across bindings.

RoutesByBinding

Maps a VTEX entity route to the URL used by each binding.

  • Backed by reverse-index storage.
  • Used by GraphQL route lookup flows and hreflang alternate generation.

RouteIndexEntry

Represents a route index item used by deprecated index/list APIs.

  • id: route key.
  • lastChangeDate: timestamp used to track route index freshness.

RouteIndexFiles

Represents chunked route index files used by legacy index operations.

  • lastChangeDate: index freshness timestamp.
  • routeIndexFiles: file names and sizes for route index chunks.

Settings

Configured through manifest.json settingsSchema and persisted as VTEX app settings.

  • routesVersion: invalidates persisted route cache when changed.
  • blockDefaultBinding: blocks default binding routes in other bindings.
  • URL enforcement flags: lowercase and ending slash canonicalization.
  • Hreflang flags and custom hreflang mappings.
See also
Vtex.rewriter
VTEX IO Apps
VTEX App Store
VTEX IO Apps
Was this helpful?