Inventory

Inventory_Assign

Assigns an inventory items in Rev.io.

Input

• InventoryItemID– Id of the Inventory Item to be assigned.
• CustomerID - The id of the Customer to whom the Inventory Item will be assigned.
• LineID - The Rev.io Service ID to which the Inventory Item will be assigned.
• CustomerProductID - The id of the Customer Product to which the Inventory Item will be assigned.

Output

None if successful, otherwise normal error code and message.

📘

General Notes

• Only 1 match identifier is required (CustomerID, LineID, or CustomerProductID)

• If more than 1 match identifier is passed:

  • If individual identifiers do not match each other, the request will be failed
  • ex. If a LineID (Rev.io Service ID) and a CustomerID are both passed, and the service does not match the Customer, the request will fail.

Inventory_Bulk_Create

Creates inventory items in Rev.io.

Input

• InventoryItems - A List of Inventory Items to be added
  • Inventory – Individual inventory object.
    • ID As Integer – Rev.io inventory item id.
    • CustomerID As Integer – Prohibited.
    • Identifier As String – Inventory identifier.
    • IdentifierLabel As String – Ignored.
    • InventoryTypeID As Integer – Rev.io inventory type id.
    • InventoryType As Enum_Inventory_Type – Rev.io inventory type. This does not need to be specified, however if it is, it must match the inventory type indicated on the inventory type id specified. Can be one of the following:
    • General – General inventory type for inventory not covered by another type.
    • Telephone_Number – Telephone number.
    • IP_Address – An IP address.
    • Mobile_Device – A wireless mobile device.
    • SIM_Card – A wireless SIM card.
    • InventoryDescription As String – Ignored.
    • Status As Enum_Inventory_Item_Status – Current status of inventory item. Can be one of the following:
    • AVAILABLE – Inventory is not activated and is available to be associated with a customer or activated on a batch.
    • UNAVAILABLE – Inventory is not activated and may not be used.
    • ASSIGNED – Inventory is assigned to a customer.
    • BATCHED – Inventory is on a batch.
    • AssignedDate As Date – Date the inventory was assigned to this customer.
    • UnavailableReasonID As Integer – When status is UNAVAILABLE, the reason id of why inventory is unavailable (if applicable).
    • UnavailableReasonDescription As String – Ignored
    • Note As String – Inventory note.
    • Fields – List of custom fields.
    • Field – Individual custom field
      • FieldID As Integer – Rev.io custom field id.
      • Label As String – Rev.io custom field label. If specified, must match Label of FieldID if that field is also specified.
      • Value As String – Value specified for custom field.
    • Wireless – Object containing wireless-specific inventory fields
    • MSID As String – MSID of inventory item.
    • MSL As String – MSL of inventory item.
    • MDN As String – Current MDN of inventory item.

Output

• InventoryItemIDs As Integer – InventoryItemIDs created.

Inventory_Bulk_Update

Updates inventory items in Rev.io.

📘

Note:

Only fields specified in request will be updated. If field is specified, but null, then it will be ignored. However, if a field is specified with a default value, such as 0 or an empty string, then it will replace information currently the inventory item. For example, the following will be ignored:

However, the following will not be ignored and will empty out the Note field on the inventory item:

Please take this into consideration when updating an account using this API function.

This behavior is also true for any sub-objects, for example, to update just MSID on a wireless device, the following may be used:

1234

Additionally note that the Inventory ID and Identifier cannot be changed, and either Inventory ID or Identifier must be specified for this API function.

Input

• InventoryItems – A list of inventory items to be updated
  • Inventory – Individual inventory object.
    • ID As Integer – Rev.io inventory item id. Optional if Identifier and InventoryTypeID or InventoryType is specified.
    • CustomerID As Integer – If specified, must be the Customer ID inventory is currently assigned to. The customer assignment cannot change via this API function.
    • Identifier As String – Inventory identifier. Optional if ID is specified.
    • IdentifierLabel As String – Ignored.
    • InventoryTypeID As Integer – Rev.io inventory type id.
    • InventoryType As Enum_Inventory_Type – Rev.io inventory type. This does not need to be specified, however if it is, it must match the inventory type indicated on the inventory type id specified. Can be one of the following:
      • General – General inventory type for inventory not covered by another type.
      • Telephone_Number – Telephone number.
      • IP_Address – An IP address.
      • Mobile_Device – A wireless mobile device.
      • SIM_Card – A wireless SIM card.
    • InventoryDescription As String – Ignored.
    • Status As Enum_Inventory_Item_Status – Current status of inventory item. Can be one of the following:
      • AVAILABLE – Inventory is not activated and is available to be associated with a customer or activated on a batch.
      • UNAVAILABLE – Inventory is not activated and may not be used.
      • ASSIGNED – Inventory is assigned to a customer.
      • BATCHED – Inventory is on a batch.
    • AssignedDate As Date – Date the inventory was assigned to this customer.
    • UnavailableReasonID As Integer – When status is UNAVAILABLE, the reason id of why inventory is unavailable (if applicable).
    • UnavailableReasonDescription As String – Ignored
    • Note As String – Inventory note.
    • Fields – List of custom fields.
    • Field – Individual custom field
      • FieldID As Integer – Rev.io custom field id.
      • Label As String – Rev.io custom field label. If specified, must match Label of FieldID if that field is also specified.
      • Value As String – Value specified for custom field.
    • Wireless – Object containing wireless-specific inventory fields
      • MSID As String – MSID of inventory item.
      • MSL As String – MSL of inventory item.
      • MDN As String – Prohibited.

Output

Normal error code and message if provided. Otherwise successful response.

Inventory_Create

Creates an inventory item in Rev.io.

Input

• Inventory – Individual inventory object.
  • ID As Integer – Rev.io inventory item id.
  • CustomerID As Integer – Prohibited.
  • Identifier As String – Inventory identifier.
  • IdentifierLabel As String – Ignored.
  • InventoryTypeID As Integer – Rev.io inventory type id.
  • InventoryType As Enum_Inventory_Type – Rev.io inventory type. This does not need to be specified, however if it is, it must match the inventory type indicated on the inventory type id specified. Can be one of the following:
    • General – General inventory type for inventory not covered by another type.
    • Telephone_Number – Telephone number.
    • IP_Address – An IP address.
    • Mobile_Device – A wireless mobile device.
    • SIM_Card – A wireless SIM card.
  • InventoryDescription As String – Ignored.
  • Status As Enum_Inventory_Item_Status – Current status of inventory item. Can be one of the following:
    • AVAILABLE – Inventory is not activated and is available to be associated with a customer or activated on a batch.
    • UNAVAILABLE – Inventory is not activated and may not be used.
    • ASSIGNED – Inventory is assigned to a customer.
    • BATCHED – Inventory is on a batch.
  • AssignedDate As Date – Date the inventory was assigned to this customer.
  • UnavailableReasonID As Integer – When status is UNAVAILABLE, the reason id of why inventory is unavailable (if applicable).
  • UnavailableReasonDescription As String – Ignored
  • Note As Integer – Inventory note.
  • Fields – List of custom fields.
  • Field – Individual custom field
    • FieldID As Integer – Rev.io custom field id.
    • Label As String – Rev.io custom field label. If specified, must match Label of FieldID if that field is also specified.
    • Value As String – Value specified for custom field.
  • Wireless – Object containing wireless-specific inventory fields
    • MSID As String – MSID of inventory item.
    • MSL As String – MSL of inventory item.
    • MDN As String – Current MDN of inventory item.

Output

• InventoryItemID As Integer – InventoryItemID created.

Inventory_Query

Looks up an inventory item in Rev.io.

Input

• Choice of:
  • MDN As String – MDN of inventory item.
  • InventoryID As Integer – Rev.io inventory item id.
  • Inventory – Object describing an inventory item associated with a customer.
    • Identifier As String – Inventory identifier of inventory.
    • Type As String – Optional. Type of inventory item. Must be "Mobile_Device" or "SIM_Card". If not specified, will assume "Mobile_Device".

Output

• Inventory – Individual inventory object.
  • ID As Integer – Rev.io inventory item id.
  • CustomerID As Integer – Rev.io customer id that this inventory item is associated with.
  • Identifier As String – Inventory identifier.
  • IdentifierLabel As String – The identifier label of this item, such as ESN, MEID, etc.
  • InventoryTypeID As Integer – Rev.io inventory type id.
  • InventoryType As Enum_Inventory_Type – Rev.io inventory type. Can be one of the following:
    • General – General inventory type for inventory not covered by another type.
    • Telephone_Number – Telephone number.
    • IP_Address – An IP address.
    • Mobile_Device – A wireless mobile device.
    • SIM_Card – A wireless SIM card.
  • InventoryDescription As String – Description from inventory type id.
  • Status As Enum_Inventory_Item_Status – Current status of inventory item. Can be one of the following:
    • AVAILABLE – Inventory is not activated and is available to be associated with a customer or activated on a batch.
    • UNAVAILABLE – Inventory is not activated and may not be used.
    • ASSIGNED – Inventory is assigned to a customer.
    • BATCHED – Inventory is on a batch.
  • AssignedDate As Date – Date the inventory was assigned to this customer.
  • UnavailableReasonID As Integer – When status is UNAVAILABLE, the reason id of why inventory is unavailable (if applicable).
  • UnavailableReasonDescription As String – The description of the unavailable reason id (if applicable).
  • Note As String – Inventory note.
  • Fields – List of custom fields.
    • Field – Individual custom field
      • FieldID As Integer – Rev.io custom field id.
      • Label As String – Rev.io custom field label.
      • Value As String – Value specified for custom field.
  • Wireless – Object containing wireless-specific inventory fields
    • MSID As String – MSID of inventory item.
    • MSL As String – MSL of inventory item.
    • MDN As String – Current MDN of inventory item.

Inventory_Unassign

Unassigns an inventory item from a customer account in Rev.io.

Input Feilds

Output Fields

None if successful, otherwise normal error code and message.

Inventory_Update

Looks up an inventory item in Rev.io.

📘

Note:

Note: Only fields specified in request will be updated. If field is specified, but null, then it will be ignored. However, if a field is specified with a default value, such as 0 or an empty string, then it will replace information currently the inventory item. For example, the following will be ignored:

However, the following will not be ignored and will empty out the Note field on the inventory item:

Please take this into consideration when updating an account using this API function.

This behavior is also true for any sub-objects, for example, to update just MSID on a wireless device, the following may be used:

1234

Additionally note that the Inventory ID and Identifier cannot be changed, and either Inventory ID or Identifier must be specified for this API function.

Input

• Inventory – Individual inventory object.
  • ID As Integer – Rev.io inventory item id. Optional if Identifier and InventoryTypeID or InventoryType is specified.
  • CustomerID As Integer – If specified, must be the Customer ID inventory is currently assigned to. The customer assignment cannot change via this API function.
  • Identifier As String – Inventory identifier. Optional if ID is specified.
  • IdentifierLabel As String – Ignored.
  • InventoryTypeID As Integer – Rev.io inventory type id.
  • InventoryType As Enum_Inventory_Type – Rev.io inventory type. This does not need to be specified, however if it is, it must match the inventory type indicated on the inventory type id specified. Can be one of the following:
    • General – General inventory type for inventory not covered by another type.
    • Telephone_Number – Telephone number.
    • IP_Address – An IP address.
    • Mobile_Device – A wireless mobile device.
    • SIM_Card – A wireless SIM card.
  • InventoryDescription As String – Ignored.
  • Status As Enum_Inventory_Item_Status – Current status of inventory item. Can be one of the following:
    • AVAILABLE – Inventory is not activated and is available to be associated with a customer or activated on a batch.
    • UNAVAILABLE – Inventory is not activated and may not be used.
    • ASSIGNED – Inventory is assigned to a customer.
    • BATCHED – Inventory is on a batch.
  • AssignedDate As Date – Date the inventory was assigned to this customer.
  • UnavailableReasonID As Integer – When status is UNAVAILABLE, the reason id of why inventory is unavailable (if applicable).
  • UnavailableReasonDescription As String – Ignored
  • Note As String – Inventory note.
  • Fields – List of custom fields.
    • Field – Individual custom field
      • FieldID As Integer – Rev.io custom field id.
      • Label As String – Rev.io custom field label. If specified, must match Label of FieldID if that field is also specified.
      • Value As String – Value specified for custom field.
  • Wireless – Object containing wireless-specific inventory fields
    • MSID As String – MSID of inventory item.
    • MSL As String – MSL of inventory item.
    • MDN As String – Prohibited.

Output

Normal error code and message if provided. Otherwise successful response.

InventoryTypes_Create

Creates an inventory type in Rev.io.

Input

• InventoryType – Inventory Type to create
  • ID As Integer – Prohibited in this API function.
  • Type As Enum_Inventory_Type – Required. May be one of the following values:
    • General – General inventory type.
    • Telephone_Number – Telephone number inventory type.
    • IP_Address – An IP address.
    • Mobile_Device – A wireless device (usually for CDMA providers).
    • SIM_Card – A wireless SIM card (usually for GSM providers).
  • Identifier As String – The identifier to use as a label for this type. For instance, "ESN/MEID" could be used for Mobile_Device types or "ICCID" for SIM Cards. This will be used for display purposes in Rev.io. Required.
  • Name As String – The name of the inventory Type. Required.
  • RequiresProduct As Boolean – If the inventory type requires a product. This is required to be "True" for Mobile_Device and SIM_Card inventory types, otherwise Optional.
  • ProgrammingInstructions As String – Programming instructions for inventory types that require programming. Optional.
  • Description As String – Description of inventory type.
  • Status As Enum_Inventory_Type_Status – Optional. May be one of the following values. Will default to "ACTIVE" if not specified.
    • ACTIVE – Inventory Type is active and may be selected for new inventory from within Rev.io.
    • INACITVE – Inventory Type is inactive and may not be selected for new inventory from within Rev.io.
  • Format As Enum_Inventory_Type_Format – Required for Mobile_Device and SIM_Card device types, otherwise must be "NONE" or not specified. Possible values are:
    • NONE – The inventory identifier is not required to be formatted in a certain manner. May only be used for inventory types other than Mobile_Device and SIM_Card.
    • ESN_DECIMAL – The inventory identifier must be in ESN decimal format. May only be used with Mobile_Device inventory types.
    • MEID_DECIMAL – The inventory identifier must be in MEID decimal format. May only be used with Mobile_Device inventory types.
    • ESN_OR_MEID_DECIMAL – The inventory identifier may be in either ESN or MEID decimal format. May only be used with Mobile_Device inventory types.
    • ICCID_DECIMAL – The inventory identifier must be in ICCID decimal format. May only be used with SIM_Card inventory types.
  • Fields – List of custom inventory fields
    • Field – One inventory field item.
      • FieldID As Integer – Rev.io custom field ID. Optional if Label is specified.
      • Label As String – Custom field label. Optional if FieldID is specified, however must match current label of field if both are specified.
      • Value As String – Value of custom field for this inventory type.

Output

• ID As Integer – ID of inventory type created.

InventoryTypes_Delete

Deletes an inventory type in Rev.io.

Input

• ID As Integer – Inventory Type ID to delete.

Output

None

InventoryTypes_Query

Lookup inventory types.

Input

• May be one of the following (or don't specify any for all inventory types):
  • ID As Integer – Lookup by inventory type id.
  • Type As Enum_Inventory_Type – Lookup by inventory type. May be one of the following values:
    • General – General inventory type.
    • Telephone_Number – Telephone number inventory type.
    • IP_Address – An IP address.
    • Mobile_Device – A wireless device (usually for CDMA providers).
    • SIM_Card – A wireless SIM card (usually for GSM providers).
  • PackageID As Integer – Lookup by associated Rev.io package id.
  • ProductID As Integer – Lookup by associated Rev.io product id.
  • Field – Lookup by custom field.
    • Label As String – Custom field label to lookup by.
    • Value As String – Find items that have this custom field value for specified label.

Output

• InventoryTypes – List of inventory types.
  • InventoryType
    • ID As Integer – Inventory Type ID
    • Type As Enum_Inventory_Type – Type of inventory. Will be one of the following values:
      • General – General inventory type.
      • Telephone_Number – Telephone number inventory type.
      • IP_Address – An IP address.
      • Mobile_Device – A wireless device (usually for CDMA providers).
      • SIM_Card – A wireless SIM card (usually for GSM providers).
    • Identifier As String – The identifier to use as a label for this type.
    • Name As String – The name of the inventory Type.
    • RequiresProduct As Boolean – If the inventory type requires a product.
    • ProgrammingInstructions As String – Programming instructions for inventory types that require programming.
    • Description As String – Description of inventory type.
    • Status As Enum_Inventory_Type_Status – Status of inventory type. Will be one of the following values:
      • ACTIVE – Inventory Type is active and may be selected for new inventory from within Rev.io.
      • INACTIVE – Inventory Type is inactive and may not be selected for new inventory from within Rev.io.
    • Format As Enum_Inventory_Type_Format – The format of the identifier for inventory assigned to this inventory type. Will be one of the following values.
      • NONE – The inventory identifier is not required to be formatted in a certain manner.
      • ESN_DECIMAL – The inventory identifier must be in ESN decimal format.
      • MEID_DECIMAL – The inventory identifier must be in MEID decimal format.
      • ESN_OR_MEID_DECIMAL – The inventory identifier must be in either ESN or MEID decimal format.
      • ICCID_DECIMAL – The inventory identifier must be in ICCID decimal format.
    • Fields – List of custom inventory type fields
      • Field – One inventory type field item.
        • FieldID As Integer – Rev.io custom field ID.
        • Label As String – Custom field label.
        • Value As String – Value of custom field for this inventory type.
    • ItemFields – List of custom fields defined for inventory items of this inventory type
      • Field – One inventory item field definition
        • FieldID As Integer – Rev.io custom field ID.
        • Label As String – Custom field label of the inventory item field.
        • Description As String – Description of the inventory item field.
        • FieldType As String – Type of the inventory item field. One of the following values:
          • Text Box
          • Text Area
          • Drop Down List
          • Radio Button List
          • Check Box
          • Date
        • DefaultValue As String – Default value of the inventory item field.
        • IsRequired As Boolean – Value of the whether the inventory item field is required or not.
        • Options As List – Pre-defined options of the inventory item field.
          • Option As String – One of the pre-defined options.

InventoryTypes_Update

Updates an inventory type in Rev.io.

Input

• InventoryType – Inventory Type to update
  • ID As Integer – Required.
  • Type As Enum_Inventory_Type – May be one of the following values:
    • General – General inventory type.
    • Telephone_Number – Telephone number inventory type.
    • IP_Address – An IP address.
    • Mobile_Device – A wireless device (usually for CDMA providers).
    • SIM_Card – A wireless SIM card (usually for GSM providers).
  • Identifier As String – The identifier to use as a label for this type. For instance, "ESN/MEID" could be used for Mobile_Device types or "ICCID" for SIM Cards. This will be used for display purposes in Rev.io.
  • Name As String – The name of the inventory Type.
  • RequiresProduct As Boolean – If the inventory type requires a product.
  • ProgrammingInstructions As String – Programming instructions for inventory types that require programming.
  • Description As String – Description of inventory type.
  • Status As Enum_Inventory_Type_Status – May be one of the following values:
    • ACTIVE – Inventory Type is active and may be selected for new inventory from within Rev.io.
    • INACITVE – Inventory Type is inactive and may not be selected for new inventory from within Rev.io.
  • Format As Enum_Inventory_Type_Format – May be one of the following values:
    • NONE – The inventory identifier is not required to be formatted in a certain manner. May only be used for inventory types other than Mobile_Device and SIM_Card.
    • ESN_DECIMAL – The inventory identifier must be in ESN decimal format. May only be used with Mobile_Device inventory types.
    • MEID_DECIMAL – The inventory identifier must be in MEID decimal format. May only be used with Mobile_Device inventory types.
    • ESN_OR_MEID_DECIMAL – The inventory identifier may be in either ESN or MEID decimal format. May only be used with Mobile_Device inventory types.
    • ICCID_DECIMAL – The inventory identifier must be in ICCID decimal format. May only be used with SIM_Card inventory types.
  • Fields – List of custom inventory fields
    • Field – One inventory field item.
      • FieldID As Integer – Rev.io custom field ID. Optional if Label is specified.
      • Label As String – Custom field label. Optional if FieldID is specified, however must match current label of field if both are specified.
      • Value As String – Value of custom field for this inventory type.

Output

None

InventoryTypes_Assign

Assigns one or more DIDs (Service Inventory Items) in rev.io to a customer's service.

Input

• Identifiers – List of any "Inventory Item Identifiers" to be assigned to the customer's service
• LineID - The Rev.io Service ID to which the Inventory Item will be assigned.
• CustomerProductID - The id of the product in which to be assigned along with the Service Inventory. Must be associated with the inventory type of the inventory specified.

Output

None if successful, otherwise normal error code and message.

InventoryTypes_Unassign

Unassigns one or more DIDs (Service Inventory Items) in Rev.io from a customer's service.

Input

• Identifiers – List of any "Inventory Item Identifiers" to be assigned to the customer's service
• LineID - The Rev.io Service ID to which the Inventory Item will be assigned.
• InventoryStatus - (optional) The new status of the unassigned inventory (AVAILABLE, UNAVAILABLE) ( * Will default to "AVAILABLE" if no value is specified)

Output

None if successful, otherwise normal error code and message.