Skip to content

GraphQL schema and resolvers for the VTEX Commerce Stores API

Notifications You must be signed in to change notification settings

quality-digital/store-graphql

 
 

Repository files navigation

VTEX Store GraphQL

All Contributors

Description

This project is a GraphQL API build in our VTEX IO Platform as an abstraction of all VTEX public REST API that our commerce stores needed.

📢 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

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

Mutations

Checkout

  • addItem
  • updateItems
  • updateOrderFormProfile
  • updateOrderFormShipping
  • updateOrderFormPayment
  • updateOrderFormIgnoreProfile
  • addOrderFormPaymentToken
  • setOrderFormCustomData
  • createPaymentSession
  • createPaymentTokens
  • cancelOrder

Profile System

  • createAddress
  • updateProfile
  • updateAddress
  • deleteAddress

Contributing

TODO

Troubleshooting

You can check if others are passing through similar issues here. Also feel free to open issues.

Contributors

Thanks goes to these wonderful people (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 specification. Contributions of any kind welcome!

About

GraphQL schema and resolvers for the VTEX Commerce Stores API

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%