API Errors
API errors occur when communicating with your WooCommerce server. These errors are prefixed with API and are organized into the following categories:
Categories
| Category | Code Range | Description |
|---|---|---|
| Connection | API01xxx | Network and connectivity issues |
| Authentication | API02xxx | Login, tokens, and permission issues |
| Request | API03xxx | Problems with outgoing requests |
| Response | API04xxx | Problems with server responses |
| Plugin/WordPress | API05xxx | Issues with WordPress or WooCommerce plugins |
| Configuration | API06xxx | Setup and configuration problems |
Connection Errors
Network and connectivity issues between the POS and your server.
| Code | Name | Description |
|---|---|---|
| API01001 | Connection Timeout | The server took too long to respond |
| API01002 | Connection Refused | The server refused the connection |
| API01003 | Connection Reset | The connection was unexpectedly closed |
| API01004 | DNS Resolution Failed | Could not resolve the server address |
| API01005 | SSL Certificate Error | Problem with the site's security certificate |
| API01006 | Network Unreachable | Cannot reach the network |
| API01007 | Device Offline | Your device is not connected to the internet |
| API01008 | Website Unavailable | The website is not responding |
Authentication Errors
Issues with login, sessions, and permissions.
| Code | Name | Description |
|---|---|---|
| API02001 | Invalid Credentials | Username or password is incorrect |
| API02002 | Token Expired | Your session has expired |
| API02003 | Token Invalid | The authentication token is not valid |
| API02004 | User Not Authorized | You don't have permission to perform this action |
| API02005 | Insufficient Permissions | Your user role lacks required permissions |
| API02006 | API Key Invalid | The WooCommerce API key is not valid |
| API02007 | Token Refresh Failed | Could not refresh your session |
| API02008 | Refresh Token Invalid | The refresh token is not valid |
| API02009 | Refresh Token Expired | The refresh token has expired |
| API02010 | Auth Required | Authentication is required for this action |
Request Errors
Problems with the requests sent to the server.
| Code | Name | Description |
|---|---|---|
| API03001 | Invalid Request Format | The request format is not correct |
| API03002 | Missing Required Parameters | Required data is missing from the request |
| API03003 | Invalid Parameter Value | A parameter has an invalid value |
| API03004 | Request Too Large | The request exceeds size limits |
| API03005 | Rate Limit Exceeded | Too many requests in a short time |
| API03006 | Unsupported Method | The HTTP method is not supported |
| API03007 | Request Queue Full | Too many pending requests |
Response Errors
Problems with the responses received from the server.
| Code | Name | Description |
|---|---|---|
| API04001 | Invalid Response Format | The server response format is not valid |
| API04002 | Unexpected Response Code | Received an unexpected HTTP status code |
| API04003 | Malformed JSON Response | The JSON response is corrupted or invalid |
| API04004 | Missing Response Data | Expected data is missing from the response |
| API04005 | JSON Recovery Attempted | Attempted to recover from malformed JSON |
Plugin/WordPress Errors
Issues with WordPress, WooCommerce, or the WCPOS plugin.
| Code | Name | Description |
|---|---|---|
| API05001 | WooCommerce API Disabled | The WooCommerce REST API is disabled |
| API05002 | WCPOS Plugin Not Found | The WCPOS plugin is not installed |
| API05003 | WCPOS Plugin Outdated | The WCPOS plugin needs updating |
| API05004 | WordPress API Disabled | The WordPress REST API is disabled |
| API05005 | Plugin Not Found | A required plugin is not installed |
Configuration Errors
Setup and configuration problems.
| Code | Name | Description |
|---|---|---|
| API06001 | Invalid URL Format | The URL format is not valid |
| API06002 | Missing API URL | No API URL has been configured |
| API06003 | Invalid Site Configuration | The site configuration is incorrect |