Fluent Commerce Logo
Docs
Help & Feedback

Working with GraphQL

How-to guides for working with GraphQL

Configuring Change Address

How-to Guide
  • User action capability is used to update the Delivery Info of an Order.

Configure Multi-Customer-Tier Sourcing Logic

How-to Guide
  • Use the Responsive Sourcing Framework to tailor sourcing by Customer tier, Order value, and campaign windows
  • Use the `createSourcingProfile` mutation to create new versions of Sourcing Profiles, which are immutable
  • Activate relevant Sourcing Profiles versions with the `activateSourcingProfile` mutation
  • Reference Sourcing Profiles within the corresponding Workflows

Configure Multi-Country Sourcing Logic

How-to Guide
  • Use the Responsive Sourcing Framework to implement sourcing logic that prioritize country-level constraints
  • Use the `createSourcingProfile` mutation to create new versions of Sourcing Profiles, which are immutable
  • Activate relevant Sourcing Profiles versions with the `activateSourcingProfile` mutation
  • Reference Sourcing Profiles within the corresponding Workflows

Configure Multi-Region Sourcing Logic

How-to Guide
  • Use the Responsive Sourcing Framework building blocks to manage your sourcing logic
  • Use the `createSourcingProfile` mutation to create new versions of Sourcing Profiles, which are immutable
  • Activate relevant Sourcing Profiles versions with the `activateSourcingProfile` mutation
  • Reference Sourcing Profiles within the corresponding Workflows

Enable location store users to update store hours

How-to Guide
  • Each location has an opening hours setup that can be used for store activities. One activity could be during the fulfillment allocation phase, where the fulfillment expiry time for a store is calculated, giving store staff sufficient time to process the order before it expires.
  • Since opening hours can change week by week, we have created this guide to showcase how you can enable Store Managers to make these changes directly in the Fluent Store Web App.

Create a new Inventory Feed via GraphQL API

How-to Guide
  • After following this guide a user will be able to create a new Inventory Feed
  • The output from this feed can be used to supply inventory availability data to any system
  • Additional steps will outline optional configuration that can be applied to Inventory Feeds

Setup and use the Postman GraphQL User Interface

How-to Guide
  • Postman has a special client for GraphQL requests called the GraphQL client. 
  • The GraphQL client has features that allow you to create and execute GraphQL requests more efficiently.
  • It automatically fetches the schema of a GraphQL API and uses introspection to show you the available data fields. 
  • You can explore the data fields of a GraphQL API and construct queries by selecting fields or entering code in an editor.

Module Recipe - Plugin Setup and Installation Guide

How-to Guide
  • Create the new module: `fluent module create -n <module-name> `
  • Populate the plugin structure in `plugins/`
      `rules/` - Contains rules, unit tests and GraphQL queries/mutations
      `types/` - Stores model classes and extended DTOs
      `util/` - Holds service classes and utilities
  • Build the module:  `./scripts/build-module.sh`
  • Install the module: `fluent module install dist/<module-name>-<version>.zip -p <profile> -r <retailer>`

Manage and view Inventory Feed Runs

How-to Guide
  • Inventory Feed runs can be individually tracked for their status and data about the run
  • A user will know how to analyse Inventory Feed Runs from this guide

GraphQL mutation removeUserRolesFromUser

How-to Guide
  • Quick Example of how to use GraphQL mutation `removeUserRolesFromUser`

Role Creation and Editing Mutations

How-to Guide
  • When creating or editing roles, ensure to define permissions accurately to maintain system security.
  • Follow the best practices for naming conventions and role descriptions for easier management and clarity.
  • Test role changes in a controlled environment before applying them to the live system to avoid unintended access issues.

Convert a JSON Introspection result to Schema Definition Language (SDL)

How-to Guide
  • Converting JSON Introspection to SDL allows for a human-readable format of GraphQL schema, which is essential for documentation and understanding the API structure.
  • Tools such as GraphQL Voyager and Apollo Studio can automate the conversion process, providing a visual representation and SDL output without manual coding.
  • Understanding the structure of the introspection query result is crucial for manually converting the JSON to SDL, should automated tools not be available or suitable.

Generate a Collection of the Fluent GraphQL API

How-to Guide
  • Prerequisites
  • Steps to Follow

Identify Inventory Failed Events

How-to Guide
  • Detect Inventory problems or anomalies with the Total Failures card on the Sources Dashboard.
  • Identify the specific failure events with advanced filtering on the Events page. 
  • Understand the what, where, and why of the event failure by using the Event Details Drawer.

Update an existing Inventory Feed via GraphQL API

How-to Guide
  • After following this guide a user will be able to update an existing Inventory Feed
  • Various updates are available once an Inventory Feed has been created and started running

Troubleshooting Inventory Feeds

How-to Guide
  • This section will detail a few common issues and troubleshooting options for Inventory Feeds.

User Editing Mutation

How-to Guide
  • A user can be edited directly on the Fluent OMS UI.
  • It’s only possible to ADD roles to the user on the UI. Removing roles is not feasible from the UI.

Setting Editing Mutation

How-to Guide
  • A setting can be modified directly on Fluent OMS UI.

Bulk Extracts with GraphQL

How-to Guide
  • A python script can be used for ad-hoc extracts of a large number of GQL entities into a CSV file. 
  • Currently the Fluent platform does not support any bulk extracts. 
  • This scripts helps to extract data in bulk using the pagination functionality provided by the schema.
  • Depending on the amount of data that is extracted the script might run for a while.
  • The above codes are provided as is and are for reference purposes. 
Building Blocks
Building Blocks
Packages & Modules
All UI Components
Workflows
Settings
Interface Contracts
All Rules
By Type
All Types
Knowledge Tracks
Extend Knowledge
Glossary
All How-to Guides
Sitemap
Topics
Use Cases
Helpful Resources
Platform Limits
Support Policy
Service Level Agreement (SLA) - Enterprise
Deprecation Policy
Extend Knowledge Content – Terms and Conditions
System and Organization Controls (SOC) 3 Report
Data Privacy Addendum
Security Policy
Quick Links
For Partners
Customer Resources
Webinars and Events
Certifications
Training Resources
Knowledge Tracks
Builders Portal
Product Update Newsletter
Industry Blogs & Events Newsletter
Trust Center Portal

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

Fluent Logo