Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
InventoryTypes

View inventory type

Find a single inventory type by ID.

get/v1/InventoryTypes/{id}

Path parameters

idinteger required

Format - int32. ID of the inventory type to view.

Response

OK

okboolean
inventory_type_idinteger

Primary identifier for this inventory type.

category'General' | 'Telephone_Number' | 'IP_Address' | 'Mobile_Device' | 'SIM_Card'

Used to specify a certain category of system-defined inventory. Some additional fields populate on the inventory type based on selection.

identifierstring required

The configured identifier for the given inventory type.

namestring required

Name that displays in the system for this inventory type.

requires_productboolean

Whether this inventory type requires a product.

descriptionstring

Configured description of the inventory type.

status'ACTIVE' | 'INACTIVE'

Specifies if the inventory type is active or not.

format'NONE' | 'ESN_DECIMAL' | 'MEID_DECIMAL' | 'ESN_OR_MEID_DECIMAL' | 'ICCID_DECIMAL' | 'IMEI_DECIMAL' | 'MAC_ADDRESS'

Inventory type format.

ratableboolean

Indicates that if an inventory item of this type is on a service, usage can be linked to the service through the inventory's identifier.