Order Status Codes
The relevant orderitems status codes for the API usage
| Status Code | Status | Hint |
|---|---|---|
| 3 | PROCESSING | manual data collection in progress |
| 5 | GENERATED | report generator finished work |
| 6 | AVAILABLE | available to retrieve |
| 9 | CANCELED | order canceled with explanation |
| 10 | VALIDATION | report failed validation and is being investigated |
The status "Validation" helps you to identify when an online report is not available immediately. Since we need time to check the issue.
HTTP Status Codes
All status codes are standard HTTP status codes. The below ones are used in this API.
2XX - Success of some kind
4XX - Error occurred in client’s part
5XX - Error occurred in server’s part
| HTTP Status Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 202 | Accepted (Request accepted, and queued for execution) |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Forbidden |
| 404 | Resource not found |
| 500 | Internal Server Error |
| 501 | Not Implemented |
| 503 | Service Unavailable |
Cancellation Codes
| Code | Description |
|---|---|
| 001 | Business doesn't exist |
| 002 | Business can't be identified |
| 003 | ZIP Code / town incomplete / incorrect / missing |
| 004 | Street incomplete / incorrect / missing |
| 005 | Address incomplete / incorrect |
| 006 | Business is outside of provider's territory |
| 007 | Double Inquiry – Report has already been provided / Order in progress |
| 008 | Due to legal reasons, a report cannot be delivered |
| 009 | Order has been cancelled |
| 010 | Record is locked |
| 011 | Record cannot be delivered |