TAtangocard
6. Orders

Create an Order under a specific Account.

Changed on
post/orders

Request

  • Base URL
    https://integration-api.tangocard.com/raas/v2
  • URL
    https://integration-api.tangocard.com/raas/v2/orders
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

externalRefIDstring

Optional. Idempotent field that can be used for client-side order cross reference and prevent accidental order duplication. Will be returned in order response, order details, and order history.

customerIdentifierstring required

Specify the customer associated with the order. Must be the customer the accountIdentifier is associated with.

accountIdentifierstring required

Specify the account this order will be deducted from

utidstring required

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

deliveryMethod'NONE' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'EMBEDDED' | 'EMBEDDED_COMPONENT' | 'WHATSAPP' required

Specify delivery method for the order

amountnumber required

Specify the face value of of the reward. Always required, including for fixed value items.

ptidstring

Only required for Printed Reward Links, the unique identifier for the Printed Reward Link Template provided in the Tango Portal on the Printed Template page.

emailSubjectstring

Optional. Used with deliveryMethod is EMAIL. The ETID email subject will be used for the specified reward if not specified.

messagestring

Optional gift message

sendEmailboolean

Deprecated Oct 1, 2025. Should Tango Card send the email to the recipient?

etidstring

Optional. Used with deliveryMethod of EMAIL or PHONE. The unique identifier for the electronic template you would like to use. If not specified, the system will use the default etid.

campaignstring

Optional. Campaign that may be used to administratively categorize a specific order. Must be between 0 and 1024 characters in length.

purchaseOrderNumberstring

The Purchase Order Number associated with this order.

notesstring

Optional order notes. Must be between 0 and 1024 characters in length.

expirationDatestring

Optional for Promo Links, the exact calendar date the Promo Link will expire.

customFieldsobject

Optional. A map of custom field key-value pairs configured at the account level for your platform. Only fields that have been configured for the account are accepted — any fields passed that are not configured will be silently ignored. Fields marked as required in the configuration must be provided; omitting a required field will result in a validation error. Fields marked as optional may be omitted. If no custom fields have been configured for the account, this property can be omitted entirely.

Example request

{
  "sendEmail": true,
  "etid": "E000000"
}

Response

OK / Existing order found for given external ref ID

referenceOrderIDstring required
referenceLineItemIDstring required
externalRefIDstring required
customerIdentifierstring required
accountIdentifierstring required
utidstring required
ptidstring
rewardNamestring required
emailSubjectstring required
messagestring required
sendEmailboolean
deliveryMethod'NONE' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'EMBEDDED' | 'BULKSHIPMENT' | 'QRCODE' | 'BULKDIGITAL' | 'EMBEDDED_COMPONENT' | 'WHATSAPP'
statusstring required
campaignstring required
purchaseOrderNumberstring
createdAtstring required
redemptionInstructionsstring

Changes

  • 04d5b0da2197Revision changes
    • breaking

      the / request property format changed from no format to email

    • breaking

      the / request property format changed from no format to email

    • warning

      the / request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 255