GraphQL API
Search…
Introduction
Outshifter GraphQL API developer documentation for Channels
Welcome to the Outshifter GraphQL API developer documentation for Channels. Here you'll find introductions to all features, as well as resources, guides, and reference documentation for the APIs data structure.
GraphQL is a query language that allows clients to talk to an API server. Unlike REST, it gives the client control over how much or how little data they want to request about each object and allows relations within the object graph to be easily traversed.
BETA disclaimer
Please note that you are accessing the BETA versions of Outshifter's APIs which are in the process of being tested before their official release.
This being so, Outshifter does not give any warranties, whether express or implied, as to the suitability or usability of the APIs, its services, or any of its content. The sole purpose of the BETA versions is to conduct testing and obtain feedback. Should you encounter any bugs, glitches, lack of functionality, or other problems in the BETA versions, please email us at [email protected]

Index

General

Get to know the basics.
  • Introduction: A general explanation of what you will find in this documentation.
  • Features: Learn what's included in our GraphQL API for Channels.
  • GraphQL: A brief introduction to GraphQL, how we retrieve data through our API, and where to go for more resources.

Getting Started

Start touching the code - play, learn, and set up the installation.
  • Overview: Best practices to start using the Outshifter GraphQL API for Channels.
  • Architecture: How the main solution is organized and structured, and where the GraphQL API finds its place.
  • Playground: Play with our sandbox and explore the possibilities first hand.
  • API Key: How to get the user token needed for authentication.
  • SDK: How to get started with SDK
  • CLI: How to get started with CLI

GraphQL API

Learn about the available endpoints and how to use them.
  • Products: Retrieve multiple or just a single product from your Outshifter Catalog.
  • Categories: Product categories and subcategories.
  • Checkout & Payments: Implementing the purchase flow.
  • Orders: Create, retrieve and cancel orders.
  • Customers: Setting up and managing customer accounts.

API Data Reference

Our data repository and examples, based on the GraphQL structure.
Last modified 1mo ago