Fluent Commerce Logo
Docs
Essential knowledgeCore knowledge to understand Fluent Commerce

Author:

Movyn John

Changed on:

3 July 2024

Overview

A Product is a conceptual entity with a product description and multiple sets of attributes. A unique combination of the Product attributes defines a SKU which is an item for sale.

Key points

  • A product can have multiple SKUs associated with it and will have one or more categories associated.
  • The properties available in the Product entity which can be updated and retrieved through the APIs.
1. productId
Type: LongDescription: { "productId" : "345444" } The unique product identifier assigned by Fluent Commerce.
2. retailerId
Type: StringDescription: { "retailerId" : "197" } The retailer identifier assigned by Fluent Commerce.
3. productRef
Type: String
  • Description: { "productRef" : "ProductRef_1972" } The unique product reference provided by the retailer.
4. name
Type: StringDescription: { "name" : "MAV HUNTER DARK USED" } The Product name.
5. status
Type: StringDescription: { "status" : "ACTIVE" } Product status. Possible values are: - ACTIVE (Default) - INACTIVE - UNKNOWN
6. prices
Type: ArrayDescription: "prices": [ { "type" : "UNIT_PRICE", "value" : "24.95", "currency" : "AUD" }, { "type" : "ORIGINAL_PRICE", "value" : "24.95", "currency" : "AUD" } ] Array of pricing information
  • currencyΒ (string) - Possible values are 'AUD', 'NZD’.
  • typeΒ (string) - Price type. Possible values are:
    • CURRENT
    • ORIGINAL
    • ORIGINAL_PRICE
    • UNIT_PRICE'
  • valueΒ (double) - Associated price
7. references
Type: ArrayDescription: "references": [ { "type" : "EAN", "value" : "12313123123"}]Retailer references associated with the Product
  • typeΒ (string) - specific Product reference type. e.g BARCODE
  • valueΒ (string) - Reference value
8. attributes
Type: ArrayDescription: "attributes": [{ "name": "Accessories", "type": "string", "value": "earphones"}]
The array of attributes: Attributes are used to provide additional information about the Product.
  • nameΒ (String): Indicates specific Product attribute e.g. brand.
  • typeΒ (String/Integer): Data type of specific Product attribute. Possible values are:
    • STRING
    • INTEGER'
  • valueΒ (String): Value of Product attribute.
9. categories
Type: ArrayDescription: "categories": [ "234", "328"]An array of category ids associated with the Product.Β 
10. createdOn
Type: DateTimeDescription: { "createdOn": "2016-05-06T23:41:12.242Z" } Date/time when the Product was created.
11. updatedOn
Type: DateTimeDescription: { "updatedOn": "2016-06-23T07:58:58.000+0000" } Date/time when the Product was last updated.

What you can do with Product

Create a product
Create a Product in the Fluent Retail system.POST:Β /api/v4.1/productRequest and responseRequest parameters and sampleResponse Parameters and sample

View Product Details

Retrieve details of the Product.GET:Β /api/v4.1/product/{productId}Request and responseΒ Request parameters and sampleΒ Product request/api/v4.1/product/{productId}Β Example request/api/v4.1/product/345444Response Parameters and sample

Search Product

Retrieve a list of Products matching the search criteria.GET:Β /api/v4.1/product-Request and responseRequest parameters and sampleResponse Parameters and sample

View Associated SKUs

Retrieve details of all SKUs associated to the Product.GET:Β /api/v4.1/product/{productId}/skuRequest and responseRequest parameters and sampleResponse Parameters and sample


Update Product Details

Edit the Product informationPUT:Β /api/v4.1/product/{productId}Request and responseRequest parameters and sampleResponse Parameters and sample

Response on Failures

NAMETYPEDESCRIPTION
errorArrayArray of errors
message
Code
String
String
Additional information on the code Unauthorised | Bad Request | Forbidden | Not Found | Status 500 Error
Status Code for the above messages 401 | 400 | 403 | 404 | 500