Fluent Commerce Logo
Docs
Essential knowledgeCore knowledge to understand Fluent Commerce

Intended Audience:

Technical User

Author:

Fluent Commerce

Changed on:

27 Feb 2025

Overview

A Retailer Batch is used to create new Retailers within a Fluent Account. This can be used when a new retail operation is being onboarded to an existing Fluent Account or during the initial setup of the Fluent Account to create the required Retailers.

Key points

  • Create new Retailers using the Job API
  • Sample Retailer batch payload
  • Retailer batch details

Retailer Creation

In order to create new Retailers in an account, you can submit a Retailer batch using the `/job/{jobId}/batch` endpoint (see link). Multiple Retailers can be created in a single batch by providing multiple `entities`.

Retailer Batch Model

The following describes the fields which can be submitted as part of a retailer batch record. 
KeyTypeMandatory?Possible ValuesConstraintsDescription
retailerIdString✅

This is the reference Id for the retailer you are creating.
This field value will be used to generate the retailer user (post-fixed with `_admin`)
retailerNameString✅
Character length must not exceed 45This is a name used to identify the retailer
regionString❌
Character length must not exceed 255The region where the retailer operates
tradingNameString❌
Character length must not exceed 255Trading name of the retailer (can be the same as retailerName)
customerSupportPhoneString❌
Character length must not exceed 255A phone number for customer support
customerSupportEmailString❌
Character length must not exceed 255An email for customer support
websiteString❌
Character length must not exceed 255The website of the retailer


Example Request Payload

Retailer Batch Details

Once a Retailer batch has been processed the details can be retrieved via the `/job/{jobId}/batch/{batchId}` (see link). The response will contain information such as the retailer id, username and password for the Retailer(s) that have been created.

Example Response Payload