Locations

Retrieve business locations. Location affects product pricing, availability, and fulfillment options.

All catalogue queries are location-aware. Set the location via the location_id query parameter, or use the SDK's setLocationId() method.

GET/api/v1/business/info

Get Business Info

Returns basic business details including name, currency, and default location.

Example Request

curl

curl https://storefront.cimplify.io/api/v1/business/info \
  -H "X-API-Key: pk_test_your_api_key"

GET/api/v1/business/locations

List Locations

Example Request

curl

curl https://storefront.cimplify.io/api/v1/business/locations \
  -H "X-API-Key: pk_test_your_api_key"

Example Response

JSON

{
  "success": true,
  "data": [
    {
      "id": "loc_main",
      "name": "Main Store",
      "address": {
        "line1": "123 Main Street",
        "city": "Accra",
        "state": "Greater Accra",
        "postal_code": "00233",
        "country": "GH"
      },
      "phone": "+233201234567",
      "timezone": "Africa/Accra",
      "operating_hours": {
        "monday": { "open": "08:00", "close": "20:00" },
        "tuesday": { "open": "08:00", "close": "20:00" },
        "wednesday": { "open": "08:00", "close": "20:00" },
        "thursday": { "open": "08:00", "close": "20:00" },
        "friday": { "open": "08:00", "close": "21:00" },
        "saturday": { "open": "09:00", "close": "21:00" },
        "sunday": { "open": "10:00", "close": "18:00" }
      },
      "is_active": true
    }
  ]
}

Location Object

Field	Type	Description
`id`	string	Unique location identifier
`name`	string	Location name
`address`	object	Address with line1, city, state, postal_code, country
`phone`	string	Contact phone
`timezone`	string	IANA timezone
`operating_hours`	object	Weekly hours keyed by day name
`is_active`	boolean	Whether location is active