Introduction

Introduction#

The Direct-to-Consumer (DTC) API represents a fusion of server-side and client-side GraphQL capabilities designed to empower developers in the creation of cutting-edge storefronts.

This innovative API enables interaction via session token management, facilitating seamless cart management and order finalization. Moreover, it offers access to the product catalog with enhanced security measures, ensuring sensitive data remains protected.

Key functionalities of the DTC API:

• Custom attribute filtering, brands or availability-based searches.

• Dynamic product listing pages featuring tailored filtering options and advanced search functionality.

• Product display pages optimized for engaging customer experiences.

• Category listings for streamlined navigation.

• Selection handling, facilitating seamless order finalization.

• Cart management functionalities such as adding products and bundles, handling subscriptions, and facilitating checkout processes.

• Integration ready with Centra's pre-built payment providers for secure and efficient transactions.

• Shipping options including 'buy online, ship from store' and 'buy online, pick up in-store'.

• Tax calculation capabilities, including support for external tax engines.

• Routing functionality to enhance page rendering based on URI access.

The DTC API leverages GraphQL, allowing for efficient data retrieval tailored to specific requirements, minimizing resource usage and optimizing network latency. The API's support for executing multiple queries/mutations in a single call further enhances performance, while its strongly typed schema ensures reliability and consistency.

Performance is a cornerstone of the DTC API, engineered to accommodate heavy frontend utilization without compromising on response times. Furthermore, the API offers flexible configuration options, including session and no-session modes. This flexibility extends to the management of affiliates, allocation rules, brick-and-mortar locations, and customizable bundles, enriching the development experience.

The documentation available includes example queries, mutations, and concepts. As well as migration path. However, every single field available in the API will not be thoroughly explained. When in need, refer to the GraphQL schema available via introspection.