Response Codes & Messages
Use this reference to understand the application messages QixolPromo returns and decide how your integration should respond. These codes describe business and validation outcomes; they are different from HTTP status codes. The catalogue covers documented messages but may not include every possible response.
How to interpret results
Inspect summary.result and summary.messages even for HTTP 200 responses. Use the operation's response schema to determine how messages are returned.
Application message code catalogue
Find the code returned by your request in the table below. For Basket and Coupon Code Validation, the CV messages can help explain coupon eligibility, usage and validation outcomes. Message text is shown as returned by the API.
| Code | Meaning |
|---|---|
CV100 | The code has not been confirmed as utilized. |
CV101 | The code has not been confirmed as issued. |
CV102 | The code was first utilized by a previous submission of this basket. |
CV103 | The code was first issued by a previous submission of this basket. |
CV104 | The code was issued by a previous submission of this basket, but was not triggered by this submission. |
CV105 | The code was utilized by a previous submission of this basket, but was not triggered by this submission. |
CV201 | A critical problem occurred whilst attempting to use the code. |
CV202 | A critical problem occurred whilst attempting to validate the code. |
CV203 | A critical problem was encountered whilst issuing the code. |
CV301 | The code start date is after the basket date. |
CV302 | The code end date is before the basket date. |
CV303 | The code cannot be redeemed - it is defined as issue only. |
CV304 | The code has reached the maximum number of permitted uses. |
CV305 | The code has not been issued. |
CV306 | The code has expired. |
CV307 | The code has been withdrawn. |
CV308 | The code start/end date is outside of the basket date. |
CV309 | The code has a restricted number of uses per customer. The number of permitted uses has been reached. |
CV314 | Due to active locks, the code has reached the maximum number of permitted uses. |
CV501 | The specified code was not found. |
CV502 | A code must be specified. |
CV503 | A company key must be specified. |
CV504 | A coupon key must be specified. |
CV505 | Status is not supported. |
CV506 | The specified earliest issue date could not be parsed. |
CV507 | The supplied Xml could not be parsed. |
CV508 | No codes were found that meet the requested criteria. |
CV599 | A problem was encountered whilst validating the code. |
CV901 | Unsupported code status |
10001 | A company key must be specified |
10002 | The supplied basket date could not be parsed |
10003 | The supplied basket is empty or has no items with quantity greater than zero |
10004 | The supplied company key is invalid |
10005 | The Basket reference is empty or invalid |
10006 | One or more of the supplied lines does not have a line id assigned |
10007 | Error deserializing basket request |
10008 | Error preparing response. Serialization failed |
10010 | One or more lines in the basket has a quantity greater than the defined limit |
20000 | An error occurred whilst processing the basket. Please contact technical support for assistance. |
30000 | Access denied |
30001 | The Promo Evaluation Service is not available for this company. Please use the live Basket/Data Manager service. |
EX30101 | A promotion name or reference must be specified. |
EX30102 | The promotion name or reference could not be found. |
EX30103 | The supplied year/month cannot be in the future. |
EX30201 | The supplied year/month cannot be in the future. |
IM101 | The data passed is invalid or is not well formed. |
IM102 | The data passed does not contain a company key attribute. |
IM103 | The supplied company key is invalid. |
IM104 | The company must be specified. |
IM105 | The import has been queued ready for processing. |
IM190 | A problem was encountered deserializing the request data. |
IM197 | A problem was encountered whilst processing the export. |
IM198 | Unrecognised error code |
IM199 | A problem was encountered whilst processing the request. Please contact technical support for assistance. |
IM201 | The attribute token is missing or invalid. |
IM202 | The supplied entity name is invalid. |
IM250 | The item does not exist, and so cannot be deleted. |
IM251 | The specified attribute is not defined. |
IM252 | A value must be specified. |
IM299 | A problem was encountered whilst processing item. |
IM301 | The import data request does not contain any product definitions. |
IM302 | The import contains too many products, and would exceed the maximum number of products permitted whilst evaluating. |
IM303 | Missing productcode |
IM304 | Duplicate productcode/variantcode |
IM305 | A variant code must be specified for all uses of the productcode |
IM306 | Attribute values cannot be imported. One or more specified attributes are not valid for products |
IM307 | Product cannot be deleted - the Product was not found |
IM308 | Product cannot be deleted as it is in use in live baskets |
IM399 | A problem was encountered whilst processing the import. |
IM501 | The import token is missing or invalid. |
IM502 | Importing of codes for Vouchers is not supported. |
IM503 | The id is invalid. |
IM503.1 | The coupon key is invalid |
IM504 | The document to import does not contain any codes. |
IM504.1 | Too many codes supplied in import file |
IM505 | A campaign management operation is currently in progress. The import of codes is not permitted whilst the operation is in progress. |
IM506 | Unable to retrieve status list. |
IM507 | Unable to find the 'Active' status. |
IM508 | Unable to find the 'Created' status. |
IM509 | Unable to retrieve issuer list. |
IM510 | Unable to retrieve import code issuer. |
IM511 | The import needs either a couponkey or couponname attribute with each <item> element. Supported but not recommended is supplying a couponkey attribute with the <items> element. Values supplied at the <item> element will override this attribute. |
IM512 | Against an item element specifiy either a couponkey to add the code to an existing campaign OR a couponname to create a new coupon to attach the new code to. Note that the couponname must be a new name, to update existing coupons use the couponkey (import token) |
IM513 | Creating a new code failed with an unspecified error |
IM514 | The campaign type (Source Code) for creating the new coupon could not be found |
IM515 | The name specified for creating a new campaign is already in use |
IM516 | The specified coupon name could not be found. |
IM519 | Errors were encountered after importing codes, whilst updating internal caches. Please contact technical support for assistance. |
IM550 | A code must be specified. |
IM551 | Maximum uses must be a positive number. |
IM552 | The valid from date could not be parsed. |
IM553 | The valid to date could not be parsed. |
IM554 | The specified status is not supported for this campaign type. |
IM555 | The valid to date cannot be before the valid from date. |
IM556 | Import coupon item delete no code |
IM556.1 | The code exists for another coupon/campaign |
IM556.2 | The code does not exist and so cannot be deleted. |
IM557 | The code is in use and cannot be deleted. |
IM558 | Deleting codes with this status is not permitted. |
IM559 | The specified maximum uses is invalid, as it is less than the current number of uses for the code. |
IM560 | Updating the status for this code to the specified value is not permitted. |
IM561 | The specified status is invalid. |
IM562 | The specified code is already defined against another campaign. |
IM563 | A maximum of {0} codes can be added whilst evaluating. |
IM567 | Duplicate code |
IM570 | Import coupon item csv to xml invalid |
IM599 | A problem was encountered whilst processing the import. |
IM801 | From and to customer references must be supplied. |
IM900 | The request failed validation. See validation messages for more details. |
IM901 | Service url parameter mismatch |
PGV001 | Promotion group name is missing or invalid |
PGV002 | The promotion group name specified is in use |
PGV003 | The promotion group name is unknown |
PGV004 | Promotion Group is in use and cannot be deleted |
PGV005 | Cannot delete the last promotion group. There must always be at least one promotion group. |
PV0101 | Promotion [type] missing or invalid |
PV0102 | [validfrom]/[validto] date missing or invalid |
PV0103 | [name] is missing |
PV0104 | [promotiongroup] is unknown |
PV0105 | Promotion [type] is not available |
PV0106 | Promotion [name] is in use |
PV0107 | One or more product criteria is required |
PV0108 | [validto] date is before [validfrom] date |
PV0109 | A [percentagediscount] or [valuediscount] must be specified |
PV0110 | One or more discount items must be specified |
PV0111 | Bundle Promotion: [bundleprice] cannot be less than or equal to zero |
PV0112 | Free Gift: One or more free gift items must be specified |
PV0113 | Issue Voucher Code: The specified coupon is missing or invalid |
PV0114 | Issue Voucher Code: [maxissues] is invalid |
PV0115 | Issue Points: [points] to be issued cannot be less than or equal to zero |
PV0116 | Multi-buy: One or more ranges must be specified |
PV0117 | Workflow Trigger: An attribute and value must be specified |
PV0118 | Deal: The target product group does not contain any criteria items |
PV0119 | Deal: One or more groups must be selected as the discount target |
PV0120 | Deal: [newprice] cannot be less than or equal to zero |
PV0121 | The promotion cannot be unpublished |
PV0122 | [reportingcode] is unknown |
PV0123 | [discounttype] is missing or invalid |
PV0124 | [pointsmethod] is missing or invalid |
PV0125 | [restrictionrule] is missing or invalid |
PV0126 | [restrictionvalue] is missing or invalid |
PV0127 | [action] is missing, invalid or not supported for the promotion type |
PV0128 | [appliesto] is missing, invalid or not supported for the promotion type |
PV0129 | [apportiondiscount] is missing, invalid or not supported for the promotion type |
PV0130 | [validationmethod] is missing, invalid or not supported for the promotion type |
PV0131 | The promotion id is unknown |
PV0132 | The promotion is locked and cannot be amended or deleted |
PV0133 | A promotion cannot be updated to be locked. Please refer to the API documentation for locking a promotion. |
PV0134 | A promotion cannot be updated to be published. Please refer to the API documentation for publishing a promotion. |
PV0135 | [missedpromotions/reportingcode] is unknown |
PV0136 | The promotion is in use and cannot be amended or deleted |
PV0137 | The promotion is already published |
PV0138 | The promotion validto date must be in the future |
PV0139 | The promotion is already locked |
PV0140 | The promotion is already unlocked |
PV0141 | An Attribute Token must be specified for price override |
PV0142 | Price Override invalid handling option is invalid |
PV0143 | 'Always Apply' promotions are not supported based on the company configuration |
PV0144 | Linked promotion Id is unknown |
PV0145 | Unknown or unsupported link type |
PV0146 | The specified promotion cannot be linked because it is not configured to be applied before this promotion |
PV0147 | The current promotion cannot be used as a linked promotion |
PV0148 | Links exist to this promotion. Remove all links before attempting to delete the promotion. |
PV0149 | Issue Voucher Code: The specified refer-a-friend coupon is unknown |
PV0150 | Issue Voucher Code: The 'Require Customer Id' option must be set to true for refer-a-friend voucher codes to be issued. |
PV0201 | Criteria coupon import/export key is unknown |
PV0202 | [attributetoken] is unknown |
PV0203 | Criteria coupon import/export key is missing |
PV0204 | Basket criteria missing attribute token |
PV0205 | Basket criteria missing attribute value |
PV0206 | Product Criteria missing product/variant code and attribute token |
PV0207 | One or more criteria are duplicated |
PV0301 | Timeband start or end time is missing or invalid |
PV0302 | One or more days must be selected for the timeband |
PV0401 | Discount item missing product/variant code and attribute token |
PV0402 | Discount item attribute token is unknown |
PV0501 | Product Criteria Group quantity to discount cannot be less than or equal to zero, or greater than the group required quantity |
PV0701 | The promotion Id is missing or invalid |
PV0801 | A problem was encountered whilst creating/updating the promotion, please contact technical support for assistance |
PV0802 | A problem was encountered whilst attempting to delete the promotion, please contact technical support for assistance |
PV0901 | The promotion is in use; only information which does not affect how the promotion will be applied can be updated |
PV0902 | The promotion is now published |
PV0903 | The maximum number of permitted promotions has been reached for this company. |
PV0904 | The promotion is now locked |
PV0905 | The promotion is now unlocked |
PVG0801 | A problem was encountered whilst deleting the promotion group, please contact technical support for assistance |
RCV0001 | Reporting Code is missing or invalid |
RCV0002 | Category is missing or invalid |
RCV0003 | The code specified already exists |
RCV0004 | The reporting code is unknown |
RCV0005 | Reporting Code is in use and cannot be deleted |
RCV0801 | A problem was encountered please contact technical support for assistance |
TR999 | Too many requests. The request has been throttled. |
Throttling
TR999 denotes a throttled request. Apply bounded retry/backoff and confirm environment-specific limits. Never automatically replay confirmed baskets without checking for persistent effects.
Further reading
See Integration Best Practices and the API Reference.