Events
Event: order.shipped
Emitted when the order is shipped. If there are multiple shipments, this is emitted when the first shipment for this order is in transit.
You can access the list of shipments under the
shipments field. Note that for multi-shipment orders, when this order first enters the shipped state, the list of shipments might be incomplete since more shipments might be shipped later.
Example
Copy
Ask AI
{
"event_type": "order.shipped",
"id": "ad097c47-bf12-45c9-8feb-0536a0012c09",
"data": {
"id": "10c588dd-d566-45bf-86e9-c23bd1f1587b",
"status": "shipped",
"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": [
{
"id": "9a1a2003-bb03-4409-b7fd-243b2e600e46",
"status": "shipped",
"brand_name": "Cookie Company",
"tracking_carrier": "UPS",
"shipped_at": "2023-01-23T00:00:00Z",
"delivered_at": null,
"delivery_eta": "2023-01-26T00:00:00Z"
}
],
"amounts": {
"amount_product": 1000,
"amount_shipping": 1000,
"amount_processing_fee": 100,
"amount_pre_tax_total": 2100,
"amount_tax": 150,
"amount_total": 2250,
"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
The type of event that occurred
The unique ID for this event
An individual order contains the gift link to be sent to the recipient (if applicable) and other information about the order.
Show properties
Show properties
Allowed values:
created notified opened accepted
pending_payment paid ordered shipped delivered failed
canceledThis 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.
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).Show properties
Show properties
A list of the shipments for the order.
Show properties
Show properties
Allowed values:
pending tracking shipped delivered delivered_override failed failed_unset_tracking failed_with_reshipThe name of the brand that this shipment is from
The carrier for this shipment, e.g. UPS.
Only for approved distribution partners.
ISO 8601
ISO 8601
The estimated delivery time of this shipment.
Organizations are sub-divided into workspaces. Orders are contained in workspaces, identified by this ID.
For gifts, the date and time the gift is set to expire.
The digital greeting card on this gift.
The message in this gift, provided by the sender.
A thank you note sent by the recipient.
The number of times the recipient viewed the gift.
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.On Goody for Business, all orders are attached to a order batch, which is a collection of one or more orders.
Costs in USD cents (i.e. $1.00 = 100). If the order was swapped,
amounts displays the most recent amounts (i.e. post-swap).Show properties
Show properties
Total cost of the products in this order.
Total cost of shipping for this order.
Total cost of processing fees for this order.
Total amount of credit applied to this order.
Total cost of the products, shipping, and processing fees in this order.
Total tax for this order.
Total cost of the products, shipping, processing fees, tax, and global shipping costs in this order.
Total cost of global shipping for this order through the Global Relay service.
Only provided when calling the /orders/:id endpoint.
Show properties
Show properties
ISO 8601
When the recipient was notified of the order.
For gifts, when the recipient opened the order.
For gifts, when the recipient accepted the order.
When the order entered pending payment status.
When the order was paid for.
When the order was first shipped. If there are multiple shipments, this is when the first shipment shipped.
When the order was delivered. If there are multiple shipments, this is when all shipments were delivered.
If this order is a gift that was swapped, this displays the original cart that was sent to the recipient.
Show properties
Show properties
The reference ID displayed on receipts and other locations as the ID for this order.
Assistant
Responses are generated using AI and may contain mistakes.