Order Batches
Payment Methods
Commerce User Payment Methods
Workspaces
Schemas
- Schemas
Order Batches
List all order batches
GET
/
v1
/
order_batches
curl --request GET \
--url https://api.ongoody.com/v1/order_batches \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "48b0aadc-a661-47e9-8122-6ecfc48d310b",
"send_status": "complete",
"from_name": "Setsuko",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "5d122bd1-8dd8-4134-82de-f4aa726f8bbc",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/HUHTQVNY4LCTBREKPZNIOS8H",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "48b0aadc-a661-47e9-8122-6ecfc48d310b",
"expires_at": null,
"cart": {
"id": "db4a96f8-3953-4b86-87c9-604456cab07b",
"items": [
{
"id": "b16a51cf-3d02-4bae-be89-46730b0af5c3",
"quantity": 1,
"product": {
"id": "7d2c288a-144b-4b03-972f-0737961c2207",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"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": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "I7Q0SJW89LLRIPA8WITXPRLM",
"payment_link": null
},
{
"id": "351abd51-0057-4507-b44d-4fad506fa057",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/8BLFF5TWXTWY7LRFHVCCPU0T",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "48b0aadc-a661-47e9-8122-6ecfc48d310b",
"expires_at": null,
"cart": {
"id": "db4a96f8-3953-4b86-87c9-604456cab07b",
"items": [
{
"id": "b16a51cf-3d02-4bae-be89-46730b0af5c3",
"quantity": 1,
"product": {
"id": "7d2c288a-144b-4b03-972f-0737961c2207",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"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": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "UC9V44OU4MTRLVEV1RMFQLJ3",
"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": "db4a96f8-3953-4b86-87c9-604456cab07b",
"items": [
{
"id": "b16a51cf-3d02-4bae-be89-46730b0af5c3",
"quantity": 1,
"product": {
"id": "7d2c288a-144b-4b03-972f-0737961c2207",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Ankunding, Koss and Kutch",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"reference_id": "MWXRUOJXZIKPWD4NMITC5ASA"
},
{
"id": "c31ef459-b01f-4052-ae05-69aa5405136d",
"send_status": "complete",
"from_name": "Clarita",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "b6400776-44e3-4394-ae8e-e4269f20e1cf",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/JVEW5QTLNEGKAJQFPRZCZ0RO",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "c31ef459-b01f-4052-ae05-69aa5405136d",
"expires_at": null,
"cart": {
"id": "6bf2a115-4469-4b00-ae0e-5b8445cac87f",
"items": [
{
"id": "dc624b47-2eab-4484-9eec-bc0e8a14125a",
"quantity": 1,
"product": {
"id": "4fcc966b-192d-43e2-82eb-b4f79ce823e8",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"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": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "YAPJATTL6N3D23QQ6GHURDTI",
"payment_link": null
},
{
"id": "5084ef51-35d3-4dd1-8610-59a02dd66f55",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/JJFBRMLXAWGHNFISH6PPBTMK",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "c31ef459-b01f-4052-ae05-69aa5405136d",
"expires_at": null,
"cart": {
"id": "6bf2a115-4469-4b00-ae0e-5b8445cac87f",
"items": [
{
"id": "dc624b47-2eab-4484-9eec-bc0e8a14125a",
"quantity": 1,
"product": {
"id": "4fcc966b-192d-43e2-82eb-b4f79ce823e8",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"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": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "S7LYENJN1ZV6N3ZUTCLCFB9J",
"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": "6bf2a115-4469-4b00-ae0e-5b8445cac87f",
"items": [
{
"id": "dc624b47-2eab-4484-9eec-bc0e8a14125a",
"quantity": 1,
"product": {
"id": "4fcc966b-192d-43e2-82eb-b4f79ce823e8",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Heller-Rutherford",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"reference_id": "ZIRY2B6XNO8M6XRZZUXV6PKT"
}
],
"list_meta": {
"total_count": 2
}
}
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
Response
200 - application/json
Order batches retrieved
The response is of type object
.
curl --request GET \
--url https://api.ongoody.com/v1/order_batches \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "48b0aadc-a661-47e9-8122-6ecfc48d310b",
"send_status": "complete",
"from_name": "Setsuko",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "5d122bd1-8dd8-4134-82de-f4aa726f8bbc",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/HUHTQVNY4LCTBREKPZNIOS8H",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "48b0aadc-a661-47e9-8122-6ecfc48d310b",
"expires_at": null,
"cart": {
"id": "db4a96f8-3953-4b86-87c9-604456cab07b",
"items": [
{
"id": "b16a51cf-3d02-4bae-be89-46730b0af5c3",
"quantity": 1,
"product": {
"id": "7d2c288a-144b-4b03-972f-0737961c2207",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"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": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "I7Q0SJW89LLRIPA8WITXPRLM",
"payment_link": null
},
{
"id": "351abd51-0057-4507-b44d-4fad506fa057",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/8BLFF5TWXTWY7LRFHVCCPU0T",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "48b0aadc-a661-47e9-8122-6ecfc48d310b",
"expires_at": null,
"cart": {
"id": "db4a96f8-3953-4b86-87c9-604456cab07b",
"items": [
{
"id": "b16a51cf-3d02-4bae-be89-46730b0af5c3",
"quantity": 1,
"product": {
"id": "7d2c288a-144b-4b03-972f-0737961c2207",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"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": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "UC9V44OU4MTRLVEV1RMFQLJ3",
"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": "db4a96f8-3953-4b86-87c9-604456cab07b",
"items": [
{
"id": "b16a51cf-3d02-4bae-be89-46730b0af5c3",
"quantity": 1,
"product": {
"id": "7d2c288a-144b-4b03-972f-0737961c2207",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Ankunding, Koss and Kutch",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"reference_id": "MWXRUOJXZIKPWD4NMITC5ASA"
},
{
"id": "c31ef459-b01f-4052-ae05-69aa5405136d",
"send_status": "complete",
"from_name": "Clarita",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "b6400776-44e3-4394-ae8e-e4269f20e1cf",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/JVEW5QTLNEGKAJQFPRZCZ0RO",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "c31ef459-b01f-4052-ae05-69aa5405136d",
"expires_at": null,
"cart": {
"id": "6bf2a115-4469-4b00-ae0e-5b8445cac87f",
"items": [
{
"id": "dc624b47-2eab-4484-9eec-bc0e8a14125a",
"quantity": 1,
"product": {
"id": "4fcc966b-192d-43e2-82eb-b4f79ce823e8",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"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": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "YAPJATTL6N3D23QQ6GHURDTI",
"payment_link": null
},
{
"id": "5084ef51-35d3-4dd1-8610-59a02dd66f55",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/JJFBRMLXAWGHNFISH6PPBTMK",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "c31ef459-b01f-4052-ae05-69aa5405136d",
"expires_at": null,
"cart": {
"id": "6bf2a115-4469-4b00-ae0e-5b8445cac87f",
"items": [
{
"id": "dc624b47-2eab-4484-9eec-bc0e8a14125a",
"quantity": 1,
"product": {
"id": "4fcc966b-192d-43e2-82eb-b4f79ce823e8",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"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": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "S7LYENJN1ZV6N3ZUTCLCFB9J",
"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": "6bf2a115-4469-4b00-ae0e-5b8445cac87f",
"items": [
{
"id": "dc624b47-2eab-4484-9eec-bc0e8a14125a",
"quantity": 1,
"product": {
"id": "4fcc966b-192d-43e2-82eb-b4f79ce823e8",
"name": "Cookies",
"brand": {
"id": "fc9f55a3-72c0-461a-b674-f598a396909c",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Heller-Rutherford",
"card_id": "051a7ad4-314a-446a-94a8-fc0208dece0e",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15552740454@test.ongoody.com"
},
"workspace_id": "802d17c1-6a58-4976-8c6c-d1d8bc1d3ff0",
"workspace_name": "Test Team",
"reference_id": "ZIRY2B6XNO8M6XRZZUXV6PKT"
}
],
"list_meta": {
"total_count": 2
}
}
Assistant
Responses are generated using AI and may contain mistakes.