Get details for a specific line item

Use the following endpoint to retrieve the details such as reward credentials of a specific line item and the redemption history. For the real-time balance of the reward, you can subtract the redemption history from the total amount issued:

Endpoint	Description
`GET {URI}/lineItems/{referenceLineItemID}`	Get details for a specific line item.

Here is a query parameter for when you call GET {URI}/lineItems/{referenceLineItemID} to get the line item details. The recipient address object is included in all returning payloads. The system autogenerates the identification, and you can find it by using the line item endpoint.

Query params	Data type	Description
referenceLineItemID	string	Reference line item ID is returned in the Line Items response.

The following example shows the payload when you callGET {URI}/lineItems/{referenceLineItemID} to get the details for a specific line item. The reward status indicates whether a reward is frozen or active.

📘
Note:
We have deprecated credentials . Use credentialList instead.

{
  "referenceLineItemID": "RG241106-131973-69-1",
  "referenceOrderID": "RG241106-131973-69",
  "orderSource": "RG",
  "status": "COMPLETE",
  "orderStatus": "COMPLETE",
  "emailStatus": "DELIVERED",
  "rewardStatus": "ACTIVE",
  "lineNumber": 1,
  "rewardName": "Reward Link Canada",
  "amountIssued": {
    "value": 1,
    "currencyCode": "CAD"
  },
  "amountCharged": {
    "value": 1,
    "currencyCode": "USD",
    "exchangeRate": 0.71981
  },
  "dateIssued": "2024-11-06T17:53:07.728Z",
  "accountNumber": "A19617569",
  "accountIdentifier": "A19617569",
  "etid": "E986593",
  "ptid": "",
  "utid": "U440575",
  "customerIdentifier": "G41979241",
  "recipient": {
    "email": "[email protected]",
    "firstName": "Sue",
    "lastName": "Johnson",
    "address": null
  },
  "sender": {
    "firstName": "Jane",
    "lastName": null,
    "email": null
  },
  "purchaseOrderNumber": "",
  "orderNotes": "",
  "reward": {
    "credentials": {
      "Expiration Date": "",
      "Redemption Link": "https://sandbox.rewardlink.io/r/1/xNdA_0tIJxKlAkq2Map4_VchdUpctr7Iu5Uk0XFGeQM"
    },
    "credentialList": [
      {
        "label": "Redemption Link",
        "value": "https://sandbox.rewardlink.io/r/1/xNdA_0tIJxKlAkq2Map4_VchdUpctr7Iu5Uk0XFGeQM",
        "type": "url",
        "credentialType": "redemptionUrl"
      },
      {
        "label": "Expiration Date",
        "value": "",
        "type": "date",
        "credentialType": "expirationDate"
      }
    ],
    "redemptionInstructions": "<p>Tango Choice rewards expire on the date stated on the Reward. Tango Choice rewards are issued to Reward Recipients without charge for loyalty, award, or promotional purposes, and are not sold to consumers. No fees apply to Tango Choice.</p><p><strong>How to Redeem </strong></p><ul><li><strong>Click the redemption link above to activate your Tango Choice. </strong></li><li><strong>Next, you will be able to claim your reward on your choice of retail gift cards and more. </strong></li></ul><p><strong>Please keep this notification, as the link in this notification is the only way to claim your reward value. The link may be used more than once if you choose to claim your Reward in parts.</strong></p><p> </p><p>Les récompenses Tango Choice expirent à la date indiquée sur la récompense. Les récompenses Tango Choice sont remises gratuitement aux bénéficiaires de récompenses à des fins de fidélité, de récompense ou de promotion, et ne sont pas vendues aux consommateurs. Aucun frais ne s'applique à Tango Choice.</p><p><strong>Comment échanger </strong></p><ul><li><strong>Cliquez sur le lien d'échange ci-dessus pour activer votre Tango Choice. </strong></li><li><strong>Ensuite, vous pouvez échanger votre récompense contre votre choix de carte-cadeau de détail et plus encore. </strong></li></ul><p><strong>Veuillez conserver cette notification, car le lien qui y figure est le seul moyen de réclamer la valeur de votre récompense. Le lien peut être utilisé plus d'une fois si vous choisissez de réclamer votre récompense en plusieurs parties.</strong></p>"
  },
  "redemptionHistory": []
}

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

The possible response codes for this endpoint are:

200 OK
400 Bad request
401 Unauthorized
403 Forbidden
404 Not Found

📘Note:

📘
Note: