Order category events

The following webhook event is currently supported under Order category as a Closed release:

Line item delivery status for physical gift cards

Tango supports line item delivery status for physical gift cards. Subscribing to the LineItemDeliveryStatus event ensures that you receive timely notifications when a line item delivery status changes, such as from In Progress to Shipped, etc. To subscribe to line item delivery status events, create a subscription using POST {URI}/webhooks , Then select LineItemDeliveryStatusfor the event type and ORDERfor the category.

Use case

Acme, a wellness incentive company, wants to know the delivery status of a line item. Using LineItemDeliveryStatus event, Acme receives a notification when the status changes.

List of line item delivery statuses

The following statuses may be returned with thelineItemDeliveryStatus:

Line item delivery status	Description
IN_PROGRESS	The order is currently processing.
SHIPPED	The order has shipped.
COMPLETED	The order was completed and fulfilled successfully. This is the final status for a successfully delivered order.
CANCELED	Your order was canceled before fulfillment.
FAILED	The line item has failed and cannot be sent. Not all the records in the order could be funded, reserved, or processed. The order has not been fulfilled or was declined before being fulfilled. An order using a real-time API failed. This is a final status. The order must be resubmitted. The order payment could not be completed. The order has not been fulfilled. An error was encountered when placing the order. The order was not fulfilled.

When creating a subscription for line item delivery status, use thePOST {URI}/webhooks and enter the following values:

Body Params	Type	Description
url	string	Enter the URL of your webhook listener. It must be a valid URL. (Required)
categories	array of strings	Enter `ORDER` for categories. This field is optional if you're specifying eventTypes.
eventTypes	array of strings	Enter `LineItemDeliveryStatus` for eventTypes. (Optional if you're specifying categories.)

Here is a response payload of LineItemDeliveryStatus:

{
  "eventId": "2e3b91ba-4d6a-43b5-8e77-3b31e3f938b3",
  "revision": 4,
  "category": "ORDER",
  "eventType": "LineItemDeliveryStatus",
  "eventOccurredAt": "2024-06-17T17:10:00.759273600Z",
  "eventData": {
    "referenceLineItemId": "RA240828-128134-15-1",
    "status": "In Process"
  }
}

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

201 Created
400 Bad Request
401 Unauthorized