Skip to main content

Fluent Commerce Component

Manage orders within Fluent Commerce

Component key: fluent-commerce

Description#

Fluent Commerce is an order management system that allows you to track customers, orders and inventory.

Fluent Commerce offers a GraphQL-based API. This gives you flexibility and control over what data you send to Fluent, and what data you request back.

While this component offers some actions that wrap common GraphQL queries and mutations, there are many more queries and mutations for which there aren't dedicated actions. If you'd like to run a query or mutation that is not represented by an action, please use the Generic Request action.

Fluent Commerce Connections#

Fluent Commerce OAuth 2.0 Password Grant#

InputNotesExample
Input
OAuth 2.0 Client ID
string
/ Required
Notes
A client ID obtained from Fluent support
Example
 
Input
OAuth 2.0 Client Secret
password
/ Required
Notes
A client secret obtained from Fluent support
Example
 
Input
Fluent Host
string
/ Required
Notes
The retailer's Fluent API endpoint
Example
https://REPLACE-ME.api.fluentretail.com
Input
Retailer Password
password
/ Required
Notes
The retailer's password
Example
 
Input
Retailer Username
string
/ Required
Notes
The retailer's username
Example
john_doe

Actions#

Create Customer#

Create a new customer | key: createCustomer

InputDefaultNotesExample
Input
Attributes
string
Key Value List
Default
Notes
Custom attributes you would like to apply to the customer
Example
 
Input
Connection
connection
/ Required
Default
 
Notes
An OAuth 2.0 password grant type connection
Example
 
Input
Country
string
Default
Notes
The customer's country
Example
Australia
Input
Customer Email
string
/ Required
Default
Notes
The email address of the customer
Example
test@example.com
Input
First Name
string
/ Required
Default
Notes
The first name of the customer (required)
Example
John
Input
Last Name
string
Default
Notes
The last name of the customer
Example
Doe
Input
Phone Number
string
Default
Notes
The customer's phone number
Example
Doe
Input
Promotion Opt In
boolean
/ Required
Default
false
Notes
 
Example
 
Input
Retailer ID
string
/ Required
Default
Notes
The ID of the retailer (a number)
Example
34
Input
Time Zone
string
Default
Notes
The customer's time zone
Example
UTC+5

Create Product#

Create a new standard product | key: createProduct

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
An OAuth 2.0 password grant type connection
Example
 
Input
Global Trade Item Number (GTIN)
string
/ Required
Default
Notes
The global trade number of the product
Example
012345678905
Input
Price Currency
string
/ Required
Default
Notes
Type of currency the price is in (USD, YEN, GBP, etc)
Example
USD
Input
Price Value
string
/ Required
Default
Notes
The price of the product (must be a floating-point number)
Example
1300
Input
Product Catalogue Ref (ID)
string
/ Required
Default
Notes
The reference ID (ref) of an existing product catalog
Example
FCRG:PC:MASTER
Input
Product Name
string
/ Required
Default
Notes
The name of the product (not required to be unique)
Example
Widget
Input
Product Ref ID
string
/ Required
Default
Notes
The reference ID (ref) of the new product (must be unique)
Example
TESTPRD
Input
Product Summary / Description
string
/ Required
Default
Notes
 
Example
Widgets: the new whatsits
Input
Product Type
string
/ Required
Default
STANDARD
Notes
The type of the product
Example
STANDARD

Output Example Payload#

{  "data": {    "createStandardProduct": {      "id": "03440122-ea39-499b-83aa-f08b2614daf3",      "ref": "TESTPRD3"    }  }}

Generic GraphQL Request#

Issue any GraphQL query or mutation with variables | key: genericRequest

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
An OAuth 2.0 password grant type connection
Input
Query or Mutation
code
/ Required
Default
{  me {    id    username    primaryEmail  }}
Notes
 
Input
Variables
string
Key Value List
Default
Notes
 

Get Current User#

Get information about the currently authenticated user | key: getCurrentUser

InputNotes
Input
Connection
connection
/ Required
Notes
An OAuth 2.0 password grant type connection

Get Customer by Email#

Find a customer by their email address | key: getCustomerByEmailAddress

InputNotes
Input
Connection
connection
/ Required
Notes
An OAuth 2.0 password grant type connection
Input
Customer Email Address
string
/ Required
Notes
The customer's email address