id
string
required
recipient_first_name
string
required
recipient_last_name
string | null
recipient_email
string | null
status
enum<string>
required
Available options:
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).

shipments
object[]
required

A list of the shipments for the order.

workspace_id
string | null

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

workspace_name
string | null
expires_at
string | null

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

card_id
string | null

The digital greeting card on this gift.

message
string | null

The message in this gift, provided by the sender.

thank_you_note
string | null

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

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).

event_times
object | null

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

original_cart
object | null

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

original_amounts
object | null

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

sender
object
required

The Goody user who sent this order.

payment_link
string | null

For commerce apps using Hosted Payment, the payment link for the gift with the credit card entry form. Available when the gift is in pending_payment status (after it has been accepted).

reference_id
string
required

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