Error codes specific to Recommendations

The following error codes are returned if the API is unable to fetch recommendations:

A sample error code displayed in the response is as follows:

{
   "code": "5136",
   "message": "Not allowed to fetch Recommendations for Country Code GB",
   "additionalDetails": [],
   "invalidFields": []
}

In addition to these, standard error codes may also be returned for general failure scenarios:

Error codes for other APIs that fetch recommendations

Recommendations may also be returned as part of other APIs, such as GET Subscription, Order Preview, etc. Two key error scenarios can occur:

1. Failure in the core API functionality
2. Core API succeeds, but fetching recommendations fails

The HTTP status code reflects the outcome of the core API:

• If the core API fails, a 4xx or 5xx status code is returned.
• If the core API succeeds but recommendations fail, a 2xx status code is returned, and the error is included in the recommendations section of the response.

Example: Core API functionality failure:

HTTP Code: 4xx or 5xx

{
   "code": "2125",
   "message": "Distributor not allowed to sell in the currency for the region",
   "additionalDetails": [],
   "invalidFields": []
}

Example: Core API succeeds, but recommendation retrieval fails

HTTP Code: 2xx, Success

{
   // Order Preview Details
   "orderId": "ABCDORDER1",
   "...":"...",
   
   // Recommendations - New Addition
   "recommendations": {
      "errorDetails": {
         "code": "5136",
         "message": "Not allowed to fetch Recommendations for Country Code GB",
         "additionalDetails": [],
         "invalidFields": []
      }
   }
}