Get Locations

The Get Locations API retrieves all available locations configured in the Multi Location Products plugin.
This endpoint is useful for external systems (WMS, POS, ERP) to map location IDs and slugs before syncing inventory or pricing.


Endpoint

GET

/mulopimfwc/v1/locations

Headers

KeyValue
X-API-Keyyour-api-key-here

🔐 The X-API-Key is required for authentication. Requests without a valid API key will be rejected. Please set up the API first by following the documentation.


Request Parameters

None


Success Response

HTTP 200 OK

{
  "success": true,
  "count": 3,
  "data": [
    {
      "id": 5,
      "slug": "main-store",
      "name": "Main Store",
      "description": "Our primary retail location"
    },
    {
      "id": 6,
      "slug": "warehouse",
      "name": "Warehouse",
      "description": "Distribution center"
    }
  ]
}

Response Fields

FieldDescription
successIndicates whether the request was successful
countTotal number of locations returned
dataArray of location objects
idUnique location ID
slugURL-friendly unique location identifier
nameLocation name
descriptionLocation description (optional)

Error Responses

HTTP CodeReason
401Invalid or missing API key
403Insufficient permissions
500Internal server error

Usage Notes

  • Use this endpoint to retrieve location IDs and slugs before inventory synchronization.
  • Location IDs are recommended for faster processing in bulk operations.
  • Supports unlimited locations.
  • Cached internally for optimal performance.