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 GraphQL Request action.
Connections
Fluent Commerce OAuth 2.0 Password Grant
Fluent uses OAuth 2.0 password grant type for authentication. To authenticate with Fluent, you will need a Client ID and Client Secret from Fluent, and your end users will need to enter their username and password.
Input | Notes | Example |
---|---|---|
OAuth 2.0 Client ID string / Required clientId | A client ID obtained from Fluent support | |
OAuth 2.0 Client Secret password / Required clientSecret | A client secret obtained from Fluent support | |
Fluent Host string / Required host | The retailer's Fluent API endpoint | https://REPLACE-ME.api.fluentretail.com |
Retailer Password password / Required password | The retailer's password | |
Retailer Username string / Required username | The retailer's username | john_doe |
Actions
Create Customer
Create a new customer | key: createCustomer
Input | Default | Notes | Example |
---|---|---|---|
Attributes string Key Value List attributes | Custom attributes you would like to apply to the customer | ||
Connection connection / Required connection | An OAuth 2.0 password grant type connection | ||
Country string country | The customer's country | Australia | |
Customer Email string / Required customerEmail | The email address of the customer | test@example.com | |
First Name string / Required firstName | The first name of the customer (required) | John | |
Last Name string lastName | The last name of the customer | Doe | |
Phone Number string phoneNumber | The customer's phone number | Doe | |
Promotion Opt In boolean / Required promotionOptIn | false | ||
Retailer ID string / Required retailerId | The ID of the retailer (a number) | 34 | |
Time Zone string timezone | The customer's time zone | UTC+5 |
Create Product
Create a new standard product | key: createProduct
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | An OAuth 2.0 password grant type connection | ||
Global Trade Item Number (GTIN) string / Required gtin | The global trade number of the product | 012345678905 | |
Price Currency string / Required priceCurrency | Type of currency the price is in (USD, YEN, GBP, etc) | USD | |
Price Value string / Required priceValue | The price of the product (must be a floating-point number) | 1300 | |
Product Catalogue Ref (ID) string / Required productCatalogueRef | The reference ID (ref) of an existing product catalog | FCRG:PC:MASTER | |
Product Name string / Required productName | The name of the product (not required to be unique) | Widget | |
Product Ref ID string / Required productRef | The reference ID (ref) of the new product (must be unique) | TESTPRD | |
Product Summary / Description string / Required productSummary | Widgets: the new whatsits | ||
Product Type string / Required productType | STANDARD | The type of the product | STANDARD |
Example Payload for Create Product
{
"data": {
"createStandardProduct": {
"id": "03440122-ea39-499b-83aa-f08b2614daf3",
"ref": "TESTPRD3"
}
}
}
Generic GraphQL Request
Issue any GraphQL query or mutation with variables | key: genericRequest
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | An OAuth 2.0 password grant type connection | |
Query or Mutation code / Required query | ||
Variables string Key Value List variables | ||
Variables Object code variablesObject |
Get Current User
Get information about the currently authenticated user | key: getCurrentUser
Input | Notes |
---|---|
Connection connection / Required connection | An OAuth 2.0 password grant type connection |
Get Customer by Email
Find a customer by their email address | key: getCustomerByEmailAddress
Input | Notes |
---|---|
Connection connection / Required connection | An OAuth 2.0 password grant type connection |
Customer Email Address string / Required emailAddress | The customer's email address |