Retrieve an order
Authorizations
Your Goody API key.
Path Parameters
id
Response
An individual order contains the gift link to be sent to the recipient (if applicable) and other information about the order.
created
, notified
, opened
, accepted
, pending_payment
, paid
, ordered
, shipped
, delivered
, failed
, canceled
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.
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).
A list of the shipments for the order.
Costs in USD cents (i.e. $1.00 = 100). If the order was swapped, amounts
displays the most recent amounts (i.e. post-swap).
The Goody user who sent this order.
The reference ID displayed on receipts and other locations as the ID for this order.
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.
Only provided when calling the /orders/:id endpoint.
If this order is a gift that was swapped, this displays the original cart that was sent to the recipient.
If this order is a gift that was swapped, this displays the original amounts of the cart that was sent to the recipient.
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).