Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EDU-13379: FastStore SDK overview #1471

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

EDU-13379: FastStore SDK overview #1471

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0f9e58f
add SDK overview
mariana-caetano Sep 27, 2024
2516f44
move FastStore SDK overview to loc folder and remove troubleshoot doc
mariana-caetano Nov 4, 2024
2ffebee
Update Crowdin configuration file
GeorgeLimaDev Nov 4, 2024
3433114
New translations overview.mdx (English, United States)
GeorgeLimaDev Nov 8, 2024
739b561
Fix formatting
sheilagomes Nov 8, 2024
b221504
Merge pull request #1538 from vtexdocs/l10n_faststore-sdk
mariana-caetano Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 0 additions & 57 deletions docs/localization/i-am-getting-errors-with-my-service-configuration-app.md
View file
Open in desktop

This file was deleted.

37 changes: 37 additions & 0 deletions docs/localization/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "FastStore SDK"
slug: "faststore-sdk"
mariana-caetano marked this conversation as resolved.
Show resolved Hide resolved
createdAt: "2024-09-09T10:00:00.000Z"
updatedAt: ""
---

The FastStore SDK is a toolkit that provides functions and interfaces for managing the state of key ecommerce features in the browser context. By providing a set of functions and interfaces, it simplifies tasks like tracking cart items and handling user sessions.

The SDK is organized into four modules, each with specific properties and behaviors. This track provides more details about each module.

- [Shopping cart](#shopping-cart)
- [Session](#session)
- [Search](#search)
- [Analytics](#analytics)

## Shopping cart

The Cart module controls the state of the shopping cart data structure in the shopper's browser. You can use them to add items to the cart, remove items, and clear the cart, among other tasks. Learn more about [shopping cart functions](LINK).

> ℹ️ Learn more about how to validate the cart in the shopper's browser against the information in the platform with [FastStore API mutations](https://developers.vtex.com/docs/guides/faststore/schema-mutations#cart).

## Session

The Session module manages the state of session information in the shopper's browser. This includes currency, channel, localization, and shopper data. Learn more about the [session SDK module](LINK) data structure and usage.

> ℹ️ Learn more about how to validate session data in the shopper's browser against the data in the platform with [FastStore API mutations](https://developers.vtex.com/docs/guides/faststore/schema-mutations#session).

## Search

The Search module offers functions for implementing a faceted search based on URL parameters. Whenever a shopper searches your store or changes the selected facets, the search module generates a unique and serialized URL and then directs the user to that URL.

Learn more about how to use the [SDK Search module](LINK) in your project.

## Analytics

The Analytics module helps you create a simple and extensive event system to feed your data pool. It is biased towards [Google Analytics 4](https://developers.google.com/analytics/devguides/collection/ga4) but supports other analytics providers. Go to the [Analytics](LINK) page to learn more.
Loading