Documentation

Manage orders

Suggest Edits

You can incentivize your employees and customers by sending digital rewards. Using Tango API, you can send rewards to recipients, get the list of orders placed under your platform, and resend reward emails.

📘

Note:

  • Retrieve delivered rewards using GET {URI}/orders/{referenceOrderId} if you've delivered the reward credentials directly to your recipients, or if you don't wish Tango to deliver them.
  • If you're handling reward delivery by using sendEmail=false, we highly recommend including the refOrderID from the POST order response body to your recipients. The refOrderID is the unique identifier for all items ordered via Tango. Without the refOrderID, we cannot tie a specific reward to a recipient.
  • If you submit a recipient firstName and emailAddress with a Promo Link order ( See Choice products) when sendEmail=false, Tango will send out the reminder emails and the reactivation emails when the Promo Link is reactivated from the Tango portal. See About Promo Link™.

Delivery method (🚧 Coming soon)

The delivery method parameter is used to specify how a reward should be delivered to the recipient. A recipient can also switch delivery methods, such as from email to SMS or vice versa, after the reward has already been sent.

We support different types of delivery such as email, SMS, and more.

📘

Note:

  • Delivery was previously controlled using the sendEmail flag such as sendEmail=true or sendEmail=false. However, deliveryMethodwill soon replace the sendEmail parameter to provide a more flexible approach. If an original order was delivered via EMAIL, you can choose to resend using SMS. To learn more about resending rewards, see our topic Resend a specific order.
  • For international delivery, WhatsApp will be used to send rewards. Make sure your recipients have WhatsApp installed on their phone to receive SMS rewards.

We support the following delivery methods:

Delivery methodDescription
NoneTango does not deliver the reward in this mode. You are responsible for delivering the reward to the recipient. This behavior is equivalent to setting sendEmail=false.
EmailTango delivers the reward to the recipient via email when deliveryMethod is set to Email. In this case the recipient.email field is required.
Note: The legacy sendEmail=true flag has previously controlled this behavior. However, sendEmail is being deprecated and will be replaced with deliveryMethod field. Once the deliveryMethod is released sendEmail will only appear in the payload.
-If sendEmail=false, Tango does not send the reward email. You're responsible for delivering the reward.
-If sendEmail=true, Tango does send the reward email to the recipient.
SMSTango delivers the reward to the recipient via SMS when the deliveryMethod is set to SMS. In this case, the recipientMobileNumber is required if deliveryMethod=SMS. The following validation rules apply to mobile numbers for SMS 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 US phone numbers are supported: (Country code is +1 and 10 digits for the phone number.)
-Standard compliance: Follows ITU E.164, allowing a maximum of 15 digits including the + sign..
CarrierTango delivers the physical rewards via a carriers such as the post office, FexEx, UPS, etc. You must include the recipient address. When ordering a physical gift card, validate the physical address of your reward recipients before sending it to Tango. Tango does not accept any responsibilities for incorrect addresses.
EmbededYou will embed Tango's lading page into your application. Tango will not deliver the rewards.

📘

Note:

Digital orders do not require a shipping address. Including an address for digital orders will result in a validation error.

Order status

The order status indicates the current state of a reward order. This helps you track whether a reward has been successfully processed, is pending, or encountered an issue. An order status affects all rewards in the order.

Here are the available statuses in Tango API for orders:

StatusDescription
CompleteThe order is processed, and all rewards in the order have been sent. See line item status.
PendingThe order needs a little longer to process. Pending orders should be processed and delivered within one (1) business day. Orders placed on Friday afternoon or over the weekend may be processed on the following Monday or the next business day. Once the order is delivered, its status changes to Complete.
Note: Your order may take longer to review for a variety of reasons. See why your order is being reviewed. Contact your Customer Success Manager (CSM) or [email protected] with questions or concerns. to open a support case with Tango, use the Chat agent at the bottom right of the screen to open a support case with Tango.
PartialSome of the line items in the order are processed successfully while others have not. Check the specific line item status and determine which rewards were sent or failed.
FailedThe entire order is unable to be sent. Your account is refunded for the total value of the order. We recommend sending rewards again to ensure your rewards are still sent. See Resend a specific order.

For more information on why your order is failed, see the Tango Reward Status page, or email your Customer Success Manager (CSM) or [email protected] . Make sure you include the Reference Order ID of your failed order.

Updated 19 days ago

What’s Next

© 2025 Tango API are provided by Tango, a division of BHN, Inc.