Introduction

Prerequisites

Before you start using the Fynd Platform GraphQL API, ensure you have:

• A Fynd Platform account with the necessary API access permissions.
• Application/Sales channel on Fynd Platform
• An application_id and token to authenticate your requests.

Accessing the API

The Fynd Platform Application GraphQL API is accessible at the following endpoint:

1https://api.fynd.com/service/application/graphql

The GraphQL Explorer is a powerful, interactive tool that allows developers and users to explore, test, and query a GraphQL API with ease. It provides a user-friendly interface to interact with the GraphQL schema, construct queries and mutations, and view real-time results. This documentation will guide you through the main features and usage of the GraphQL Explorer.

Key Features

1. Interactive Query Building: Easily construct GraphQL queries and mutations using the intuitive point-and-click interface.
2. Schema Exploration: Browse the complete GraphQL schema, including types, fields, and documentation, directly within the explorer.
3. Real-Time Results Execute queries and mutations and view the results instantly within the explorer.
4. Autocomplete: Benefit from intelligent autocompletion while writing queries and mutations, reducing errors and speeding up development.
5. History: Access and reuse previous queries and mutations using the built-in history feature.

How to Use the GraphQL Explorer

1. Accessing the Explorer:
   1. Open the GraphQL Explorer using the following link:
2. Exploring the Schema:
   1. Browse through the available types, queries, mutations, and subscriptions.
   2. Click on any type or field to view detailed documentation.
3. Constructing Queries:
   1. In the main editor window, start typing your query or mutation.
   2. Use the autocomplete feature to help build your query faster.
   3. Alternatively, use the point-and-click interface to construct queries by selecting fields from the schema explorer.
4. Executing Queries:
   1. Once your query or mutation is ready, click the "Run" button (usually represented by a play icon) to execute it.
   2. View the results in the results pane below the editor.
5. Using Variables:
   1. Define variables in the "Query Variables" pane below the main editor.
   2. Reference these variables in your query or mutation to make your requests more dynamic.
6. Reviewing History:
   1. Access the history of your queries and mutations by clicking the "History" button.
   2. Reuse or modify previous requests as needed.

Example Query

Here is an example of a simple GraphQL query to fetch a list of products:

1query Products {
2    products {
3        items {
4            color
5            item_code
6            item_type
7            has_variant
8            uid
9            attributes
10            country_of_origin
11            department
12            description
13            name
14            rating
15            rating_count
16            slug
17            tags
18            type            
19        }
20    }
21}

To run this query:

1. Copy the query and paste it into the main editor window.
2. Add application_id and token. (cookie is needed in cases where user information is associated)
3. Click the "Run" button to execute the query.
4. View the list of products in the results pane.

Making Your First Query

Here's an example of a simple GraphQL query to fetch products using curl:

1curl --request POST \
2    --header 'content-type: application/json' \
3    --header 'Authorization: Bearer <base64 encoded application_id:token>' \
4    --url 'https://api.fynd.com/service/application/graphql' \
5    --data '{"query": "query Products { products { items { 
6    color item_code item_type has_variant uid attributes country_of_origin 
7    department description name rating rating_count slug tags type } } }"}'

Happy querying!