Get
/ci-rest-api/jersey/v1/inventory-location/get-by-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 |
Security
HTTP
Type basic
Basic authentication
Query parameters
companyCode
string
ExampleRV1
locationCode
string
ExampleMAIN
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
"{\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}"string