---
title: "Get line items"
method: GET
path: "/lineItems"
tags: ["8. Line Items"]
---

# Get line items

`GET /lineItems`

Get a list of Line Items placed under this Platform.

## Query parameters

- `referenceOrderID` string
- `externalRefID` string
- `utid` string
- `ptid` string
- `etid` string
- `status` 'COMPLETE' | 'PENDING' | 'FAILED' | 'CANCELLED'
- `emailStatus` 'DELIVERED' | 'NOT_DELIVERED' | 'PENDING' | 'SENT' | 'DEFERRED' | 'DROPPED' | 'BOUNCE' | 'BLOCKED'
- `deliveryMethod` 'NONE' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'EMBEDDED' | 'BULKSHIPMENT' | 'QRCODE' | 'BULKDIGITAL' | 'EMBEDDED_COMPONENT' | 'WHATSAPP'
- `deliveryStatus` 'PENDING' | 'PROCESSING' | 'DISPATCHED' | 'DELIVERED' | 'FAILED' | 'ENGAGED'
- `orderStatus` 'COMPLETE' | 'PENDING' | 'FAILED' | 'CANCELLED' | 'PARTIAL'
- `orderSource` 'RA' | 'RG' | 'BE' | 'BI' | 'CI' | 'QW' | 'AA'
- `recipientEmail` string
- `recipientMobileNumber` string
- `recipientFirstName` string
- `recipientLastName` string
- `accountIdentifier` string
- `campaign` string
- `purchaseOrderNumber` string
- `orderNotes` string
- `recipientStreetLine1` string
- `recipientStreetLine2` string
- `recipientCity` string
- `recipientStateOrProvince` string
- `recipientPostalCode` string
- `recipientCountry` string
- `startDate` string
- `endDate` string
- `columnSortName` 'accountNumber' | 'amountIssued' | 'dateIssued' | 'emailStatus' | 'deliveryMethod' | 'externalReferenceId' | 'status' | 'orderSource' | 'orderStatus' | 'recipientFirstName' | 'recipientLastName' | 'rewardName'
- `columnSortAscending` string
- `elementsPerBlock` integer
- `pagePrevious` boolean
- `pageKeys` string[]
- `minRemainingBalance` number
- `maxRemainingBalance` number
- `hasRemainingBalance` boolean

## Response `200`

OK

- LineItemListView
  - `keysetPage` KeysetPageView, required
    - `nextPageKeys` string[], required
    - `previousPageKeys` string[], required
    - `resultCount` integer, required
    - `totalCount` integer, required
  - `lineItems` LineItemView[], required
    - `referenceLineItemID` string, required
    - `externalReferenceLineItemID` string
    - `referenceOrderID` string, required
    - `orderSource` string, required
    - `status` string, required
    - `orderStatus` string, required
    - `emailStatus` string, required
    - `deliveryMethod` string
    - `deliveryStatus` string
    - `rewardStatus` string
    - `canCancel` boolean
    - `canFreeze` boolean
    - `lineNumber` integer, required
    - `rewardName` string, required
    - `amountIssued` MoneyView, required
      - `value` number
      - `currencyCode` string
      - `exchangeRate` number
      - `fee` number
      - `total` number
    - `amountCharged` MoneyView
      - `value` number
      - `currencyCode` string
      - `exchangeRate` number
      - `fee` number
      - `total` number
    - `remainingBalance` number
    - `dateIssued` string, date-time, required
    - `expirationDate` string, date-time, required
    - `accountNumber` string, required
    - `accountIdentifier` string, required
    - `etid` string, required
    - `ptid` string
    - `utid` string, required
    - `customerIdentifier` string, required
    - `recipient` RecipientInfoView
      - `firstName` string
      - `lastName` string
      - `email` string
      - `mobileNumber` string
      - `address` RecipientAddressView
        - `companyName` string
        - `streetLine1` string
        - `streetLine2` string
        - `city` string
        - `stateOrProvince` string
        - `postalCode` string
        - `country` string
    - `sender` SenderInfoView
      - `firstName` string
      - `lastName` string
      - `email` string
    - `purchaseOrderNumber` string
    - `campaign` string
    - `orderNotes` string
    - `lineItemActionReason` string
    - `reissuedFromReferenceLineItemId` string — Reissued from reference line item ID
    - `reissuedToReferenceLineItemId` string — Reissued to reference line item ID
    - `lineItemErrors` LineItemErrorDTO[] — Errors related to the line item
      - `error_code` string
      - `error_message` string
    - `quantity` integer — quantity of line items

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/tangocard/apis/tango-api.md) · [All operations](https://skmtc.net/tangocard/apis/tango-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tangocard/tango-api/versions/324ad9683921/schema)