GuidesAPI ReferenceAPI Terms of Use
Log In
Guides
Start typing to search…

Retrieving office information

Opportunity

Managing location data effectively is essential for smooth operations, regulatory compliance, and delivering a consistent customer experience. Whether you operate a single store or multiple offices, having quick access to accurate details - from high-level location lists to full office profiles and precise geographic data - allows you to keep records up to date, verify licensing, display correct business hours, and ensure deliveries are routed from the right place.

The endpoints described in this guide work together to give you a complete picture of your locations: retrieving all offices in your account, getting detailed information for a specific office, and identifying exact address components for any location. This information forms the foundation for store locators, compliance reporting, delivery logistics, and internal management tools.

Ask ChatGPT

Flow

Get Office by ID

To get information about a specific office, you need to use the Get office by ID endpoint:
https://api.indicaonline.com/open_api/v2.3/offices/id

This endpoint is particularly useful for quickly pulling complete, up-to-date details about a specific location - from licensing and operating hours to contact information - so you can display accurate store profiles, verify compliance, and tailor your app or workflows to that office’s capabilities.

Specify the required Body Parameters:

  • id : The ID of the office to retrieve data about. This may be manually verified on IndicaOnline Web directly in the link for the office:

And send the request. As a result, IndicaOnline Open API should return a 200 code response with the following response body:

{
  "id": 15606,
  "name": "GreenLeaf Downtown",
  "type": 1,
  "selling_type": "In Store",
  "is_medical": true,
  "is_recreational": false,
  "medical_state_license_number": "CA-MED-123456",
  "adult_use_state_license_number": "",
  "business_name": "GreenLeaf Collective",
  "business_slogan": "Your Health, Our Priority",
  "address": "123 Main Street, Los Angeles, CA 90012",
  "location": "Los Angeles",
  "location_id": 789,
  "email": "[email protected]",
  "phone": "(555) 123-4567",
  "website": "https://greenleaf.com",
  "timezone": "America/Los_Angeles",
  "business_hours": [
    { "day": "Monday", "open_time": "09:00", "close_time": "21:00", "is_active": true }
  ],
  "facebook": "facebook.com/greenleaf",
  "instagram": "instagram.com/greenleaf",
  "twitter": "twitter.com/greenleaf",
  "business_information": ["Serving patients since 2010"],
  "languages": ["English", "Spanish"],
  "description": "GreenLeaf Downtown offers premium medical cannabis products in a friendly, knowledgeable environment.",
  "is_active": "true"
}

This response constains the following information:

  • Office type and selling type (type, selling_type, is_medical, is_recreational)
  • Licensing information (medical_state_license_number, adult_use_state_license_number)
  • Contact details (address, phone, email, website, social media links)
  • Business hours with open/close times and timezone
  • Additional business information such as slogan, description, and supported languages

In case of requesting an invalid office ID, the API will return 400 error.
In case the office was not able to be found, the API will return 404 error

Get Offices

Use this endpoint to retrieve the information about all your offices:
GET /open_api/v2.3/inventory/products/offices

This endpoint is particularly useful for quickly retrieving a complete list of all your business locations along with their key details - perfect for powering store locators, managing multi-location operations, and ensuring customers always see the correct contact, licensing, and operating information.

You may specify the following optional parameters:

  • limit : Maximum number of records to return. Must be less or equal to 500.
  • offest : Maximum number of records to skip.

And send the request. As a result, IndicaOnline Open API should return a 200 code response with the following response body:

{
  "offices": [
    {
      "id": 15606,
      "name": "GreenLeaf Downtown",
      "type": 1,
      "selling_type": "In Store",
      "is_medical": true,
      "is_recreational": false,
      "medical_state_license_number": "CA-MED-123456",
      "adult_use_state_license_number": "",
      "business_name": "GreenLeaf Collective",
      "address": "123 Main Street, Los Angeles, CA 90012",
      "phone": "(555) 123-4567",
      "timezone": "America/Los_Angeles",
      "business_hours": [
        { "day": "Monday", "open_time": "09:00", "close_time": "21:00", "is_active": true }
      ],
      "languages": ["English", "Spanish"],
      "description": "GreenLeaf Downtown offers premium medical cannabis products in a friendly, knowledgeable environment.",
      "is_active": "true"
    },
    {
      "id": 67890,
      "name": "GreenLeaf Express",
      "type": 2,
      "selling_type": "On-Demand",
      "is_medical": false,
      "is_recreational": true,
      "medical_state_license_number": "",
      "adult_use_state_license_number": "CA-REC-987654",
      "business_name": "GreenLeaf Express Delivery",
      "address": "456 Market Street, Los Angeles, CA 90013",
      "phone": "(555) 987-6543",
      "timezone": "America/Los_Angeles",
      "business_hours": [
        { "day": "Monday", "open_time": "10:00", "close_time": "20:00", "is_active": true }
      ],
      "languages": ["English"],
      "description": "GreenLeaf Express delivers adult-use cannabis products quickly and discreetly.",
      "is_active": "true"
    }
  ],
  "count": 2,
  "total": 5
}

This response will contain the following information:

  • Office IDs and names
  • Sales type and selling type (storefront, delivery only, on-demand, in-store)
  • Licensing information (medical_state_license_number, adult_use_state_license_number)
  • Address and contact details
  • Business hours with open/close times and timezone
  • Additional information such as slogan, description, supported languages, and social media links
  • count (number of offices returned in this request) and total (total offices in your account)

Get Location by ID

To get details for a specific location, use the Get location by ID endpoint:
https://api.indicaonline.com/open_api/v2.3/locations/id

This endpoint is particularly useful for validating and standardizing location data, ensuring delivery areas are correctly mapped, and confirming administrative details for compliance and reporting.

Specify the required Body Parameters:

  • id : The ID of the office to retrieve data about. Just as with the Get Office by ID endpoint, this may be manually verified on IndicaOnline Web directly in the link for the office:

And send the request. As a result, IndicaOnline Open API should return a 200 code response with the following response body:

{
  "id": 15606,
  "name": "Los Angeles",
  "country": "United States",
  "state": "California",
  "county": "Los Angeles County",
  "city": "Los Angeles",
  "zip": "90012"
}

Updated 7 months ago