Get line items

referenceOrderID

string

A unique identifier for an order

externalRefID

string

specifies the external reference order ID

utid

string

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

ptid

string

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 Links.

etid

string

The unique identifier for the email template. Only applicable when sendEmail = true.

status

string

The line item status to be retrieved for each line item. See Line item status The available values are:

• COMPLETE
• PENDING
• FAILED
• CANCELLED

emailStatus

string

The email status to be retrieved for each line item. The email can only be sent if deliveryMethod=EMAIL . The available values for email status are: DELIVERED, NOT_DELIVERED, PENDING, SENT, DEFERRED, DROPPED, BOUNCE, and BLOCKED.

deliveryMethod

string

Specify the delivery method for an order to determine how a reward is sent to a recipient:

• NONE: Tango does not deliver. You are responsible to deliver the rewards to your recipient. This option is similar to sendEmail=false.

• EMAIL: Tango delivers the reward to the recipient via email. You must include the recipient email. This option is similar to sendEmail=true.

• PHONE: Tango delivers the reward to the recipient via text. You must include the recipient phone number.

• ADDRESS: Tango delivers the physical rewards via a carriers such as the post office, FexEx, UPS, etc. You must include the recipient address.

• EMBEDDED: You will embed Tango's lading page into your application. Tango will not deliver the rewards.

• BULKSHIPMENT(🚧 Coming soon): Send a batch of physical rewards to Tango for delivery. You must provide a validated list of recipient addresses. Tango will handle the shipping via carriers, but is not responsible for incorrect or incomplete address information.

deliveryStatus

string

Includes the delivery status to be queried. The available values are: PENDING, PROCESSING, DISPATHCHED, DELIVERED, and FAILED.

orderStatus

string

The order status to be retrieved for each line item. See order status . The available values are: COMPLETE, PENDING, FAILED, CANCELLED, and PARTIAL.

orderSource

string

The order source to be retrieved for each line item. The available values are:

• RA: The rewards are sent through Tango API. Tango API users see the two-letter identifiers when they use: -GET {URI}/lineItem under "OrderSource
  • GET {URI}/orders/{referenceOrderID} under "orderClientSource"
• RG: The rewards are sent through Tango portal by email or mail delivery.
• BE: The rewards are sent through Blast External (BE) or bulk upload for 15-50,000 recipients per order.
• BI: Orders placed using bulk-internal upload.
• CI: Rewards are sent manually by the Tango Orders team. Contact your Customer Success Manger (CSM) or [email protected] if you are interested in working with the Tango Orders team to send rewards.
• QW: Rewards Links are sent via Qualtrics (QW) or Tango integration. Contact your Customer Success Manger (CSM) or [email protected] if you are interested in integrating Tango with Qualtrics.

recipientEmail

string

A recipient's email address. It returns Line Items across all orders.

recipientMobileNumber

string

Specify the recipient mobile number to be queried. MobileNumber is required if deliveryMethod is PHONE. The following validation rules apply to mobile numbers for Mobile delivery:

• Country Code: Must be included.
• Format: +CCCPPPPPPPPPPPP (where C is the country code, 1-3 digits, and P is the phone number, up to 12 digits).
• Initial Release: Only accepts US phone numbers (Country code = +1) and 10 digits for the phone number. -Standard: Follows ITU E.164, allowing (+) and up to 15 digits for the combined country code and phone number.

recipientFirstName

string

The recipient’s first name. It returns Line Items across all orders. The string can have up to 100 characters.

recipientLastName

string

The recipient’s last name. It returns Line Items across all orders. The string can have up to 100 characters.

accountIdentifier

string

The account identifier used to place an order. It returns Line Items across all orders (5-100 characters).

campaign

string

Specify the campaign to be queried. The maximum length is 1024 characters including the special characters such as @, #, %, etc.

purchaseOrderNumber

string

Specify the purchaseOrderNumber to be queried.

orderNotes

string

Specify the orderNotes to be queried.

recipientStreetLine1

string

Specify the recipientStreetLine1 to be queried.

recipientStreetLine2

string

Specify the recipientStreetLine2 to be queried.

recipientCity

string

Specifty the recipientCity to be queried.

recipientStateOrProvince

string

Specify the recipientStateOrProvince to be queried.

recipientPostalCode

string

Specify the recipientPostalCode to be queried.

recipientCountry

string

Specify the recipientCountry to be queried.

startDate

string

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

endDate

string

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

columnSortName

string

Specifies the column name to sort by:

• accountNumber: The account the order was placed from. See account numbers.
• amountIssued: The order amount
• dateIssued: (default), the date and time the order was placed.
• emailStatus: The reward email status such as delivered, not delivered, pending, etc. See Email status.
• deliveryMethod: Use the deliveryMethod such as NONE, EMAIL, PHONE, ADDRESS, etc. to determine how a reward is sent to a recipient. -externalReferenceId: An optional idempotent field. Tango allows one unique order per External Reference ID. See Idempotent external Reference ID.
• status:
• orderSource: Such as RA (Tango API), RG (Tango portal), etc. See above.
• orderStatus: Such as complete, pending, failed, etc. See above.
• recipientFirstName: The recipient’s first name up to 100 characters.
• recipientLastName: The recipient’s last name up to 100 characters.
• rewardName:(If columnSortName is not specified, it sorts by dateIssued.)

columnSortAscending

boolean

-Truesorts by ascending order for the column specified in columnSortName.

• Falsesorts by descending order for the column specified in columnSortName.
• If columnSortName is not specified, it sorts by dateIssued.

elementsPerBlock

int32

Specifies the number of elements returned by page.

pagePrevious

boolean

• True returns the previous page
• False returns the next page

pageKeys

array of strings

This filter uses keyset paging. To move to the next page, use the nextPageKeys object from the keySetPage object. The nextKeyPage object is an array of two strings.