Skip to main content

Merchant API

The Merchant API is a GraphQL API is designed to provide a seamless experience for developers to build powerful e-commerce applications. You can easily retrieve product information, process orders, get content, and more. Our API-first approach means that we prioritize providing a flexible and scalable API that can be integrated into any application or platform.

Introduction​

Our API-first approach means that we prioritize the development of a scalable and easy-to-use API that can be integrated with any application or platform. We've built our GraphQL API to provide access to product information, order processing, inventory management, and more. With our API, you can easily build custom applications that meet the unique needs of your business and customer experience.

Getting Started​

After you have created an account, you get an API key. You can find your API key for the Merchant GraphQL API in Merchant Center

GraphQL Playground​

Then head over to the GraphQL Playground to start exploring the API. The playground is a great way to test out queries and mutations without having to write any code. You can also use the playground to explore the schema and learn more about the API.

Authentication​

Authentication is done via the X-APIKEY header. You can find your API key in Merchant Center.

Add this to the HTTP HEADERS section of the playground
{
  "Accept": "application/json"
  ,"X-APIKEY":"your-secret-merchant-api-key" 
}

Here is an example of a query that returns all product categories to get you started:

Example query
query categories {
  categories {
    categoryId
    parentCategoryId
    order
    alias
    canonicalUrl
    alternativeCanonicalUrls
    name
    description
    isHidden
    googleTaxonomy {
      id
      parentId
      name
      path
    }
  }
}

The GraphQL Schema​

This documentation has been automatically generated from the GraphQL schema.

Use the docs in the sidebar to find out how to use the schema:

  • Allowed operations:
    • queries
    • mutations
  • Schema-defined types:
    • scalars
    • objects
    • enums
    • interfaces
    • unions
    • input objects
TL;DR

Head over to the Playground to start exploring the API. You can find schema documentation over there.