API Endpoint
To retrieve product data from Flowbox, use the following 'GET' request:
https://external-api.getflowbox.com/v1/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 product the product details found in the catalog, such as:
- Product name
- Description
- Price
- Images
...
You can find more information and make test calls in our Swaggerhub page.