Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2473175248.0 KB
8. Line Items

Get line items

Get a list of Line Items placed under this Platform.

get/lineItems

Query parameters

referenceOrderIDstring

Specify the reference order ID to be queried.

externalRefIDstring

Specify the external reference order ID to be queried.

utidstring

The unique identifier for the reward as provided in the Get Catalog call

ptidstring

The unique identifier for the Print Reward Link Template provided in the Tango Portal on the Printed Template page. Only applicable when sending a Printed Reward Link.

etidstring

The unique identifier for the electronic template. Only applicable when deliveryMethod is EMAIL or PHONE

status'COMPLETE' | 'PENDING' | 'FAILED' | 'CANCELLED'

Specify the line item status to be queried.

emailStatus'DELIVERED' | 'NOT_DELIVERED' | 'PENDING' | 'SENT' | 'DEFERRED' | 'DROPPED' | 'BOUNCE' | 'BLOCKED'

Specify the email status to be queried.

deliveryMethod'NONE' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'EMBEDDED' | 'BULKSHIPMENT' | 'QRCODE' | 'BULKDIGITAL' | 'EMBEDDED_COMPONENT' | 'WHATSAPP'

Specify the delivery method to be queried.

deliveryStatus'PENDING' | 'PROCESSING' | 'DISPATCHED' | 'DELIVERED' | 'FAILED' | 'ENGAGED'

Specify the delivery status to be queried.

orderStatus'COMPLETE' | 'PENDING' | 'FAILED' | 'CANCELLED' | 'PARTIAL'

Specify the order status to be queried.

orderSource'RA' | 'RG' | 'BE' | 'BI' | 'CI' | 'QW' | 'AA'

Specify the order source to be queried.

recipientEmailstring

Specify the recipient email address to be queried.

recipientMobileNumberstring

Specify the recipient mobile number to be queried.

recipientFirstNamestring

Specify the recipient first name to be queried.

recipientLastNamestring

Specify the recipient last name to be queried.

accountIdentifierstring

Specify the account identifier to be queried.

campaignstring

Specify the campaign to be queried.

purchaseOrderNumberstring

Specify the purchaseOrderNumber to be queried.

orderNotesstring

Specify the orderNotes to be queried.

recipientStreetLine1string

Specify the recipientStreetLine1 to be queried.

recipientStreetLine2string

Specify the recipientStreetLine2 to be queried.

recipientCitystring

Specify the recipientCity to be queried.

recipientStateOrProvincestring

Specify the recipientStateOrProvince to be queried.

recipientPostalCodestring

Specify the recipientPostalCode to be queried.

recipientCountrystring

Specify the recipientCountry to be queried.

startDatestring

specify the starting date or date time to be queried according to RFC 3339, i.e. "2016-01-01" or "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt

endDatestring

specify the ending date or date time to be queried according to RFC 3339, i.e. "2016-01-01" or "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt

columnSortName'accountNumber' | 'amountIssued' | 'dateIssued' | 'emailStatus' | 'deliveryMethod' | 'externalReferenceId' | 'status' | 'orderSource' | 'orderStatus' | 'recipientFirstName' | 'recipientLastName' | 'rewardName'

Specify the column name to sort by.

columnSortAscendingstring

Specify the sorting line-items ascending.

elementsPerBlockinteger

Specify the number of elements in a block.

pagePreviousboolean

Return the previous page instead of the next page.

pageKeysstring[]

Specify the page keys to query the next page.

minRemainingBalancenumber

Specify the minimum remaining balance to be queried.

maxRemainingBalancenumber

Specify the maximum remaining balance to be queried.

hasRemainingBalanceboolean

If true, return any line item that has a remaining balance.

Response

OK