Authorizations
Your Goody API key.
Query Parameters
Page for pagination, starting at 1
Required range:
x >= 1
Items per page for pagination
Required range:
1 <= x <= 100
curl --request GET \
--url https://api.ongoody.com/v1/order_batches \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "96d8fba0-0e99-4e47-a603-d5640153c88f",
"send_status": "complete",
"from_name": "Frances",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "884943cd-d080-471c-85e5-fea953ee6456",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/HB4XATU8PPAQCZ5U9IBTUTUY",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "96d8fba0-0e99-4e47-a603-d5640153c88f",
"expires_at": null,
"cart": {
"id": "b9aea124-fd7a-4ebb-8eb2-b08d02eb43bd",
"items": [
{
"id": "8bcf7a15-0cca-41b8-a017-4b9d618bd426",
"quantity": 1,
"product": {
"id": "11702398-e921-4b5b-8734-bd963af81936",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"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": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "UIPZMUMCD7ZGTUG4GXEJKLBJ",
"payment_link": null
},
{
"id": "12113764-5261-43cb-8a48-cdbad97421c2",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/HZFIDAHBLUQIXTAA3YNWM1BE",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "96d8fba0-0e99-4e47-a603-d5640153c88f",
"expires_at": null,
"cart": {
"id": "b9aea124-fd7a-4ebb-8eb2-b08d02eb43bd",
"items": [
{
"id": "8bcf7a15-0cca-41b8-a017-4b9d618bd426",
"quantity": 1,
"product": {
"id": "11702398-e921-4b5b-8734-bd963af81936",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"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": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "CLTQVR33IVY9NKFCMVGGJ1NC",
"payment_link": null
}
],
"recipients_count": 2,
"recipients_preview": [
{
"first_name": "Alena",
"last_name": "Kenter",
"email": "alena@ongoody.com"
},
{
"first_name": "Michael",
"last_name": "Franci",
"email": "michael@ongoody.com"
}
],
"cart": {
"id": "b9aea124-fd7a-4ebb-8eb2-b08d02eb43bd",
"items": [
{
"id": "8bcf7a15-0cca-41b8-a017-4b9d618bd426",
"quantity": 1,
"product": {
"id": "11702398-e921-4b5b-8734-bd963af81936",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Schmidt Group",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"reference_id": "FONGUFW4EGXK4J6UBV9KASLI"
},
{
"id": "f5ba24c8-e8de-41f6-a6bd-ab236a7b58c7",
"send_status": "complete",
"from_name": "Jere",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "b0553679-5d51-4f68-9d50-6ce76ef7236b",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/COUEPSTTIO7OR1IQ1IEFLVAY",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "f5ba24c8-e8de-41f6-a6bd-ab236a7b58c7",
"expires_at": null,
"cart": {
"id": "1d0023a8-766a-4d00-9d37-6fe0bf60747e",
"items": [
{
"id": "eea92288-e4a2-4c94-b07c-8990d6e84a28",
"quantity": 1,
"product": {
"id": "57a5f463-8c51-40c2-91fd-38fd801dc562",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"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": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "N05GQ6SADOMFZ1EY34LT8DFG",
"payment_link": null
},
{
"id": "bb0f294f-96d0-4aa8-aa31-ad86c56640af",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/3VES6AXUIHCWZ1VNBRKSYHGC",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "f5ba24c8-e8de-41f6-a6bd-ab236a7b58c7",
"expires_at": null,
"cart": {
"id": "1d0023a8-766a-4d00-9d37-6fe0bf60747e",
"items": [
{
"id": "eea92288-e4a2-4c94-b07c-8990d6e84a28",
"quantity": 1,
"product": {
"id": "57a5f463-8c51-40c2-91fd-38fd801dc562",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"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": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "U47GZCMLYYCP4PZ71OXQAL87",
"payment_link": null
}
],
"recipients_count": 2,
"recipients_preview": [
{
"first_name": "Alena",
"last_name": "Kenter",
"email": "alena@ongoody.com"
},
{
"first_name": "Michael",
"last_name": "Franci",
"email": "michael@ongoody.com"
}
],
"cart": {
"id": "1d0023a8-766a-4d00-9d37-6fe0bf60747e",
"items": [
{
"id": "eea92288-e4a2-4c94-b07c-8990d6e84a28",
"quantity": 1,
"product": {
"id": "57a5f463-8c51-40c2-91fd-38fd801dc562",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Price Group",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"reference_id": "WRAIS95X3TR7GAZHHRBZPUZS"
}
],
"list_meta": {
"total_count": 2
}
}
Your Goody API key.
Page for pagination, starting at 1
x >= 1
Items per page for pagination
1 <= x <= 100
curl --request GET \
--url https://api.ongoody.com/v1/order_batches \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "96d8fba0-0e99-4e47-a603-d5640153c88f",
"send_status": "complete",
"from_name": "Frances",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "884943cd-d080-471c-85e5-fea953ee6456",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/HB4XATU8PPAQCZ5U9IBTUTUY",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "96d8fba0-0e99-4e47-a603-d5640153c88f",
"expires_at": null,
"cart": {
"id": "b9aea124-fd7a-4ebb-8eb2-b08d02eb43bd",
"items": [
{
"id": "8bcf7a15-0cca-41b8-a017-4b9d618bd426",
"quantity": 1,
"product": {
"id": "11702398-e921-4b5b-8734-bd963af81936",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"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": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "UIPZMUMCD7ZGTUG4GXEJKLBJ",
"payment_link": null
},
{
"id": "12113764-5261-43cb-8a48-cdbad97421c2",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/HZFIDAHBLUQIXTAA3YNWM1BE",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "96d8fba0-0e99-4e47-a603-d5640153c88f",
"expires_at": null,
"cart": {
"id": "b9aea124-fd7a-4ebb-8eb2-b08d02eb43bd",
"items": [
{
"id": "8bcf7a15-0cca-41b8-a017-4b9d618bd426",
"quantity": 1,
"product": {
"id": "11702398-e921-4b5b-8734-bd963af81936",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"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": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "CLTQVR33IVY9NKFCMVGGJ1NC",
"payment_link": null
}
],
"recipients_count": 2,
"recipients_preview": [
{
"first_name": "Alena",
"last_name": "Kenter",
"email": "alena@ongoody.com"
},
{
"first_name": "Michael",
"last_name": "Franci",
"email": "michael@ongoody.com"
}
],
"cart": {
"id": "b9aea124-fd7a-4ebb-8eb2-b08d02eb43bd",
"items": [
{
"id": "8bcf7a15-0cca-41b8-a017-4b9d618bd426",
"quantity": 1,
"product": {
"id": "11702398-e921-4b5b-8734-bd963af81936",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Schmidt Group",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"reference_id": "FONGUFW4EGXK4J6UBV9KASLI"
},
{
"id": "f5ba24c8-e8de-41f6-a6bd-ab236a7b58c7",
"send_status": "complete",
"from_name": "Jere",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "b0553679-5d51-4f68-9d50-6ce76ef7236b",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/COUEPSTTIO7OR1IQ1IEFLVAY",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "f5ba24c8-e8de-41f6-a6bd-ab236a7b58c7",
"expires_at": null,
"cart": {
"id": "1d0023a8-766a-4d00-9d37-6fe0bf60747e",
"items": [
{
"id": "eea92288-e4a2-4c94-b07c-8990d6e84a28",
"quantity": 1,
"product": {
"id": "57a5f463-8c51-40c2-91fd-38fd801dc562",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"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": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "N05GQ6SADOMFZ1EY34LT8DFG",
"payment_link": null
},
{
"id": "bb0f294f-96d0-4aa8-aa31-ad86c56640af",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/3VES6AXUIHCWZ1VNBRKSYHGC",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "f5ba24c8-e8de-41f6-a6bd-ab236a7b58c7",
"expires_at": null,
"cart": {
"id": "1d0023a8-766a-4d00-9d37-6fe0bf60747e",
"items": [
{
"id": "eea92288-e4a2-4c94-b07c-8990d6e84a28",
"quantity": 1,
"product": {
"id": "57a5f463-8c51-40c2-91fd-38fd801dc562",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"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": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "U47GZCMLYYCP4PZ71OXQAL87",
"payment_link": null
}
],
"recipients_count": 2,
"recipients_preview": [
{
"first_name": "Alena",
"last_name": "Kenter",
"email": "alena@ongoody.com"
},
{
"first_name": "Michael",
"last_name": "Franci",
"email": "michael@ongoody.com"
}
],
"cart": {
"id": "1d0023a8-766a-4d00-9d37-6fe0bf60747e",
"items": [
{
"id": "eea92288-e4a2-4c94-b07c-8990d6e84a28",
"quantity": 1,
"product": {
"id": "57a5f463-8c51-40c2-91fd-38fd801dc562",
"name": "Cookies",
"brand": {
"id": "bcca06d4-b731-49b7-9dad-9d731938a6ce",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Price Group",
"card_id": "940bc824-aa7a-43bd-9860-21b0ab101149",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15553944764@test.ongoody.com"
},
"workspace_id": "47ec402b-fa17-4050-b3b3-cd770a713c7b",
"workspace_name": "Test Team",
"reference_id": "WRAIS95X3TR7GAZHHRBZPUZS"
}
],
"list_meta": {
"total_count": 2
}
}