Example
{
"event_type": "order.canceled",
"id": "ad097c47-bf12-45c9-8feb-0536a0012c09",
"data": {
"id": "8999f804-d731-440d-a67d-35444c12c493",
"status": "failed",
"individual_gift_link": "https://gifts.ongoody.com/gift/IsDyQQWtqrOyGPgZ9bVm6ptz",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "7e79fd96-212b-4468-9989-57b896ca22f4",
"message": "Thank you!",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "d158184c-6b31-4a72-b39f-8f8ca04ecbdd",
"expires_at": null,
"cart": {
"id": "3ff7dab1-ae03-4b20-a2c8-82a3f3326b83",
"items": [
{
"id": "284dc74f-a2c4-4b62-bfe5-94c464d56ea7",
"quantity": 1,
"product": {
"id": "10227d72-c355-4881-8007-aad34f501055",
"name": "Cookies",
"brand": {
"id": "fe370ec6-1208-4d23-b936-de857ceeae6d",
"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": "15551494889@test.ongoody.com"
},
"workspace_id": "dfe0d5cb-2c98-4800-a950-b40cca509250",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "2MUPN0YMGIDT7TJNPPFPB7WE"
}
}
Schema
string
required
The type of event that occurred
string
required
The unique ID for this event
object
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
string<uuid>
required
string
required
string
string
string
required
Allowed values:
created notified opened accepted
pending_payment paid ordered shipped delivered failed
canceledstring
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.
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).array[object]
required
A list of the shipments for the order.
Show properties
Show properties
string<uuid>
required
string
required
Allowed values:
pending tracking shipped delivered delivered_override failed failed_unset_tracking failed_with_reshipstring
required
The name of the brand that this shipment is from
string
The carrier for this shipment, e.g. UPS.
string
Only for approved distribution partners.
string<date-time>
ISO 8601
string<date-time>
ISO 8601
string<date-time>
The estimated delivery time of this shipment.
string<uuid>
Organizations are sub-divided into workspaces. Orders are contained in workspaces, identified by this ID.
string
string<date-time>
For gifts, the date and time the gift is set to expire.
string
The digital greeting card on this gift.
string
The message in this gift, provided by the sender.
string
A thank you note sent by the recipient.
integer
The number of times the recipient viewed the gift.
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.string<uuid>
On Goody for Business, all orders are attached to a order batch, which is a collection of one or more orders.
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).Show properties
Show properties
integer
required
Total cost of the products in this order.
integer
required
Total cost of shipping for this order.
integer
Total cost of processing fees for this order.
integer
Total amount of credit applied to this order.
integer
required
Total cost of the products, shipping, and processing fees in this order.
integer
Total tax for this order.
integer
Total cost of the products, shipping, processing fees, tax, and global shipping costs in this order.
integer
Total cost of global shipping for this order through the Global Relay service.
object
Only provided when calling the /orders/:id endpoint.
Show properties
Show properties
string<date-time>
required
ISO 8601
string<date-time>
When the recipient was notified of the order.
string<date-time>
For gifts, when the recipient opened the order.
string<date-time>
For gifts, when the recipient accepted the order.
string<date-time>
required
When the order entered pending payment status.
string<date-time>
When the order was paid for.
string<date-time>
When the order was first shipped. If there are multiple shipments, this is when the first shipment shipped.
string<date-time>
When the order was delivered. If there are multiple shipments, this is when all shipments were delivered.
object
If this order is a gift that was swapped, this displays the original cart that was sent to the recipient.
object
object
required
string
required
The reference ID displayed on receipts and other locations as the ID for this order.