Retrieve orders for an order batch
Authorizations
Your Goody API key.
Path Parameters
Order batch ID
Query Parameters
Page for pagination, starting at 1
x > 1Items per page for pagination
1 < x < 100Response
Costs in USD cents (i.e. $1.00 = 100). If the order was swapped, amounts displays the most recent amounts (i.e. post-swap).
Total cost of the products, shipping, and processing fees in this order.
Total cost of the products in this order.
Total cost of shipping for this order.
Total amount of credit applied to this order.
Total cost of global shipping for this order through the Global Relay service.
Total cost of processing fees for this order.
Total tax for this order.
Total cost of the products, shipping, processing fees, tax, and global shipping costs in this order.
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).
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 reference ID displayed on receipts and other locations as the ID for this order.
A list of the shipments for the order.
The name of the brand that this shipment is from.
pending, tracking, shipped, delivered, delivered_override, failed, failed_unset_tracking, failed_with_reship ISO 8601
The estimated delivery time of this shipment.
ISO 8601
The carrier for this shipment, e.g. UPS.
Only for approved distribution partners.
created, notified, opened, accepted, pending_payment, paid, ordered, shipped, delivered, failed, canceled The digital greeting card on this gift.
Only provided when calling the /orders/:id endpoint.
ISO 8601
For gifts, when the recipient accepted the order.
When the order was delivered. If there are multiple shipments, this is when all shipments were delivered.
When the recipient was notified of the order.
For gifts, when the recipient opened the order.
When the order was paid for.
When the order entered pending payment status.
When the order was first shipped. If there are multiple shipments, this is when the first shipment shipped.
For gifts, the date and time the gift is set to expire.
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.
The message in this gift, provided by the sender.
On Goody for Business, all orders are attached to a order batch, which is a collection of one or more orders.
If this order is a gift that was swapped, this displays the original amounts of the cart that was sent to the recipient.
If this order is a gift that was swapped, this displays the original 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).
A thank you note sent by the recipient.
The number of times the recipient viewed the gift.
Organizations are sub-divided into workspaces. Orders are contained in workspaces, identified by this ID.