Welcome to the Redo v3 API
The v3 API is a GraphQL API covering your catalog, inventory, purchasing, shipping, marketing, and webhooks. Unlike the v2 REST API, you send a singlePOST
request describing exactly the data you want, and receive exactly that shape
back.
- Data endpoint:
https://api.getredo.com/v3/account/{storeId}/graphql - Schema endpoint:
https://api.getredo.com/v3/graphql-schema
POST. The schema endpoint serves
read-only introspection and requires no authentication.
The v3 API is stable. Changes to stable fields are additive: a field is
deprecated rather than removed or changed, and every change is listed in the
changelog. Members marked
experimental can still change. See
Stability and deprecation for the rules.
Quick start
Introspection
The schema is self-describing. Point any GraphQL client (GraphiQL, Apollo Sandbox, Insomnia,graphql-codegen) at the schema endpoint to explore
types, fields, and docs:
__schema, __type) only. No
store data is reachable there, so no token is needed.
Next steps
1
Authenticate
Create a service account and learn the bearer
scheme.
2
Send operations
Learn how queries and mutations
are structured.
3
Page through lists
Understand cursor-based pagination on
connections.
4
Explore the schema
Browse the reference, starting with
Catalog.