The Export Inventory JSON API allows you to retrieve location-based inventory data in JSON format.
This format is ideal for system-to-system integrations, dashboards, mobile apps, and external inventory services.
Endpoint
GET
/mulopimfwc/v1/inventory/export
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | Yes | Export format. Use json |
| location_id | integer | Optional | Export inventory for a specific location |
| location_slug | string | Optional | Export inventory using location slug |
ℹ️ If no location parameter is supplied, inventory data for all locations will be returned.
Example Request
/mulopimfwc/v1/inventory/export?format=json
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.
Success Response
HTTP 200 OK
{
"success": true,
"count": 150,
"data": [
{
"product_id": 123,
"sku": "PROD-001",
"product_name": "Sample Product",
"location_id": 5,
"location_slug": "main-store",
"location_name": "Main Store",
"stock": 100,
"regular_price": "29.99",
"sale_price": "24.99",
"backorders": "no",
"disabled": false
}
]
}
Response Fields
| Field | Description |
|---|---|
| success | Indicates whether the request was successful |
| count | Total number of inventory records returned |
| data | Array of location-based inventory objects |
Inventory Object Fields
| Field | Description |
|---|---|
| product_id | WooCommerce product ID |
| sku | Product SKU |
| product_name | Product title |
| location_id | Location ID |
| location_slug | Location slug |
| location_name | Location display name |
| stock | Available stock quantity |
| regular_price | Location-specific regular price |
| sale_price | Location-specific sale price |
| backorders | Backorder status (no, notify, yes) |
| disabled | Whether the product is disabled for this location |
Behavior Notes
- Location-specific inventory overrides global WooCommerce values.
- Disabled products are included with
disabled: true. - Large datasets may require pagination at the integration layer.
- API key permissions determine accessible products and locations.
Authentication & Security
- API key is required via the
X-API-Keyheader. - Requests without a valid API key will be rejected.