> ## Documentation Index
> Fetch the complete documentation index at: https://developer.ongoody.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Event: order.gift_opened

> Emitted when a gift is first opened. Note that if you open the gift link yourself, you might trigger this event.

## Example

```json theme={null}
{
  "event_type": "order.gift_opened",
  "id": "ad097c47-bf12-45c9-8feb-0536a0012c09",
  "data": {
    "id": "10c588dd-d566-45bf-86e9-c23bd1f1587b",
    "status": "opened",
    "individual_gift_link": "https://gifts.ongoody.com/gift/vWtUe8lQRJuoyYzKlYeHMkbV",
    "recipient_first_name": "Alena",
    "recipient_last_name": "Kenter",
    "recipient_email": "alena@ongoody.com",
    "card_id": "ae4cb4ce-75fc-4782-a9ab-2f30d9b7b41d",
    "message": "Thank you!",
    "thank_you_note": null,
    "view_count_recipient": 0,
    "is_swapped": false,
    "order_batch_id": "4133078a-c35f-441e-8e92-57645342b299",
    "expires_at": null,
    "cart": {
      "id": "39b04e91-6a40-468d-8ed4-f59e9059afae",
      "items": [
        {
          "id": "d59dead0-a44c-44df-885f-030612038a48",
          "quantity": 1,
          "product": {
            "id": "c399bafb-3fbc-40c5-bef3-9158b7a19abc",
            "name": "Cookies",
            "brand": {
              "id": "db631527-c59c-409c-823f-42a24c972283",
              "name": "Cookie Company"
            }
          }
        }
      ]
    },
    "shipments": [],
    "amounts": {
      "amount_product": 1000,
      "amount_shipping": 1000,
      "amount_processing_fee": 100,
      "amount_pre_tax_total": 2100,
      "amount_tax": null,
      "amount_total": null,
      "amount_global_relay_cost": null
    },
    "sender": {
      "first_name": "Test",
      "last_name": "User",
      "email": "15556038009@test.ongoody.com"
    },
    "workspace_id": "8779bb01-ca47-4e9e-a845-d05f509c4be3",
    "workspace_name": "Test Team",
    "original_cart": null,
    "original_amounts": null,
    "reference_id": "PCI7GLZ3KFIEN8MWWSD5LDCF"
  }
}
```

## Schema

**event\_type** `string` *required*

The type of event that occurred

**event\_id** `string` *required*

The unique ID for this event

**data** `object`

An individual order contains the gift link to be sent to the recipient (if applicable) and other information about the order.

**properties**

**id** `string\<uuid\>` *required*

**recipient\_first\_name** `string` *required*

**recipient\_last\_name** `string`

**recipient\_email** `string`

**status** `string` *required*

Allowed values: `created` `notified` `opened` `accepted`
`pending_payment` `paid` `ordered` `shipped` `delivered` `failed`
`canceled`

**individual\_gift\_link** `string` *required*

This gift link can be sent to the recipient or shared with the sender.
For privacy reasons, this gift link does not display tracking
information. A separate link, the recipient link, is sent directly to
the recipient after they accept their gift, which does contain
tracking information.

**cart** `object` *required*

The cart currently on this order. If the order is a gift that was
swapped, `cart` displays the most recent products selected (i.e.
post-swap).

**properties**

**id** `string\<uuid\>` *required*

**items** `array[object]`

**properties**

**id** `string\<uuid\>` *required*

**product** `object` *required*

**properties**

**id** `string\<uuid\>` *required*

**name** `string` *required*

**brand** `object` *required*

The brand that this product is from.

**properties**

**id** `string\<uuid\>` *required*

**name** `string` *required*

**quantity** `integer` *required*

**shipments** `array[object]` *required*

A list of the shipments for the order.

**properties**

**id** `string\<uuid\>` *required*

**status** `string` *required*

Allowed values: `pending` `tracking` `shipped` `delivered` `delivered_override` `failed` `failed_unset_tracking` `failed_with_reship`

**brand\_name** `string` *required*

The name of the brand that this shipment is from

**tracking\_carrier** `string`

The carrier for this shipment, e.g. UPS.

**tracking\_number** `string`

Only for approved distribution partners.

**shipped\_at** `string\<date-time\>`

ISO 8601

**delivered\_at** `string\<date-time\>`

ISO 8601

**delivery\_eta** `string\<date-time\>`

The estimated delivery time of this shipment.

**workspace\_id** `string\<uuid\>`

Organizations are sub-divided into workspaces. Orders are contained in workspaces, identified by this ID.

**workspace\_name** `string`

**expires\_at** `string\<date-time\>`

For gifts, the date and time the gift is set to expire.

**card\_id** `string`

The digital greeting card on this gift.

**message** `string`

The message in this gift, provided by the sender.

**thank\_you\_note** `string`

A thank you note sent by the recipient.

**view\_count\_recipient** `integer`

The number of times the recipient viewed the gift.

**is\_swapped** `boolean`

If this gift was swapped by the recipient. Swapping allows a recipient to select another product or products, which replaces the `cart`. The original products are saved to `original_cart`.

**order\_batch\_id** `string\<uuid\>`

On Goody for Business, all orders are attached to a order batch, which is a collection of one or more orders.

**amounts** `object` *required*

Costs in USD cents (i.e. \$1.00 = 100). If the order was swapped, `amounts` displays the most recent amounts (i.e. post-swap).

**properties**

**amount\_product** `integer` *required*

Total cost of the products in this order.

**amount\_shipping** `integer` *required*

Total cost of shipping for this order.

**amount\_processing\_fee** `integer`

Total cost of processing fees for this order.

**amount\_credit\_applied** `integer`

Total amount of credit applied to this order.

**amount\_pre\_tax\_total** `integer` *required*

Total cost of the products, shipping, and processing fees in this order.

**amount\_tax** `integer`

Total tax for this order.

**amount\_total** `integer`

Total cost of the products, shipping, processing fees, tax, and global shipping costs in this order.

**amount\_global\_relay\_cost** `integer`

Total cost of global shipping for this order through the Global Relay service.

**event\_times** `object`

Only provided when calling the /orders/:id endpoint.

**properties**

**created\_at** `string\<date-time\>` *required*

ISO 8601

**notified\_at** `string\<date-time\>`

When the recipient was notified of the order.

**opened\_at** `string\<date-time\>`

For gifts, when the recipient opened the order.

**accepted\_at** `string\<date-time\>`

For gifts, when the recipient accepted the order.

**pending\_payment\_at** `string\<date-time\>` *required*

When the order entered pending payment status.

**paid\_at** `string\<date-time\>`

When the order was paid for.

**shipped\_at** `string\<date-time\>`

When the order was first shipped. If there are multiple shipments, this is when the first shipment shipped.

**delivered\_at** `string\<date-time\>`

When the order was delivered. If there are multiple shipments, this is when all shipments were delivered.

**original\_cart** `object`

If this order is a gift that was swapped, this displays the original cart that was sent to the recipient.

**properties**

**id** `string\<uuid\>`

**items** `array[object]`

**properties**

**id** `string\<uuid\>` *required*

**product** `object` *required*

**properties**

**id** `string\<uuid\>` *required*

**name** `string` *required*

**brand** `object` *required*

The brand that this product is from.

**properties**

**id** `string\<uuid\>` *required*

**name** `string` *required*

**quantity** `integer` *required*

**original\_amounts** `object`

If this order is a gift that was swapped, this displays the original amounts of the cart that was sent to the recipient.

**properties**

**original\_amount\_product** `integer`

**original\_amount\_shipping** `integer`

**original\_amount\_credit\_applied** `integer`

**original\_amount\_pre\_tax\_total** `integer`

**sender** `object` *required*

The Goody user who sent this order.

**properties**

**first\_name** `string` *required*

**last\_name** `string` *required*

**email** `string` *required*

**reference\_id** `string` *required*

The reference ID displayed on receipts and other locations as the ID for this order.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.