status

Object

Contains the status details of the vendor redemption.

-success

Boolean

Indicates if the request was successful.

-code

Integer

Status code of the response.

-message

String

Message describing the status of the response.

redemptionList

Array

List of vendor redemptions.

-id

Long

Unique ID of the vendor redemption.

-name

String

Name of the vendor redemption.

-enabled

Boolean

Indicates if the vendor redemption is enabled.

-responseKeys

Array

A list of response keys expected from the vendor API.

-lastUpdatedOn

Long

Indicates the timestamp when the vendor redemption was updated. The timestamp is in Epoch time format.

-lastUpdatedOnDateTime

String

Indicates the date and time when the vendor redemption was updated, formatted in ISO 8601

-redemptionType

String

Type of redemption (e.g. MILES).

-vendorId

long

The Unique identifier of the vendor whose information is being fetched.

-vendorName

string

The unique name of the vendor.

-createdBy

Long

The unique identifier of the user who created the vendor redemption.

-lastUpdatedBy

Long

The unique identifier of the user who last updated the vendor redemption record.

-createdOn

Long

Indicates the timestamp when the vendor redemption was created. The timestamp is in Epoch time format.

-createdOnDateTime

String

Indicates the date and time when the vendor redemption was created, formatted in ISO 8601.

-redemptionActionList

array

List of vendor redemptions fetched in the response.

--id

long

Unique ID of the vendor redemption.

--name

string

Name of the vendor redemption.

--enabled

boolean

Indicates if the vendor redemption is enabled.

--apiType

string

The HTTP method to be used for the API request.

--apiUrl

string

The URL to which the API request is made. For example, "apiUrl": "https://partial.com/reward/issue" specifies the endpoint where the request to issue a reward will be made.

--apiHeaders

object

An object containing the headers to be sent with the API request.

---Authorization

String

The authorization header containing the authentication credentials.

---Content-Type

String

The content type header indicating the format of the request body.

--apiBody

String

The API body for the external API endpoint specified in apiUrl. You can also include custom fields, fulfillment status, and reward transaction ID. The fulfillment status and reward transaction ID are variables resolved in the backend according to the associated transaction.
Custom Field: Enables brands to add additional data in the API request. Use the format customfield_customFieldName. For example, a custom field named "Address: Bangalore" should be written as customfield_Address then it will replace the value of custom field with Bangalore. Note: Only custom fields created with ISSUE_REWARD scope are supported. Fulfillment Status: Enables updating the fulfillment status. Use the parameter fulfillmentStatus, formatted in camelCase. Reward Transaction ID: Enables adding the reward transaction ID. This helps the vendor to identify the transaction associated with the issued reward. Use the parameter rewardTransactionId, formatted in camelCase. NOTE: The API body supports other parameters that can be included based on the brand's specific requirements or integration needs. Internal Capillary APIs can also be used.

--execOrder

Integer

The execution order of the action.

--contextKeys

Object

An object containing context keys for extracting values from the response.

--retryAction

Boolean

Indicates whether the action should be retried on failure (true/false).

actionCount

Integer

Number of actions configured for this redemption setup.