Get Mass Inventory Conversion Status
Purpose
To know the status of the mass conversion job previously scheduled through the Mass Inventory Convert API.
Request Details
Request URLs
To get the status of converted Quote records:
{api-domain}/crm/{version}/Quotes/actions/mass_convert?job_id={job_id}
To get the status of converted Sales Order records :
{api-domain}/crm/{version}/Sales_Orders/actions/mass_convert?job_id={job_id}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.mass_convert.{module_api_name}.READ
Note: Specify the API name of the parent module.
Possible module names
Quotes, and Sales Orders
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v6/Quotes/actions/mass_convert?job_id=2423488000000626117"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Parameter
- job_idstring, mandatory
It represents the unique ID of your scheduled job.
Response JSON Keys
- total_countinteger
Specifies the total number of records that were scheduled to be converted.
- not_converted_Countinteger
Specifies the number of records that are yet to be converted.
- failed_countinteger
Specifies the number of records that failed to convert.
- converted_countinteger
Specifies the number of records that were converted.
- statusstring
Indicates the status of the conversion job. Possible values are COMPLETED, SCHEDULED, IN PROGRESS, and FAILED.
Sample Response
Copied{
"data": [
{
"total_count": 10,
"not_converted_count": 0,
"failed_count": 0,
"converted_count": 10,
"status": "COMPLETED"
}
]
}
Possible Errors
- REQUIRED_PARAM_MISSING HTTP 400
Required parameter is missing.
Resolution: The job_id parameter is missing. Specify a valid job_id. - INVALID_DATAHTTP 400
The job_id is invalid.
Resolution: Specify a valid job ID. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL.
Specify a valid request method. Refer to the endpoints section above. - INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name.
Specify a valid module name. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have Zohocrm.mass_convert.Quotes.READ (or) Zohocrm.mass_convert.SalesOrders.READ.
Generate a valid token with the valid scope. Refer to scope section above. - AUTHENTICATION_FAILUREHTTP 401
Authentication failed
Resolution: Pass the access token in the request header of the API call. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL.Refer to the request URL section above. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.