Get shipping methods grouped by carrier

In the Tango API, a shipping method is the carrier service level used to deliver a physical order. The shippingMethod field specifies how a physical reward should be shipped to the recipient and tells Tango which delivery option to use (for example, Ground shipping, Next Day, or other supported carrier/service levels).

Each method includes a display label and an enumeration value. Show the label in your application and submit the corresponding enumeration value in the asynchronous line item’s shippingMethod field.

Endpoint

Use GET {URI}/shippingMethods to retrieve the methods available to your platform. Then display the appropriate label in your order flow and submit the corresponding enumeration when creating a physical delivery order:

Use case

Acme Health sends physical gift cards to employees who complete a wellness program. Before submitting an asynchronous order, Acme calls GET {URI}/shippingMethods to retrieve shipping methods grouped by carrier. Its application displays the returned service labels so an administrator can select an appropriate option.

If the selected method’s label is UPS Ground and its enumeration is upsground, Acme includes "shippingMethod": "upsground" in the physical reward line item.

Here is the workflow:

1. Retrieve shipping methods.
2. Display the returned labels and descriptions.
3. Select an appropriate method for the physical shipment.
4. Submit its enumeration value in the asynchronous line item’s shippingMethod field.

Example

The following example shows the response structure for GET {URI}/shippingMethods. The carriers array groups shipping methods by carrier. Each method includes a display label, an enumeration value to send as shippingMethod when creating an order, and a description with additional service details. The "string" values are placeholders.

{
    "carriers": [
        {
            "carrier": "UPS",
            "shippingMethods": [
                {
                    "label": "UPS Ground",
                    "enumeration": "upsground",
                    "description": "Delivery 3-5 business days after processing"
                }
             ]
         } 
    ]
}

Response fields

Use the following table to interpret the response from GET {URI}/shippingMethods. Display each method’s label to users and send its enumeration value in the line item’s shippingMethod field. The [] notation represents an item in an array.

For example, if a method has the label UPS Ground and enumeration upsground, display UPS Ground in your application and include "shippingMethod": "upsground" in the asynchronous order’s line item.

Sample shipping costs

Use the following sample costs to compare shipping options for physical rewards. Individual pricing applies only when the quantity is 1 and the shipping method is USPS First Class. The table includes bulk-pricing examples and a free individual USPS First Class option. “Not provided” means sample pricing or eligibility details are not listed.

Sample shipping-cost lookup

Select a carrier, shipping method, and reward quantity to look up a sample fee. The lookup includes the listed bulk rates and individual USPS First Class rate. It does not call the API or confirm shipping eligibility.

Response codes

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages: