Telgoo APIs

DropshipShipment

This XML API is used add the GSM/IMEI stock in the inventory and assign it to the agents.

End Point	https://www.vcareapi.com/vcareOssApi/DropshipShipment/
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	Auto generated unique reference number is required to be passed with each transaction.
ESN		string	890112365445346543	Required	This is the SIM/ESN which needs to be added in the inventory
MDN		string	8901123654	Optional
SKU		string	43534534	Required
SHIPPER		string	43534534	Required
CARRIER		string	TMB	Required	Available carrier list can be otained using GetCompanyCarrier API
UICCID		string	12	Optional
ENROLLMENTID		string	12	Required
IMEI		string	12	Optional
PHONE MODEL		string	12	Required	This can be obtained using the GetModel API
ESN MODEL		string	12	Required
STATE		string	NY	Required
PHONE TYPE		string	Feature, Smart	Optional
AREACODE			1254	Optional
TAKEAWAY		string	R, H, S, E	Optional
UPLOADTYPE		string	PENDINGORDER, SIMONLY, POSTPAIDPHONENONLL, PAIDPHONENONLL, PAIDPHONE ,FREEPHONEWITHOUTDATA, FREEPHONEWITHDATA	Optional
COMPANY ID				Optional
AGENT ID		string	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENTPASSWORD		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="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <CREDENTIALS>
  <VENDORID></VENDORID>
  <USERNAME></USERNAME>
  <PASSWORD></PASSWORD>
  <PIN></PIN>
  <REFERENCENUMBER></REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
 <DROPSHIPSHIPMENT>
	<ESN></ESN>
	<MDN></MDN>
	<SKU></SKU>
	<SHIPPER></SHIPPER>
	<CARRIER></CARRIER>
	<UICCID></UICCID>
	<ENROLLMENTID></ENROLLMENTID>
	<IMEI></IMEI>
	<PHONEMODEL></PHONEMODEL>
	<ESNMODEL></ESNMODEL>
	<STATE></STATE>
	<PHONETYPE></PHONETYPE>
	<AREACODE></AREACODE>
	<TAKEAWAY></TAKEAWAY>
	<UPLOADTYPE></UPLOADTYPE>
	<COMPANYID></COMPANYID>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
  </DROPSHIPSHIPMENT>
 </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.
41	Carrier is invalid.	Please provide valid Carrier.
126	Invalid MDN.	Please provide valid MDN.
169	Company ID is required.	Please provide company ID.
170	Carrier ID is required.	Please provide a Carrier ID.
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.
380	Upload Type should not be blank.	Please provide Upload Type as it cannot be blank.
381	Upload Type is not valid.	Please provide a valid Upload Type.
382	SKU should not be blank.	Please provide SKU as it cannot be blank.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.

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></vendorId>
        <referenceNumber></referenceNumber>
    </credentials>
    <DropshipShipment>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
	<device_filelogid></device_filelogid>
	<esn_filelogid></esn_filelogid>
	<finalfilename></finalfilename>
	<finalfilenameimei></finalfilenameimei>
    </DropshipShipment>
</VcareOssApi>

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>
<DropshipShipment>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</DropshipShipment>
</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>
<DropshipShipment>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</DropshipShipment>
</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>
<DropshipShipment>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</DropshipShipment>
</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>
<DropshipShipment>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: Carrier is invalid.

How to Resolve?: Please provide valid Carrier.

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>
<DropshipShipment>
	<statusCode>126</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid MDN.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: Invalid MDN.

How to Resolve?: Please provide valid MDN.

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>
<DropshipShipment>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: Company ID is required.

How to Resolve?: Please provide company ID.

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>
<DropshipShipment>
	<statusCode>170</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier ID is required.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: Carrier ID is required.

How to Resolve?: Please provide a Carrier 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>
<DropshipShipment>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it cannot be blank.

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>
<DropshipShipment>
	<statusCode>367</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN should be 10 digits.</errorDescription>
</DropshipShipment>
</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: 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>
<DropshipShipment>
	<statusCode>380</statusCode>
	<description>FAIL</description>
	<errorDescription>Upload Type  should not be blank.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: Upload Type should not be blank.

How to Resolve?: Please provide Upload Type as it cannot be blank.

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>
<DropshipShipment>
	<statusCode>381</statusCode>
	<description>FAIL</description>
	<errorDescription>Upload Type is not valid.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: Upload Type is not valid.

How to Resolve?: Please provide a valid Upload Type.

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>
<DropshipShipment>
	<statusCode>382</statusCode>
	<description>FAIL</description>
	<errorDescription>SKU should not be blank.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: SKU should not be blank.

How to Resolve?: Please provide SKU as it cannot be blank.

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>
<DropshipShipment>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</DropshipShipment>
</VcareOssApi>

Error Description: Invalid Source.

How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

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