Exporting Inventory data in bulk
This document defines the requirements for a bulk inventory export capability to support initial data ingestion for the Search and Product Display platform. The goal is to allow downstream systems to programmatically request and receive a complete snapshot of inventory data in CSV format, enabling accurate indexing and display on PLP (Product Listing Page) and PDP (Product Detail Page).
Usage considerations
- The file header contents and column order must be identical to the sample template. No empty columns for spacing are permitted.
Restriction:
- English is the only supported language for inventory content.
- No deletion is possible.
- Each purchase order number must be unique and not already present in the system.
- Purpose and Scope
-
- The export generates a comprehensive snapshot of the entire inventory, capturing real-time data at the exact moment of request.
- The export is not store-scoped in the initial version and includes all inventory records across stores and fulfillment locations.
- This capability is intended for system-to-system use and supports large-scale data ingestion workflows.
- Export Mechanism
-
- The system provides a secure API endpoint that generates a point-in-time inventory snapshot upon invocation.
- To ensure reliable high-volume data transfer, the export is delivered as a CSV file; this architecture avoids the latency and timeout risks inherent in processing massive JSON payloads.
CSV Content and Structure
- The generated CSV file includes:
-
- A header row containing column names.
- One row per inventory record.
- Each record contain the following fields:
-
- Product ID
- Store ID
- Quantity
- Fulfillment Center ID
Sample template
A sample of the inventorybulkexport.csv is as follows.
Where:
| Product ID | Store ID | Quantity | Fulfillment Center ID |
|---|---|---|---|
| BD001 | Ruby | 10 | R00B2C |
- Product ID
- A unique identifier representing a sellable product or SKU in the product catalog.
- Store ID
- A unique identifier representing a retail store or sales channel where the inventory is associated.
- Quantity
- The available on-hand quantity of the product for the given store and fulfillment center at the time of export.
- Fulfillment Center ID
- A unique identifier for the fulfillment center or warehouse where the inventory is physically stored.