Retrieve orders for an order batch
Your Goody API key.
Order batch ID
Page for pagination, starting at 1
Items per page for pagination
curl --request GET \
--url https://api.ongoody.com/v1/order_batches/{id}/orders \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "ba771c00-e9c9-409e-aa73-353164386bcf",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/U7WP74LGL2FTLY7TJF7NB2TJ",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "33f1ff92-a017-4832-b50b-663a9ebb683b",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "1c571d09-7811-4c80-9a98-06e287a8cfa0",
"expires_at": null,
"cart": {
"id": "32e53c5d-5173-45a0-8c28-063d1ab53dce",
"items": [
{
"id": "56537cca-c993-4178-8e60-e7ca44e7dfee",
"quantity": 1,
"product": {
"id": "396c6e93-e2e2-48bc-bea9-11cce64d1a00",
"name": "Cookies",
"brand": {
"id": "77b47eb6-869c-4174-bdb0-e2349050a686",
"name": "Cookie Company"
}
}
}
]
},
"shipments": [],
"amounts": {
"amount_product": 2000,
"amount_shipping": 500,
"amount_processing_fee": 0,
"amount_pre_tax_total": 2500,
"amount_tax": null,
"amount_total": null,
"amount_global_relay_cost": null
},
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15555219355@test.ongoody.com"
},
"workspace_id": "8bad569e-11f9-4c5a-9836-8bcda2eaa6b9",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "VNMUV4THWQGRUJKNGHPGQGTY",
"payment_link": null
},
{
"id": "090b083d-7c03-437d-8c52-9bbbcf6cf8a0",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/CZ9KITZSTWLTL41DNDG1JMIM",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "33f1ff92-a017-4832-b50b-663a9ebb683b",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "1c571d09-7811-4c80-9a98-06e287a8cfa0",
"expires_at": null,
"cart": {
"id": "32e53c5d-5173-45a0-8c28-063d1ab53dce",
"items": [
{
"id": "56537cca-c993-4178-8e60-e7ca44e7dfee",
"quantity": 1,
"product": {
"id": "396c6e93-e2e2-48bc-bea9-11cce64d1a00",
"name": "Cookies",
"brand": {
"id": "77b47eb6-869c-4174-bdb0-e2349050a686",
"name": "Cookie Company"
}
}
}
]
},
"shipments": [],
"amounts": {
"amount_product": 2000,
"amount_shipping": 500,
"amount_processing_fee": 0,
"amount_pre_tax_total": 2500,
"amount_tax": null,
"amount_total": null,
"amount_global_relay_cost": null
},
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15555219355@test.ongoody.com"
},
"workspace_id": "8bad569e-11f9-4c5a-9836-8bcda2eaa6b9",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "PJ9F8LKYD7SEOHTWCA20PSSH",
"payment_link": null
}
],
"list_meta": {
"total_count": 2
}
}Authorizations
Your Goody API key.
Path Parameters
Order batch ID
Query Parameters
Page for pagination, starting at 1
Items per page for pagination
Response
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).
The brand that this product is from.
A list of the shipments for the order.
pending, tracking, shipped, delivered, delivered_override, failed, failed_unset_tracking, failed_with_reship The 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).
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.
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.
The brand that this product is from.
If this order is a gift that was swapped, this displays the original amounts of the cart that was sent to the recipient.
The Goody user who sent this order.
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).
The reference ID displayed on receipts and other locations as the ID for this order.
The total number of items in this list.
curl --request GET \
--url https://api.ongoody.com/v1/order_batches/{id}/orders \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "ba771c00-e9c9-409e-aa73-353164386bcf",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/U7WP74LGL2FTLY7TJF7NB2TJ",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "33f1ff92-a017-4832-b50b-663a9ebb683b",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "1c571d09-7811-4c80-9a98-06e287a8cfa0",
"expires_at": null,
"cart": {
"id": "32e53c5d-5173-45a0-8c28-063d1ab53dce",
"items": [
{
"id": "56537cca-c993-4178-8e60-e7ca44e7dfee",
"quantity": 1,
"product": {
"id": "396c6e93-e2e2-48bc-bea9-11cce64d1a00",
"name": "Cookies",
"brand": {
"id": "77b47eb6-869c-4174-bdb0-e2349050a686",
"name": "Cookie Company"
}
}
}
]
},
"shipments": [],
"amounts": {
"amount_product": 2000,
"amount_shipping": 500,
"amount_processing_fee": 0,
"amount_pre_tax_total": 2500,
"amount_tax": null,
"amount_total": null,
"amount_global_relay_cost": null
},
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15555219355@test.ongoody.com"
},
"workspace_id": "8bad569e-11f9-4c5a-9836-8bcda2eaa6b9",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "VNMUV4THWQGRUJKNGHPGQGTY",
"payment_link": null
},
{
"id": "090b083d-7c03-437d-8c52-9bbbcf6cf8a0",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/CZ9KITZSTWLTL41DNDG1JMIM",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "33f1ff92-a017-4832-b50b-663a9ebb683b",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "1c571d09-7811-4c80-9a98-06e287a8cfa0",
"expires_at": null,
"cart": {
"id": "32e53c5d-5173-45a0-8c28-063d1ab53dce",
"items": [
{
"id": "56537cca-c993-4178-8e60-e7ca44e7dfee",
"quantity": 1,
"product": {
"id": "396c6e93-e2e2-48bc-bea9-11cce64d1a00",
"name": "Cookies",
"brand": {
"id": "77b47eb6-869c-4174-bdb0-e2349050a686",
"name": "Cookie Company"
}
}
}
]
},
"shipments": [],
"amounts": {
"amount_product": 2000,
"amount_shipping": 500,
"amount_processing_fee": 0,
"amount_pre_tax_total": 2500,
"amount_tax": null,
"amount_total": null,
"amount_global_relay_cost": null
},
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15555219355@test.ongoody.com"
},
"workspace_id": "8bad569e-11f9-4c5a-9836-8bcda2eaa6b9",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "PJ9F8LKYD7SEOHTWCA20PSSH",
"payment_link": null
}
],
"list_meta": {
"total_count": 2
}
}