UpdateInventory

This API can be used to update an existing ESN/SIM details in Telgoo5. This action can only be performed when a ESN/SIM is not assigned to a subscriber and in FREE status. Status of a ESN/SIM can be obtained using another api.

End Point https://www.vcareapi.com/vcareOssApi/UpdateInventory/
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
VENDOR ID string Vcarecorporation Required A unique Vendor ID is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
USER NAME string Vcarecorporation Required A unique User name is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
PASSWORD string Vcarecorporation Required This is a random string which is generated by Vcare and is tied to the MVNO/OSS user name. This is specifically used for authentication purpose and can be obtained by contacting your account manager.
PIN string 123456789 Required This is generated by Vcare to provide an additional layer of security in the Interim API. This is used for authentication purpose and can be obtained by contacting your account manager.
REFERENCE NUMBER string 123456789 Required Reference number is required to be passed with each transaction.
ESN / SIM string 8901123654789654123 Required This is the SIM/ESN for which its details you would like to update.  
CARRIER CODE string SPR Optional Available carrier list can be otained using GetCompanyCarrier API. TMB, SPR, VER
MODEL ID Numeric 1256 Optional This can be obtained using the GetMakeModel API  
MSL / PUK1 string Optional Required when Carrier Code is SPR or TMB.  
PURCHASE ORDER # string PO5345421 Optional This is the purchase order number.
VENDOR ID string Testvendor Optional This is the vendor/wholeseller from whom the inventory was purchased. Available vendor id list can be otained using GetVendorAndShipperID API  
BOX NUMBER string Optional This is the box number in which the inventory have been packed. Max 30 characters.
WHOLESALE PRICE Decimal 25.50 Optional This is the price at which the inventory was bought from the vendor/wholeseller Please pass decimal value.
SELLING PRICE Decimal 12.20 Optional This is the price which needs to be paid by the subscriber during activation. Please pass decimal value.
NOTES string 6464646 Optional This is the notes field Max 1000 characters
BYOD characters Y Optional This is the byod field One characters Y or N. If Empty default value N.
MSID string 1234567890 Optional it will greater then 10
MDN string 1234567890 Conditional This is the telephone number which is attached to the subscriber's account
UICCID string 8901260713156280780 Conditional This is the UICCID. Can be alpha numeric. Max length = 25
PLAN TYPE ID string 125 Conditional This is the PLAN TYPE ID. Can be alpha numeric.
AGENT ID string John Doe Required
This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
  
AGENT PASSWORD string JohnDoe Conditional This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the XML API transaction, else if you have set the permissions to password not required then you don't need to pass the Agent Password in the XML API.  
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
Sample Request XML
<?xml version="1.0" encoding="utf-8"?>
 <VCAREOSSAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.oss.vcarecorporation.com/oss">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
		<UPDATEINVENTORY>
			<ESN></ESN>
			<CARRIER></CARRIER>
			<MODELID></MODELID>
			<MSL></MSL>
			<PO></PO>
			<VENDOR></VENDOR>
			<BOX></BOX>
			<WPRICE></WPRICE>
			<SPRICE></SPRICE>
			<NOTES></NOTES>
			<BYOD></BYOD>
			<MSID></MSID>
			<MDN></MDN>
			<UICCID></UICCID>
			<PLANTYPEID></PLANTYPEID>
			<AGENTID></AGENTID>
			<AGENTPASSWORD></AGENTPASSWORD>
			<SOURCE></SOURCE>
		</UPDATEINVENTORY>
</VCAREOSS>
</VCAREOSSAPI>
List of status code, description and resolution.
Status Code Description How to Resolve?
00 SUCCESS SUCCESS
01 Error Received from Carrier. Please try again with valid data.
13 Password is invalid. Provide a valid Password.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
194 ESN should not be blank. Please provide ESN. ESN cannot be left blank.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
367 MDN should be 10 digits. Please provide a valid MDN and it should be 10 digits.
376 Model ID is not valid. Please provide a valid Model ID.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
486 UICCID must be greater than 8 and less than 25 characters. Provide correct UICCID which must be greater than 8 and less than 25 characters.
587 BYOD should be Y OR N. Provide correct BYOD. BYOD should be Y or N.
605 Plan Type ID Inactive. Please provide an active Plan Type ID. Given Plan Type ID is inactive.
606 Plan Type ID not found. Please provide a valid Plan Type. Given Plan Type is not available.
653 MSID should be greater than 10. MSID must be less than or equal to 10.
668 Please provide at least one field to update ESN. Please provide at least one field to update ESN.
Sample Response XML
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <credentials>
        <vendorId>Vcarecorporation</vendorId>
        <referenceNumber>11111111</referenceNumber>
    </credentials>
    <UpdateInventory>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
		<errorDescription>SUCCESS</errorDescription>
    </UpdateInventory>
</VcareOssApi>
SUCCESS.
Sample Fail Response: 1
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Error Received from Carrier.
How to Resolve?: Please try again with valid data.
Sample Fail Response: 2
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Password is invalid.
How to Resolve?: Provide a valid Password.
Sample Fail Response: 3
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
Sample Fail Response: 4
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>194</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN should not be blank.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: ESN should not be blank.
How to Resolve?: Please provide ESN. ESN cannot be left blank.
Sample Fail Response: 5
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
Sample Fail Response: 6
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>367</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN should be 10 digits.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: MDN should be 10 digits.
How to Resolve?: Please provide a valid MDN and it should be 10 digits.
Sample Fail Response: 7
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>376</statusCode>
	<description>FAIL</description>
	<errorDescription>Model ID is not valid.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Model ID is not valid.
How to Resolve?: Please provide a valid Model ID.
Sample Fail Response: 8
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
Sample Fail Response: 9
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>486</statusCode>
	<description>FAIL</description>
	<errorDescription>UICCID must be greater than 8 and less than 25 characters.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: UICCID must be greater than 8 and less than 25 characters.
How to Resolve?: Provide correct UICCID which must be greater than 8 and less than 25 characters.
Sample Fail Response: 10
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>587</statusCode>
	<description>FAIL</description>
	<errorDescription>BYOD  should be Y OR N.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: BYOD should be Y OR N.
How to Resolve?: Provide correct BYOD. BYOD should be Y or N.
Sample Fail Response: 11
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>605</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID Inactive.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Plan Type ID Inactive.
How to Resolve?: Please provide an active Plan Type ID. Given Plan Type ID is inactive.
Sample Fail Response: 12
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>606</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID not found.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Plan Type ID not found.
How to Resolve?: Please provide a valid Plan Type. Given Plan Type is not available.
Sample Fail Response: 13
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>653</statusCode>
	<description>FAIL</description>
	<errorDescription>MSID should be greater than 10.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: MSID should be greater than 10.
How to Resolve?: MSID must be less than or equal to 10.
Sample Fail Response: 14
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<UpdateInventory>
	<statusCode>668</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide at least one field to update ESN.</errorDescription>
</UpdateInventory>
</VcareOssApi>
Error Description: Please provide at least one field to update ESN.
How to Resolve?: Please provide at least one field to update ESN.

All the status codes are listed under the status code sections. Please click here to go to the status code.