Generate Affected Response API

As part of the generation of records, a cachedAPIChangeEntryId query parameter generates the cache data for the change entry Id passed in the input.

This call is required if the generateAction node is present in the response from Get Affected Cache. If you have at least one offer availability change based on the response you received from the Get Affected Cache, then you must execute certain populate cache APIs again using the catalog codes provided in the response. For example, you may receive the generateAction asking you to perform five of the populate cache APIs with the catalog code AS_hierarchywithpromotion.

The Generate Affected Response API:

  • Checks if the Id is valid and the corresponding cachedAPIChangeEntryId record is unprocessed.

  • Gets the cachedAPIchange Id and checks if the dependent change entry is processed. If not, then the API throws an error to indicate that the dependent records are not processed.

  • If the generation is successful, the API marks the cachedAPIChangeEntryId record as processed.

This is the predefined sequence for specific types of records to generate:

Sequence for the itemTypePriority
dataProfileResultItem1
ruleSetCombinationResultItem2
contextDimensionsResultItem3
contextCombinationsResultItem4
catalogCtxEligibilityResult5
offerItem6
hierarchyResult8
priceResult9
itemDetails10
bundleWrapper11
promotionWrapper11
item12
orderConfiguration13

For example, if you execute changeEntryId for bundle wrapper with sequence 11, but there is an unprocessed ChangeEntryId in the cachedAPIChange entry table for itemDetails with sequence 10 for the same offer, then an error occurs for violating the dependency check. You can obtain the ChangeEntryId required as a query parameter in the API from the Affected Cache API records.regenerateAction.bundleWrapper.params.ChangeEntryId node.

An action node contains the request format in the REST Node. These are the action node fields:

Action Node FieldsDescription
requestBodyIndicates if there are any request bodies to provide in the respective API.
paramsIndicates if there are any query parameters to provide in the respective API.
linkSpecifies the API URI to invoke the service.
methodIndicates if the respective API is a GET or POST request.
HeaderDescription
Content-Typeapplication/json
CodeDescription
200OK
500Internal Server Error