> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Inventory location by Company and location code

> ## Get Location by Company Code and Location Code

### Summary

Retrieves a CI Location using **Company Code** and **Location Code**.

Returns the location details if the record exists and the user is authorized.

---

### HTTP Method & Endpoint

**Method:** GET

**Endpoint:**  
/ci-rest-api/jersey/v1/inventory-location/get-by-code

---

### Query Parameters

| Field | Type | Required | Example Value | Description |
| --- | --- | --- | --- | --- |
| companyCode | String | Yes | RV1 | Company code |
| locationCode | String | Yes | MAIN | Location code |

---

### Example Request

GET /ci-rest-api/jersey/v1/inventory-location/get-by-code?companyCode=RV1&locationCode=MAIN

---

### Notes

- Both **companyCode** and **locationCode** parameters are mandatory.
    
- Authentication and authorization are required.
    

---

## Attributes

The request body must contain an **items** array.

Each object in the array represents one inventory location to be created.

All attributes are listed below for completeness.

Only attributes marked as **Mandatory = True** are required during creation.

| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Mandatory |
| --- | --- | --- | --- | --- | --- | --- | --- |
| CilocCompCode | cilocation | cilocCompCode | Company code for the inventory location | String | 8 | CL02 | True |
| CilocCode | cilocation | cilocCode | Unique inventory location code | String | 7 | DRLC01 | True |
| CilocName | cilocation | cilocName | Name or description of the inventory location | String | 60 | Main Warehouse - Bin 01 | True |
| CilocDeptCode | cilocation | cilocDeptCode | Department code associated with the location | String | 6 | 00 | True |
| CilocTypeCode | cilocation | cilocTypeCode | Inventory location type (W = Warehouse, B = Bin) | String | 1 | W | True |
| CilocCtrlCode | cilocation | cilocCtrlCode | Control code for bin locations (required only when type is B) | String | 7 | BIN01 | Conditional |
| CilocBinCtrlFlag | cilocation | cilocBinCtrlFlag | Indicates whether bin control is enabled (Y/N) | String | 1 | Y | False |
| CilocPctUsed | cilocation | cilocPctUsed | Percentage of storage capacity used | Number | 6,2 | 0.00 | False |
| CilocDeptDistFlag | cilocation | cilocDeptDistFlag | Department distribution flag (Y/N) | String | 1 | N | True |
| CilocHier | cilocation | cilocHier | Hierarchical structure of the inventory location | String | 255 | WH1/BIN1 | False |
| CilocInvSerCode | cilocation | cilocInvSerCode | Inventory serialization code | String | 4 | SER1 | False |
| CilocMszoneCode | cilocation | cilocMszoneCode | Material staging zone code | String | 10 | ZONE1 | False |
| CilocIuCreateDate | cilocation | cilocIuCreateDate | Date and time when the record is created | String | N/A | System generated | False |
| CilocIuCreateUser | cilocation | cilocIuCreateUser | User who created the inventory location | String | 30 | System user | False |
| CilocIuUpdateDate | cilocation | cilocIuUpdateDate | Date and time of last update | String | N/A | System generated | False |
| CilocIuUpdateUser | cilocation | cilocIuUpdateUser | User who last updated the record | String | 30 | System user | False |
| CilocVUuid | cilocation | cilocVUuid | Virtual unique identifier generated by the system | String | 64 | Generated | False |

## OpenAPI

````json GET /ci-rest-api/jersey/v1/inventory-location/get-by-code
{
  "openapi": "3.0.0",
  "info": {
    "title": "API Catalog",
    "description": "",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://mobtest.cmiccloudr12.com/cmictestrti",
      "description": "CMIC API Server"
    }
  ],
  "security": [
    {
      "cmicBasicAuth": []
    }
  ],
  "tags": [
    {
      "name": "Highlights"
    },
    {
      "name": "Asset Management | Equipment"
    },
    {
      "name": "Asset  Management | Fixed Assets"
    },
    {
      "name": "Asset Management | Purchase Order"
    },
    {
      "name": "Asset Management | Inventory"
    },
    {
      "name": "Asset Management | Requisition"
    },
    {
      "name": "Asset Management | Purchase Change Order"
    },
    {
      "name": "Bim Model"
    },
    {
      "name": "Bim Model Revision"
    },
    {
      "name": "Bim Tag Model"
    },
    {
      "name": "Bim Tags"
    },
    {
      "name": "Bim FileUpload Jersey"
    },
    {
      "name": "Core System | Business Partners"
    },
    {
      "name": "Core System | Business Partner Addresses"
    },
    {
      "name": "Core System | Bank"
    },
    {
      "name": "Core System | Currency"
    },
    {
      "name": "Core System | Exchange Rates"
    },
    {
      "name": "Core System | Global  Table Text Codes"
    },
    {
      "name": "Core System | Global Table  Regions"
    },
    {
      "name": "Core System | Terms"
    },
    {
      "name": "Core System | System Contact"
    },
    {
      "name": "Core System | Weight Measures"
    },
    {
      "name": "Core System | Field User Defined Classifiers"
    },
    {
      "name": "Core System | User Defined Classifiers by Object"
    },
    {
      "name": "Core System | User Extension Definitions by Object"
    },
    {
      "name": "Core System | User Extention Field Data Value"
    },
    {
      "name": "Core System | User Extension Values by Object"
    },
    {
      "name": "Core System | User System Role"
    },
    {
      "name": "Core System | User Project Role"
    },
    {
      "name": "Core System | Documents by Object"
    },
    {
      "name": "Core System | Audit Status Log by Object"
    },
    {
      "name": "Core System | Licensed Users"
    },
    {
      "name": "Core System | Company Access"
    },
    {
      "name": "Core System |  Copy User Settings"
    },
    {
      "name": "Core System | User Maintenance"
    },
    {
      "name": "Core System | User Roles"
    },
    {
      "name": "Core System | Security Groups"
    },
    {
      "name": "Core System | Job/Project Security"
    },
    {
      "name": "Core System | Weight Measure with Conversions Code"
    },
    {
      "name": "Core System | Weight Measure Conversions Code"
    },
    {
      "name": "Core System | User-defined-fields"
    },
    {
      "name": "Core System | User-extension"
    },
    {
      "name": "ECM and Workflow | Image Manager"
    },
    {
      "name": "Financials | General Ledger"
    },
    {
      "name": "Financials | Accounts Payable"
    },
    {
      "name": "Financials | Accounts Receivable"
    },
    {
      "name": "Preventative Maintenance | Issue Work Orders"
    },
    {
      "name": "Preventative Maintenance | Issue Work Items"
    },
    {
      "name": "Preventative Maintenance | Issue Work Budgets"
    },
    {
      "name": "Preventative Maintenance | Issue Priorities"
    },
    {
      "name": "Preventative Maintenance | Issue Status"
    },
    {
      "name": "Preventative Maintenance | Issue Types"
    },
    {
      "name": "Preventative Maintenance | Accumulative Equipment"
    },
    {
      "name": "Preventative Maintenance | Work Orders"
    },
    {
      "name": "Preventative Maintenance | Work Items"
    },
    {
      "name": "Preventative Maintenance | Work Budgets"
    },
    {
      "name": "Preventative Maintenance | Priorities"
    },
    {
      "name": "Preventative Maintenance | Tasks"
    },
    {
      "name": "HCM | UKG Pay Deductions"
    },
    {
      "name": "HCM | UKG Pay Earnings"
    },
    {
      "name": "HCM | UKG Pay Headers"
    },
    {
      "name": "HCM | UKG Pay Taxes"
    },
    {
      "name": "HCM | Payroll Geographical States"
    },
    {
      "name": "HCM | Payroll Trades"
    },
    {
      "name": "HCM | Payroll Union"
    },
    {
      "name": "HCM | Payroll Pay Runs"
    },
    {
      "name": "HCM | Payroll Pay Groups"
    },
    {
      "name": "HCM | Payroll Tax"
    },
    {
      "name": "HCM | Payroll Worker Compensation"
    },
    {
      "name": "HCM | Payroll Work Locations"
    },
    {
      "name": "HCM | Payroll Trade Pay Rates"
    },
    {
      "name": "HCM | Payroll Union Pay Rates"
    },
    {
      "name": "HCM | Payroll Job Pay Rates"
    },
    {
      "name": "HCM | Payroll Master Benefits"
    },
    {
      "name": "HCM | Payroll Master Deductions"
    },
    {
      "name": "HCM | Payroll Ben/Ded/Leave Base Codes"
    },
    {
      "name": "HCM | Payroll Ben/Ded Plans"
    },
    {
      "name": "HCM | Payroll Ben/Ded Plan Options"
    },
    {
      "name": "HCM | Payroll Company Benefits"
    },
    {
      "name": "HCM | Payroll Company Deductions"
    },
    {
      "name": "HCM | Payroll Vertex Geographic Locations"
    },
    {
      "name": "HCM | Payroll Checks"
    },
    {
      "name": "HCM | Payroll Timesheets"
    },
    {
      "name": "HCM | Employee"
    },
    {
      "name": "HCM | Employee (Minimum payload)"
    },
    {
      "name": "HCM | Employee History"
    },
    {
      "name": "HCM | Tax Exemptions"
    },
    {
      "name": "HCM | Employee Tax Overrides"
    },
    {
      "name": "HCM | Employee Pay Splits"
    },
    {
      "name": "HCM | Employee Benefits"
    },
    {
      "name": "HCM | Employee Clock In and Out"
    },
    {
      "name": "HCM | Employee Deductions"
    },
    {
      "name": "HCM | Employee Leaves"
    },
    {
      "name": "HCM | Employee Leave History"
    },
    {
      "name": "HCM | Employee Hour Types"
    },
    {
      "name": "HCM | Employee Pay History"
    },
    {
      "name": "HCM | Employee Work Statuses"
    },
    {
      "name": "HCM | Employee Security Group"
    },
    {
      "name": "HCM | Crewtime Crew"
    },
    {
      "name": "HCM | Crewtime Employee Timesheet"
    },
    {
      "name": "HCM | Crewtime Equipment Timesheet"
    },
    {
      "name": "HCM | Crew Maintenance Activity Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Member Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Member Trade and Union Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Equipment Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Equipment Detail Assignment"
    },
    {
      "name": "HCM | HR Requisitions"
    },
    {
      "name": "HCM | HR Relations"
    },
    {
      "name": "HCM | HR Employee Skills"
    },
    {
      "name": "HCM | HR Incident"
    },
    {
      "name": "HCM | HR Employee Relatives / Dependents"
    },
    {
      "name": "HCM | HR Employee Positions"
    },
    {
      "name": "HCM | HR Applicants"
    },
    {
      "name": "HCM | HR Applications"
    },
    {
      "name": "HCM | Vertex Location City"
    },
    {
      "name": "HCM | HR Application History"
    },
    {
      "name": "HCM | HR Dependent Benefits"
    },
    {
      "name": "HCM | HR Dependent Deductions"
    },
    {
      "name": "HCM | HR Employee Elected Plans"
    },
    {
      "name": "HCM | HR Employee Training Certifications"
    },
    {
      "name": "HCM | HR Trainings"
    },
    {
      "name": "HCM | E-Timesheets"
    },
    {
      "name": "HCM | System Contacts"
    },
    {
      "name": "HCM | System User Payroll Security Group"
    },
    {
      "name": "HCM | Payroll Timesheet Posting"
    },
    {
      "name": "HCM | CrewTimesheet Posting"
    },
    {
      "name": "HCM | HR Positions Master"
    },
    {
      "name": "HCM | Payroll Pay Periods"
    },
    {
      "name": "HCM | Payroll Rate Codes"
    },
    {
      "name": "HCM | Payroll Overhead Codes and Rates"
    },
    {
      "name": "HCM | Payroll Assigned Overhead to Jobs"
    },
    {
      "name": "Materials  Management | Material Sale Orders"
    },
    {
      "name": "Materials  Management | Material Sale Orders Details"
    },
    {
      "name": "Materials  Management | Truck Rate Detail"
    },
    {
      "name": "Opportunity Management | Competitors"
    },
    {
      "name": "Opportunity Management | Opportunities"
    },
    {
      "name": "Opportunity Management | Revenue Details"
    },
    {
      "name": "Opportunity Management | Opportunity History"
    },
    {
      "name": "Opportunity Management | Organization"
    },
    {
      "name": "Project Controls | Job Billing"
    },
    {
      "name": "Project Controls | Job Cost"
    },
    {
      "name": "Project Controls | PCI Details"
    },
    {
      "name": "Project Controls | Unposted PCI Details"
    },
    {
      "name": "Project Controls | PCI Headers"
    },
    {
      "name": "Project Controls | Owner Change Orders"
    },
    {
      "name": "Project Controls | CM Statuses"
    },
    {
      "name": "Project Controls | CM Types"
    },
    {
      "name": "Project Controls | CM Vendor Details"
    },
    {
      "name": "Project Controls | Post PCI"
    },
    {
      "name": "Project Management | Uploading Documents"
    },
    {
      "name": "Project Management | Downloading Documents"
    },
    {
      "name": "Project Management | Foreign Bid Item Imports"
    },
    {
      "name": "Project Management | Communications"
    },
    {
      "name": "Project Management | Daily Journals"
    },
    {
      "name": "Project Management | Communications Types"
    },
    {
      "name": "Project Management | Daily Journal Daily Work Plans"
    },
    {
      "name": "Project Management | Daily Journal Field Forces"
    },
    {
      "name": "Project Management | Daily Journal Labour"
    },
    {
      "name": "Project Management | Daily Journal Materials"
    },
    {
      "name": "Project Management | Daily Journal Owner Equipment"
    },
    {
      "name": "Project Management | Daily Journal Quality Control"
    },
    {
      "name": "Project Management | Daily Journal Tasks"
    },
    {
      "name": "Project Management | Daily Journal Trade Equipment"
    },
    {
      "name": "Project Management | Daily Journal Transactions"
    },
    {
      "name": "Project Management | Daily Journal User Defined Data"
    },
    {
      "name": "Project Management | Daily Journal Visitors"
    },
    {
      "name": "Project Management | Daily Journal Bill Details"
    },
    {
      "name": "Project Management | Field Work Directives"
    },
    {
      "name": "Project Management | Contract Types"
    },
    {
      "name": "Project Management | Company Contacts"
    },
    {
      "name": "Project Management | Distribution BCC"
    },
    {
      "name": "Project Management | Distribution CC"
    },
    {
      "name": "Project Management | Field Work Directive Statuses"
    },
    {
      "name": "Project Management | Issues"
    },
    {
      "name": "Project Management | Key Players"
    },
    {
      "name": "Project Management | Meetings"
    },
    {
      "name": "Project Management | Meeting Attendees"
    },
    {
      "name": "Project Management | Meeting Item Statuses"
    },
    {
      "name": "Project Management | Meeting Tracks"
    },
    {
      "name": "Project Management | Notes"
    },
    {
      "name": "Project Management | Projects"
    },
    {
      "name": "Project Management | Project Items"
    },
    {
      "name": "Project Management | Project Item Phase Segment Sums"
    },
    {
      "name": "Project Management | Project Partners"
    },
    {
      "name": "Project Management | Notices"
    },
    {
      "name": "Project Management | Notice Statuses"
    },
    {
      "name": "Project Management | Owner JS Query"
    },
    {
      "name": "Project Management | PCI Real Locations"
    },
    {
      "name": "Project Management | Project Contacts"
    },
    {
      "name": "Project Management | RFIs (Requests for Information)"
    },
    {
      "name": "Project Management | RFI Statuses"
    },
    {
      "name": "Project Management | Submittal Packages"
    },
    {
      "name": "Project Management | Submittal Package Details"
    },
    {
      "name": "Project Management | Submittal Package Status"
    },
    {
      "name": "Project Management | Submittals"
    },
    {
      "name": "Project Management | Submittal Status"
    },
    {
      "name": "Project Management | Transmittals"
    },
    {
      "name": "Project Management | Subcontract Headers"
    },
    {
      "name": "Project Management | Subcontract Schedules"
    },
    {
      "name": "Project Management | Subcontract Sechedule Phase Segment Sums"
    },
    {
      "name": "Project Management | User Roles"
    },
    {
      "name": "Project Management | Punchlists"
    },
    {
      "name": "Project Management | Punchlist Details"
    },
    {
      "name": "Project Management | Punchlist Statuses"
    },
    {
      "name": "Project Management | Meeting Items"
    },
    {
      "name": "Project Management | Self Perform Vendor"
    },
    {
      "name": "Project Management | Submittal Types"
    },
    {
      "name": "Project Management | Assign contact and partner to project"
    },
    {
      "name": "Project Management | Subcontract Prequal"
    },
    {
      "name": "Project Management | Bid Item Package"
    }
  ],
  "paths": {
    "/ci-rest-api/jersey/v1/inventory-location/get-by-code": {
      "get": {
        "tags": [
          "Asset Management | Inventory"
        ],
        "summary": "Retrieve Inventory location by Company and location code",
        "description": "## Get Location by Company Code and Location Code\n\n### Summary\n\nRetrieves a CI Location using **Company Code** and **Location Code**.\n\nReturns the location details if the record exists and the user is authorized.\n\n---\n\n### HTTP Method & Endpoint\n\n**Method:** GET\n\n**Endpoint:**  \n/ci-rest-api/jersey/v1/inventory-location/get-by-code\n\n---\n\n### Query Parameters\n\n| Field | Type | Required | Example Value | Description |\n| --- | --- | --- | --- | --- |\n| companyCode | String | Yes | RV1 | Company code |\n| locationCode | String | Yes | MAIN | Location code |\n\n---\n\n### Example Request\n\nGET /ci-rest-api/jersey/v1/inventory-location/get-by-code?companyCode=RV1&locationCode=MAIN\n\n---\n\n### Notes\n\n- Both **companyCode** and **locationCode** parameters are mandatory.\n    \n- Authentication and authorization are required.\n    \n\n---\n\n## Attributes\n\nThe request body must contain an **items** array.\n\nEach object in the array represents one inventory location to be created.\n\nAll attributes are listed below for completeness.\n\nOnly attributes marked as **Mandatory = True** are required during creation.\n\n| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Mandatory |\n| --- | --- | --- | --- | --- | --- | --- | --- |\n| CilocCompCode | cilocation | cilocCompCode | Company code for the inventory location | String | 8 | CL02 | True |\n| CilocCode | cilocation | cilocCode | Unique inventory location code | String | 7 | DRLC01 | True |\n| CilocName | cilocation | cilocName | Name or description of the inventory location | String | 60 | Main Warehouse - Bin 01 | True |\n| CilocDeptCode | cilocation | cilocDeptCode | Department code associated with the location | String | 6 | 00 | True |\n| CilocTypeCode | cilocation | cilocTypeCode | Inventory location type (W = Warehouse, B = Bin) | String | 1 | W | True |\n| CilocCtrlCode | cilocation | cilocCtrlCode | Control code for bin locations (required only when type is B) | String | 7 | BIN01 | Conditional |\n| CilocBinCtrlFlag | cilocation | cilocBinCtrlFlag | Indicates whether bin control is enabled (Y/N) | String | 1 | Y | False |\n| CilocPctUsed | cilocation | cilocPctUsed | Percentage of storage capacity used | Number | 6,2 | 0.00 | False |\n| CilocDeptDistFlag | cilocation | cilocDeptDistFlag | Department distribution flag (Y/N) | String | 1 | N | True |\n| CilocHier | cilocation | cilocHier | Hierarchical structure of the inventory location | String | 255 | WH1/BIN1 | False |\n| CilocInvSerCode | cilocation | cilocInvSerCode | Inventory serialization code | String | 4 | SER1 | False |\n| CilocMszoneCode | cilocation | cilocMszoneCode | Material staging zone code | String | 10 | ZONE1 | False |\n| CilocIuCreateDate | cilocation | cilocIuCreateDate | Date and time when the record is created | String | N/A | System generated | False |\n| CilocIuCreateUser | cilocation | cilocIuCreateUser | User who created the inventory location | String | 30 | System user | False |\n| CilocIuUpdateDate | cilocation | cilocIuUpdateDate | Date and time of last update | String | N/A | System generated | False |\n| CilocIuUpdateUser | cilocation | cilocIuUpdateUser | User who last updated the record | String | 30 | System user | False |\n| CilocVUuid | cilocation | cilocVUuid | Virtual unique identifier generated by the system | String | 64 | Generated | False |",
        "parameters": [
          {
            "name": "companyCode",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "RV1"
          },
          {
            "name": "locationCode",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "MAIN"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "example": "{\n    \"cilocCompCode\": \"RV1\",\n    \"cilocCode\": \"MAIN\",\n    \"cilocName\": \"MAIN\",\n    \"cilocDeptCode\": \"00\",\n    \"cilocTypeCode\": \"W\",\n    \"cilocCtrlCode\": null,\n    \"cilocBinCtrlFlag\": \"Y\",\n    \"cilocPctUsed\": null,\n    \"cilocDeptDistFlag\": \"N\",\n    \"cilocHier\": \"RV1      .MAIN    .\",\n    \"cilocInvSerCode\": null,\n    \"cilocMszoneCode\": null,\n    \"cilocIuCreateDate\": \"2011-01-04T13:41:31-05:00\",\n    \"cilocIuUpdateDate\": \"2023-05-24T15:54:46-04:00\",\n    \"cilocVUuid\": \"B710F10A4358F940E053508010ACC979\"\n}"
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "cmicBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic authentication"
      }
    }
  }
}
````