The Export Inventory CSV API allows you to download location-based inventory data in CSV format.
This is useful for reporting, backups, audits, or syncing inventory data with external systems such as ERP, WMS, or accounting tools.
Endpoint
GET
/mulopimfwc/v1/inventory/export
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | Yes | Export format. Currently supports csv |
| location_id | integer | Optional | Export inventory for a specific location |
| location_slug | string | Optional | Export inventory using location slug |
ℹ️ If no location parameter is provided, inventory for all locations will be exported.
Example Request
/mulopimfwc/v1/inventory/export?format=csv&location_id=5
Headers
| Key | Value |
|---|---|
| X-API-Key | your-api-key-here |
🔐 The
X-API-Keyis required for authentication. Requests without a valid API key will be rejected. Please set up the API first by following the documentation.
Response
- Returns a CSV file download
- Content-Type:
text/csv - File is automatically downloaded by the browser or API client
CSV Columns
The exported CSV file contains the following headers:
| Column Name | Description |
|---|---|
| product_id | WooCommerce Product ID |
| sku | Product SKU |
| product_name | Product title |
| location_id | Location ID |
| location_slug | Location slug |
| location_name | Location name |
| stock | Available stock quantity |
| regular_price | Regular price for the location |
| sale_price | Sale price for the location |
| backorders | Backorder status (no, notify, yes) |
| disabled | Location-based product availability (true / false) |
Behavior Notes
- Only inventory accessible to the provided API key will be exported.
- Location-based prices and stock are exported independently of global WooCommerce values.
- Disabled products are included and marked accordingly in the
disabledcolumn. - Large inventories may take a few seconds to generate the CSV file.
Authentication & Security
- API authentication is mandatory via the
X-API-Keyheader. - Unauthorized requests will return an authentication error instead of a CSV file.
Use Cases
- Backup location-based inventory data
- Import inventory into ERP or accounting systems
- Generate stock reports per location
- Migrate inventory data between environments
Notes
{
"note": "Returns CSV file download with headers: product_id, sku, product_name, location_id, location_slug, location_name, stock, regular_price, sale_price, backorders, disabled"
}