This article will cover the following Product Catalog topics:
File Format
Product Catalog files are to be assembled and uploaded as a single JSONL file using the following schemas:
{ "category_id": "string", "category_name": "string", "is_excluded": boolean }
{ "product_id": "string", "product_name": "string", "categories": list<string> }
NOTE: The category schema must be listed first.
Below is an example of a Product Catalog containing 5 categories and 10 products.
{"category_id":"2000","category_name":"Produce","is_excluded":false}
{"category_id":"2150","category_name":"Fruit","is_excluded":false}
{"category_id":"2200","category_name":"Bakery","is_excluded":false}
{"category_id":"3000","category_name":"Beverages","is_excluded":false}
{"category_id":"4000","category_name":"Deli","is_excluded":true}
{"product_id":"000000031","product_name":"ROMA TOMATO","categories":["2000"]}
{"product_id":"000000128","product_name":"KALE","categories":["2000"]}
{"product_id":"000000347","product_name":"FUJI APPLE","categories":["2000","2150"]}
{"product_id":"000000316","product_name":"ORGANIC PEACH","categories":["2000","2150"]}
{"product_id":"000000512","product_name":"BLUEBERRY MUFFIN","categories":["2200"]}
{"product_id":"000000509","product_name":"CROISSANT","categories":["2200"]}
{"product_id":"000001044","product_name":"VANILLA LATTE","categories":["3000"]}
{"product_id":"000001050","product_name":"MOCHA","categories":["3000"]}
{"product_id":"000002505","product_name":"REUBEN","categories":["4000"]}
{"product_id":"000002722","product_name":"POTATO SALAD","categories":["4000"]}
NOTE: Products can be mapped to multiple categories.
Upload Process
To upload a product catalog file, navigate to Your Organization > Integrations > Product Catalog:
| 1. Click the Upload New Catalog button | |
|
1. This will be the button location when no previous catalogs have been uploaded. |
|
|
2. This will be the button location if a previous catalog file exists. |
|
 |
2. Use Select File to browse your local folders or drag and drop the desired file into the modal. NOTE: Files must be in the approved JSONL format and have a filename unique to any existing catalog files.
3. Once you have selected your catalog, click Upload File. |
|
4. If there is an active catalog, you will be asked to confirm your action. To proceed, click Upload Catalog. NOTE: A new file will replace the existing catalog. |
 |
|
|
|
|
5. Your new catalog will appear in the Pending state, shown above as New_Catalog.jsonl. It will remain in the Pending state while Formation validates its contents. Once complete, it will either be set as the active catalog, or you will be prompted to view a report detailing corrections or approvals needed to move forward. |
|
|
Read more on Catalog States or Warnings and Errors |
|
