https://github.com/vtex-apps/store-graphql
GraphQL schema and resolvers for the VTEX Commerce Stores API
https://github.com/vtex-apps/store-graphql
graphql hacktoberfest srv-store-framework store-framework vtex-io xp-developer
Last synced: 25 days ago
JSON representation
GraphQL schema and resolvers for the VTEX Commerce Stores API
- Host: GitHub
- URL: https://github.com/vtex-apps/store-graphql
- Owner: vtex-apps
- Created: 2017-01-24T19:03:04.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-12-17T16:55:14.000Z (about 2 months ago)
- Last Synced: 2025-12-21T05:28:59.754Z (about 2 months ago)
- Topics: graphql, hacktoberfest, srv-store-framework, store-framework, vtex-io, xp-developer
- Language: TypeScript
- Homepage:
- Size: 3.58 MB
- Stars: 81
- Watchers: 53
- Forks: 46
- Open Issues: 21
-
Metadata Files:
- Readme: docs/README.md
- Changelog: CHANGELOG.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# VTEX Store GraphQL
[](#contributors-)
## Description
This project is a GraphQL API build in our [VTEX IO Platform](https://vtex.io/) as an abstraction of all VTEX public [REST API](https://help.vtex.com/developer-docs) that our commerce stores needed.
:loudspeaker: **Disclaimer:** Don't fork this project; use, contribute, or open issue with your feature request.
## Release schedule
| Release | Status | Initial Release | Maintenance LTS Start | End-of-life |
| :-----: | :-----------------: | :-------------: | :-------------------: | :---------: |
| [2.x] | **Current Release** | 2018-03-05 | | |
| [3.x] | **Unscheduled** | ---------- | | |
## Table of Content
- [VTEX Store GraphQL](#vtex-store-graphql)
- [Description](#description)
- [Release schedule](#release-schedule)
- [Table of Content](#table-of-content)
- [Depreaction Notices](#depreaction-notices)
- [Usage](#usage)
- [Queries](#queries)
- [Catalog](#catalog)
- [Logistics](#logistics)
- [Checkout](#checkout)
- [OMS](#oms)
- [Profile System](#profile-system)
- [Mutations](#mutations)
- [Checkout](#checkout-1)
- [Profile System](#profile-system-1)
- [Contributing](#contributing)
- [Troubleshooting](#troubleshooting)
- [Contributors](#contributors)
### Depreaction Notices
The queries `facets`, `product`, `products`, `productSearch`, `autocomplete`, `searchMetadata` and `productsByIdentifier` were deprecated. They were moved to a new app `vtex.search-graphql`, use the queries from that app from now on.
## Usage
TODO
## Queries
### Catalog
- `product` - Returns a specified product - DEPRECATED
- `products` - Returns products list filtered and ordered - DEPRECATED
- `facets` - Returns facets category - DEPRECATED
- `category` - Returns a specified category
- `categories` - Returns categories tree
- `brand` - Returns a specified brand
- `brands` - Returns brands list
- `pagetype` - Returns the page type based on path and query
### Logistics
- `shipping` - Returns orderForm shipping simulation
### Checkout
- `orderForm` - Returns checkout cart details
- `searchOrderForm` - Returns a specified checkout cart details
### OMS
- `orders` - Returns user orders details
- `order` - Returns a specified user order
- `userLastOrder` - Returns the last order made by a logged in customer
### Profile System
- `profile` - Returns user profile details
### VTEXID
- `loginSessionsInfo` - Returns an object with currently active user login sessions and the ID of the current session
## Mutations
### Checkout
- `addItem`
- `updateItems`
- `updateOrderFormProfile`
- `updateOrderFormShipping`
- `updateOrderFormPayment`
- `updateOrderFormIgnoreProfile`
- `addOrderFormPaymentToken`
- `setOrderFormCustomData`
- `createPaymentSession`
- `createPaymentTokens`
- `cancelOrder`
### Profile System
- `createAddress`
- `updateProfile`
- `updateAddress`
- `deleteAddress`
### VTEXID
- `logOutFromSession` - Logs out from a specific login session (this can't be the current one - it doesn't delete the cookie)
## Contributing
TODO
## Troubleshooting
You can check if others are passing through similar issues [here](https://github.com/vtex-apps/store-graphql/issues). Also feel free to [open issues](https://github.com/vtex-apps/store-graphql/issues/new).
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Reginaldo
=�
Julio Moreira
=�
gustavopvasconcellos
=�
Lucas Yamamoto
=�
Lucas Pacheco
=�
Beatriz Miranda
=�
Gabriel Carafizi
=�
Marcos Andr� Suarez Ewbank
=�
leoWorkingGood
=�
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
**Upcoming documentation:**
- [Writing newsletter option to the correct place](https://github.com/vtex-apps/store-graphql/pull/602)