README.md

VTEX Store GraphQL

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

• VTEX Store GraphQL
  • Description
  • Release schedule
  • Table of Content
    • Depreaction Notices
  • Usage
  • Queries
    • Catalog
    • Logistics
    • Checkout
    • OMS
    • Profile System
  • Mutations
    • Checkout
    • Profile System
  • Contributing
  • Troubleshooting
  • 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. 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!

Upcoming documentation:

• Writing newsletter option to the correct place