How to retrieve product data using Flowbox's API

This guide will show you how to retrieve product data from Flowbox’s API

API Endpoint

To retrieve product data from Flowbox, use the following 'GET' request:

https://external-api.getflowbox.com/v2/products/{productKeys}

Purpose

This endpoint is used to return a data object containing product information. The 'productKeys' parameter is required and specifies which products to retrieve. You can provide one or more 'productKeys', separated by commas, to retrieve multiple products in a single request.

Required Parameters

api-key (header - string): This is your API authentication key, it must be included in the request header.

productKeys (path - string): The productKey of the products you wish to retrieve. You can provide one or more 'productKeys', separated by commas, to retrieve multiple products in a single request. The product keys can be obtained from the '/posts' endpoint. This a productKeys example:

"2553_712400_bEgYqAhMMhmO3tzsSOkteg"

2553: Your company ID in Flowbox.

712400: The ID of the product.

bEgYqAhMMhmO3tzsSOkteg: ID of the catalog containing the product.

locale (query - string): Specifies the desired locale of the products to be returned with the posts. It must match the locale of one of your catalogs. It must be entered in lowercase, e.g.: 'en-gb'.

Example API Request

curl -X 'GET' \   
'https://external-api.getflowbox.com/v1/products/2553_712400_bEgYqAhMMhmO3tzsSOkteg%2C2553_10102952_bEgYqAhMMhmO3tzsSOkteg?locale=en-us' \   
-H 'accept: application/json' \   
-H 'api-key: d54a8b76fd2cbee376c5217f554e13d3'

In this example, the request would retrieve data for two products: '2553_712400_bEgYqAhMMhmO3tzsSOkteg' and '2553_10102952_bEgYqAhMMhmO3tzsSOkteg'.

Response

The API will return a data object containing a product array, with the details of each product as retrieved from your account's Catalog:

Product object

key - The productKey for this specific product.
product_id - The product identifier used to process the product in Flowbox.
rating - An object containing the product's rating data (stars). Returns an empty object {} if the Rating&Reviews feature is not enabled.

`details` object

id - The ID identifier for the product, as provided in your product feed.
mpn - The product's Manufacturer Part Number, as provided in your product feed. Returns null if not provided.
url - The URL to the product's page.
gtin - The product's Global Trade Item Number, as provided in your product feed. Returns null if not provided.
name - The display name of the product.
size - The size of the product (e.g. "M", "XL"). Returns null if not applicable or not set.
brand - The brand or manufacturer name. Returns null if not provided.
color - The color of the product. Returns null if not provided.
price - The base price of the product as a string, without currency symbol.
gender - The target gender for the product (e.g. "male", "female", "unisex"). Returns null if not specified.
img_url - A direct URL to the product's main image.
pattern - The pattern or print of the product (e.g. "striped", "floral"). Returns null if not applicable.
category - A Flowbox-specific field representing the product's category. It's value is equal to either product_type or google_product_category, so it's recommended to use those instead.
currency - The ISO 4217 currency code for the product's price (e.g. "eur", "usd"), as set up in the Flowbox Catalog.
material - The material composition of the product (e.g. "cotton"). Returns null if not provided.
age_group - The target age group (e.g. "adult", "kids"). Returns null if not specified.
sale_price - The discounted sale price as a string, if the product is on sale. Returns null if there is no active sale.
availability - The stock status of the product. Values are "in stock" and "out of stock".
product_type - The category path as defined in the merchant's own taxonomy, in breadcrumb-style format.
item_group_id - A numeric identifier that groups product variants (e.g. different colors or sizes) under the same parent product. Returns nullif not provided.
google_product_category - The Google-defined product category ID or path, used for Google Shopping feeds. Returns null if not provided.
sale_price_effective_date - The date range during which the sale_price is active in ISO 8601 interval format. Returns null if not provided.
price_tag - A pre-formatted string combining the price and currency code for display purposes (e.g. "45 eur").
sale_price_tag - A pre-formatted string combining the sale price and currency code. Returns an empty string "" if there is no active sale.

You can find more information and make test calls in our Swaggerhub page.