Create-location

Prev Next
Post
/ci-rest-api/jersey/v1/inventory-location/create-location

Overview

This endpoint allows creating Single Inventory (CI) Location in a single request.


Notes

  • Authentication and authorization are required.

  • Each inventory location in the request is validated individually.

  • If validation fails, the request may be rejected.

  • System-generated fields are ignored if provided in the request payload.


UI Navigation

Asset Management→ Inventory → Setup → Local Tables → Inventory Locations


Finders

Not applicable.

This is a POST (create) endpoint and does not support finders.


Path Parameters

Not applicable.

This endpoint does not use path parameters.


Query Standards

Not applicable.

This endpoint does not support finder, limit, offset, or orderBy.


Finders with Example

Not applicable.

Finders are not supported for POST operations.


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

Body parameters
object
Example{ "cilocCompCode": "ZZ", "cilocCode": "DRLC95", "cilocName": "Main Warehouse - Bin 01", "cilocDeptCode": "00", "cilocTypeCode": "W", "cilocDeptDistFlag": "N" }
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/json
"{\n    \"cilocCompCode\": \"ZZ\",\n    \"cilocCode\": \"DRLC52\",\n    \"cilocName\": \"Main Warehouse - Bin 01\",\n    \"cilocDeptCode\": \"00\",\n    \"cilocTypeCode\": \"W\",\n    \"cilocCtrlCode\": null,\n    \"cilocBinCtrlFlag\": null,\n    \"cilocPctUsed\": null,\n    \"cilocDeptDistFlag\": \"N\",\n    \"cilocHier\": null,\n    \"cilocInvSerCode\": null,\n    \"cilocMszoneCode\": null,\n    \"cilocIuCreateDate\": null,\n    \"cilocIuUpdateDate\": null,\n    \"cilocVUuid\": \"459F77A84FE09043E0630B811DAC05F4\",\n    \"status\": \"SUCCESS\"\n}"
string
Copyright © 2024 CMiC All Rights Reserved