Errors#
This is a list of error codes, which can be returned by Antavo. Each error is accompanied by a link to the documentation of the associated endpoint and a simple troubleshooting suggestion.
Antavo Error |
HTTP status code |
Message |
Documentation link |
Troubleshooting advice |
|---|---|---|---|---|
0 |
404 |
Not Found / Property transaction_id cannot be empty / Property <attribute> cannot be empty |
||
1601 |
400 |
Coupon not found |
Check the coupon ID and try again. |
|
1606 |
400 |
The coupon balance is lower than the amount |
||
5003 |
The transaction ID has already been used |
|||
10001 |
400 |
Action “%s” cannot be repeated |
||
101021 |
401 |
Auth header format is invalid |
Invalid authentication - please check credentials/formatting and try again |
|
103902 |
Customer does not match transaction owner |
Check the event’s customer and transaction ID |
||
110003 |
Customer is not allowed to spend points |
The customer is suspended, unsuspend and then try again |
||
112101 |
400 |
Customer has already been opted-in. |
There is already a loyalty member with this unique ID, you need to use a different ID |
|
112201 |
Only accepted transactions can be refunded |
|||
112202 |
Amount should be a positive number |
|||
112203 |
Amount for refund is greater than transaction total |
|||
112204 |
Amount for refund is greater the purchase total of the customer |
|||
112900 |
Can’t unspend more (%d) than the customer current spent points (%d) |
|||
114400 |
Only active customers can be suspended |
Check the status and ID of the customer being suspended |
||
114600 |
Only suspended customers can be unsuspended |
Check the status and ID of the customer being unsuspended |
||
120030 |
Suspended target customers cannot be merged |
Suspended customers can not be merged or linked |
||
120031 |
Suspended target customers cannot be merged |
Suspended customers can not be merged or linked |
||
120211 |
400 |
Custom message set in Backoffice - Claim limit error |
The numbers of Reward claims for a customer can be increased in the back office |
|
120212 |
400 |
Custom message set in Backoffice - Out of stock error |
The number of Reward claims exceeds the reward stock. This value can be increased in the Backoffice |
|
120213 |
400 |
Custom message set in Backoffice - Segment error |
The customer can not claim this rewards as they are not in the correct segment. Check the customer and corresponding segment |
|
120214 |
400 |
Customer does not have enough points |
||
120215 |
400 |
Custom message set in Backoffice - The Reward is currently out of stock |
The number of claims exceeds the reward’s stock - Inactivate the reward or increase the stock value to remove this error. |
|
120216 |
400 |
Custom message set in Backoffice - Claim within repetition limitation error |
Try reducing the repetition rate in the rewards setting in the Backoffice |
|
120217 |
400 |
Custom message set in Backoffice - Customer has already claimed this reward |
||
120218 |
400 |
CSRF token mismatch |
||
120220 |
400 |
Coupon pool not found |
Check the id of the coupon pool used |
|
120221 |
400 |
Coupon claim limit reached |
||
120222 |
400 |
Cannot claim due to duplicate coupon code. |
Coupon codes need to be unique for multiple claims of the same reward. Try increasing the complexity of the generated coupon or check uploaded coupon code are unique |
|
120223 |
400 |
Coupon currency doesn’t match with customer currency |
||
123723 |
400 |
Received malformed response from coupon provider |
||
123724 |
400 |
Receiving coupon failed |
||
123731 |
400 |
No unassigned coupon found |
||
123732 |
400 |
Coupon assign failed |
||
123741 |
400 |
No available coupon code |
||
124931 |
200 / Runtime |
Pending event created* |
This is not strictly an error but results from the mechanism for making an event pending. |
|
127201 |
200 |
Custom error message supplied in the Interrupted Node |
The event has been interrupted in the workflow editor using an interrupt node. Check workflow logs for details |
|
160101 |
400 |
Missing required parameter ‘action’ |
This is typically a misformed JSON event and/or Content-Type header has not been set to application/json. |
|
160102 |
404 |
Customer not found |
Check the customer ID and try again |
|
160105 |
400 |
Brand is not active |
Contact the Antavo Service Desk requesting that this brand is activated |
|
160106 |
400 |
Given action is invalid |
||
160107 |
400 |
Given customer is invalid |
Check the customer ID type and value. This error is reported if the customer is not opted in and autosubscribe is disabled; if the customer is banned or if the brand is inactive. |
|
160108 |
400 |
Duplicated customer |
||
160109 |
400 |
Optional parameter ‘data’ should contain key-value pairs |
The data object is misformed. Check for correct JSON formatting. |
|
160111 |
400 |
Missing required parameter 'customer' |
Check the JSON formatting of the event |
|
160211 |
400 |
Empty search criteria |
No search terms are provided. Check the query and try again |
|
160212 |
404 |
Customer not found |
Customer API |
Check the customer’s Antavo ID and try again. |
160214 |
404 |
Customer doesn't have opt-in event |
The customer has been created via an Inactive pathway. |
|
160216 |
400 |
Customer is not active |
Set the customer’s status to active so the customer can fully interact with the loyalty program. |
|
160217 |
400 |
Offset cannot be negative |
||
160218 |
400 |
Limit should be greater than zero |
||
160300 |
400 |
Invalid status filter |
||
160301 |
Missing path param: {path_param} |
Check the submitted API and include the required path parameter |
||
160310 |
400 |
Invalid status filter |
||
160311 |
400 |
Empty search criteria |
||
160312 |
400 |
Page and limit must be larger than zero. |
||
160320 |
404 |
Reward not found |
Check that the Antavo Reward ID being passed is correct. |
|
160321 |
400 |
Reward is not active |
Activate the reward in the Antavo Backoffice. |
|
160322 |
400 |
Cannot claim bidding reward via API |
||
160323 |
400 |
Missing required parameter: points |
||
160324 |
Cannot claim non bidding reward via this API endpoint |
|||
160325 |
400 |
*Exception message is displayed |
||
160326 |
400 |
Customer does not have enough points for multiple claims |
||
160330 |
400 |
Incorrect order type: %s |
||
160331 |
400 |
Incorrect sortable fields: %s |
||
160340 |
400 |
Event not found |
Check the unique Event ID and try again |
|
160341 |
400 |
Can't revoke a reward which has redeemed coupon |
Unredeem corresponding coupon before retrying an Reward revoke |
|
160342 |
400 |
Claim event does not match reward ID |
||
160344 |
400 |
Claim event already revoked |
||
160345 |
400 |
Reward claim not found |
||
160346 |
400 |
Not a reward claim event |
||
160350 |
403 |
Invalid API key |
Check the API key with the credentials in the Backoffice |
|
160360 |
400 |
Property ‘%s’ cannot be empty |
||
160361 |
400 |
Property ‘%s’ value is a non-utf8 string |
||
160362 |
400 |
Property ‘%s’ has an invalid value |
||
160363 |
400 |
Sub-action ‘%s’ not found |
||
160364 |
400 |
Property “%s” element %d should contain key-value pairs |
||
160365 |
400 |
Action is invalid or not set |
||
160366 |
Duplicated value for {field} |
Duplicate data has been submitted for a customer field which has been tagged |
||
160401 |
404 |
Customer not Found |
||
160412 |
400 |
Coupon %s is restricted for a limited products |
Add one of the restricted products to the submitted checkout/checkout_item event or remove the coupon from the checkout event. |
|
160415 |
400 |
Coupon doesn’t have a balance |
The coupon value has not been set under coupon settings. Find instructions on how to set a value here . |
|
160420 |
400 |
The coupon has been expired since (%s) |
The claimed coupon has expired, try claiming another coupon. |
|
160601 |
404 |
Customer not found |
Check the customer’s Antavo ID and try again. |
|
170101 |
400 |
lc_bidding_is_closed |
||
170102 |
400 |
lc_not_enough_points |
||
170103 |
400 |
lc_invalid_bid_value_label |
||
170104 |
400 |
lc_unable_to_bid_label |
||
171111 |
400 |
Target email or target ID is required |
||
171112 |
404 |
Target customer not found |
||
171121 |
404 |
Reward claim not found |
||
171122 |
400 |
Reward is not transferable |
||
171131 |
400 |
Can’t share this reward more than %s times |
The reward transfer limit has been reached. Change the value in the Backoffice |
|
191020 |
404 |
Tenant not found |
||
191021 |
404 |
Tenant is not active |
Activate the tenant in the store module in the Backoffice |
|
191022 |
No pin given |
|||
191023 |
400 |
User not found or is inactive |
Check the User ID and/or active the User |
|
191024 |
400 |
No username given! |
Provide a username in the API request |
|
191025 |
400 |
No password given! |
Provide a password in the API request |
|
191026 |
400 |
Username or password is empty! |
Check Username/Password and try again |
|
191027 |
400 |
Login failed: invalid credentials |
Check credentials and try again. |
|
191028 |
400 |
Api login is disabled for this user |
Activate API login for this user in the Backoffice |
|
210101 |
Transaction not found |
|||
210102 |
Transaction refund already exists |
|||
210103 |
Product does not exists within the given transaction. |
|||
210104 |
The given quantity is greater than the possibly refundable quantity. |
|||
210105 |
The quantity is cannot be 0 or less. |
|||
210106 |
Customer has not enough points to execute the refund. |
|||
210108 |
It is forbidden to refund a pending transaction. |
|||
210109 |
It is forbidden to refund an item which is part of a pending transaction. |
|||
210110 |
This transaction is not yet accepted so it cannot be refunded. |
|||
210111 |
This transaction is not yet accepted so it cannot be refunded. |
|||
210112 |
Invalid transaction status |
|||
210113 |
Unable to refund an unclaimed transaction |
Guest checkout events can not be refunded |
||
300110 |
Limit should be greater than zero |
|||
300111 |
Offset cannot be negative |
|||
300201 |
Request failed due to account mismatch. |
|||
300202 |
Account not defined. Please add the account property to the request or configure a default account. |
|||
300203 |
Request failed due to account mismatch. |
|||
300304 |
400 |
Descriptor does not exist |
||
300305 |
400 |
Entity ID is required parameter |
||
300410 |
Archiving of the customer list failed. Please use the delete endpoint for archiving. |
|||
300420 |
Status transition is not allowed from active to archived. |
|||
300503 |
Account does not have enough points |
|||
300601 |
Request failed, due to account mismatch |
Ensure that this event is sent with the same account used for the previously submitted related event. Alternatively, if left empty, the account property from the previous event will be used. |
||
300700 |
400 |
Entity type does not exist |
||
300701 |
400 |
Descriptor does not exist |
||
300703 |
400 |
Descriptor does not exist |
||
300704 |
400 |
Entity is not available as an API response |
||
300705 |
400 |
Entity is not available as an API response |
||
300706 |
400 |
Entity is not available as an API respons |
||
300707 |
400 |
Entity is not available as an API response |
||
300708 |
400 |
Entity not found |
||
300709 |
400 |
Entity not found |
||
310200 |
400 (bad request) |
Customer is not linked |
The customer is not linked to any other customers so they cannot be unlinked |
|
320501 |
404 |
Reward not found |
||
320502 |
400 |
The ‘payload’ field is not found or empty |
||
320503 |
400 |
The unique batch id provided already exist |
||
320504 |
400 |
There is already an unfinished bulk reward claim process for the reward submitted. |
||
320505 |
400 |
The list of customers exceeds the size limitation of the endpoint. |
||
320506 |
400 |
The metadata submitted is not valid: {key} |
||
320510 |
404 |
Batch ID is not found |
||
330501 |
404 |
Customer List not found |
||
330502 |
400 |
The ‘payload’ field is not found or empty |
||
330503 |
400 |
The list of customers exceeds the size limitation of the endpoint. |
||
330511 |
404 |
Customer List not found |
||
330512 |
400 |
The ‘payload’ field is not found or empty |
||
330513 |
400 |
The list of customers exceeds the size limitation of the endpoint. |
||
330521 |
404 |
Batch ID is not found |
||
330531 |
404 |
Batch ID is not found |
||
350300 |
400 |
Entity type does not exist |
||
350301 |
400 |
Descriptor does not exist |
||
350302 |
400 |
Descriptor does not exist |
||
350303 |
400 |
Descriptor does not exist |
||
911001 |
Transaction not found |
Check that the submitted transaction Id matches the transaction awaiting approval |
||
911004 |
400 |
Guest transaction can not have a customer. |
Remove the value from the customer property. |
|
911005 |
400 |
Transaction with customer can’t have a guest event. |
Customer property needs to have a value. |
* This is not strictly an error but results from the mechanism for making an event pending.