Order Batches
List all order batches
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": "1668f2ea-c608-4660-8c62-f441a86fd1c6",
"send_status": "complete",
"from_name": "Frank",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "f7b12fb9-c3c9-4bbe-87c7-f8b77d689a05",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/J9UQCXCIMXL107XIQT3GVHH4",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "1668f2ea-c608-4660-8c62-f441a86fd1c6",
"expires_at": null,
"cart": {
"id": "365ddc7b-cb51-47af-b38e-1c7a81bdb8e1",
"items": [
{
"id": "7262e91f-fd08-49a2-81d9-288184c8e495",
"quantity": 1,
"product": {
"id": "33579572-6083-4706-9443-204741cd88dd",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"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": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "GGXXRYNOAPYBFPOMX9S6SKQU",
"payment_link": null
},
{
"id": "e7700ec9-a3f2-45e6-a76a-e56356d0dc35",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/XCDRNLG9RCNVXDT4RCADWHBY",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "1668f2ea-c608-4660-8c62-f441a86fd1c6",
"expires_at": null,
"cart": {
"id": "365ddc7b-cb51-47af-b38e-1c7a81bdb8e1",
"items": [
{
"id": "7262e91f-fd08-49a2-81d9-288184c8e495",
"quantity": 1,
"product": {
"id": "33579572-6083-4706-9443-204741cd88dd",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"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": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "AHVXI6JQPUGK1PYXZ7LFLTBB",
"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": "365ddc7b-cb51-47af-b38e-1c7a81bdb8e1",
"items": [
{
"id": "7262e91f-fd08-49a2-81d9-288184c8e495",
"quantity": 1,
"product": {
"id": "33579572-6083-4706-9443-204741cd88dd",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Stokes, McClure and Heaney",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"reference_id": "F0VIEC0LQ53D20QSIHOUKONL"
},
{
"id": "a1f08600-eb39-49bd-b4b1-63ecd51d9cd2",
"send_status": "complete",
"from_name": "Jeannine",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "1bbd40aa-a1b6-4895-82ec-6ff16006b630",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/VNNUI4LPUXUV4TV0ZYCL0V7F",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "a1f08600-eb39-49bd-b4b1-63ecd51d9cd2",
"expires_at": null,
"cart": {
"id": "b231795f-4f0a-4f74-a40d-ddf67606d119",
"items": [
{
"id": "04591a03-dc0b-41a3-8cb1-94b2275ebd56",
"quantity": 1,
"product": {
"id": "2c5f36b0-6716-46d3-9821-81d53a53545e",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"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": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "KW5384ZOVZZ7K9XALGH7R3T0",
"payment_link": null
},
{
"id": "2850a750-598f-42da-8d5f-1d959028585a",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/MFUIN9ZPUWKGWPCE4AHMERRU",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "a1f08600-eb39-49bd-b4b1-63ecd51d9cd2",
"expires_at": null,
"cart": {
"id": "b231795f-4f0a-4f74-a40d-ddf67606d119",
"items": [
{
"id": "04591a03-dc0b-41a3-8cb1-94b2275ebd56",
"quantity": 1,
"product": {
"id": "2c5f36b0-6716-46d3-9821-81d53a53545e",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"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": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "JNHKX5WZDVY6KVS4NHBEZPDH",
"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": "b231795f-4f0a-4f74-a40d-ddf67606d119",
"items": [
{
"id": "04591a03-dc0b-41a3-8cb1-94b2275ebd56",
"quantity": 1,
"product": {
"id": "2c5f36b0-6716-46d3-9821-81d53a53545e",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Schaden-Leannon",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"reference_id": "4CSUO55DFOJIZPWANKUPAAAW"
}
],
"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": "1668f2ea-c608-4660-8c62-f441a86fd1c6",
"send_status": "complete",
"from_name": "Frank",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "f7b12fb9-c3c9-4bbe-87c7-f8b77d689a05",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/J9UQCXCIMXL107XIQT3GVHH4",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "1668f2ea-c608-4660-8c62-f441a86fd1c6",
"expires_at": null,
"cart": {
"id": "365ddc7b-cb51-47af-b38e-1c7a81bdb8e1",
"items": [
{
"id": "7262e91f-fd08-49a2-81d9-288184c8e495",
"quantity": 1,
"product": {
"id": "33579572-6083-4706-9443-204741cd88dd",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"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": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "GGXXRYNOAPYBFPOMX9S6SKQU",
"payment_link": null
},
{
"id": "e7700ec9-a3f2-45e6-a76a-e56356d0dc35",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/XCDRNLG9RCNVXDT4RCADWHBY",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "1668f2ea-c608-4660-8c62-f441a86fd1c6",
"expires_at": null,
"cart": {
"id": "365ddc7b-cb51-47af-b38e-1c7a81bdb8e1",
"items": [
{
"id": "7262e91f-fd08-49a2-81d9-288184c8e495",
"quantity": 1,
"product": {
"id": "33579572-6083-4706-9443-204741cd88dd",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"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": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "AHVXI6JQPUGK1PYXZ7LFLTBB",
"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": "365ddc7b-cb51-47af-b38e-1c7a81bdb8e1",
"items": [
{
"id": "7262e91f-fd08-49a2-81d9-288184c8e495",
"quantity": 1,
"product": {
"id": "33579572-6083-4706-9443-204741cd88dd",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Stokes, McClure and Heaney",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"reference_id": "F0VIEC0LQ53D20QSIHOUKONL"
},
{
"id": "a1f08600-eb39-49bd-b4b1-63ecd51d9cd2",
"send_status": "complete",
"from_name": "Jeannine",
"message": null,
"orders_count": 2,
"orders_preview": [
{
"id": "1bbd40aa-a1b6-4895-82ec-6ff16006b630",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/VNNUI4LPUXUV4TV0ZYCL0V7F",
"recipient_first_name": "Alena",
"recipient_last_name": "Kenter",
"recipient_email": "alena@ongoody.com",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "a1f08600-eb39-49bd-b4b1-63ecd51d9cd2",
"expires_at": null,
"cart": {
"id": "b231795f-4f0a-4f74-a40d-ddf67606d119",
"items": [
{
"id": "04591a03-dc0b-41a3-8cb1-94b2275ebd56",
"quantity": 1,
"product": {
"id": "2c5f36b0-6716-46d3-9821-81d53a53545e",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"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": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "KW5384ZOVZZ7K9XALGH7R3T0",
"payment_link": null
},
{
"id": "2850a750-598f-42da-8d5f-1d959028585a",
"status": "created",
"individual_gift_link": "https://gifts.ongoody.com/gift/MFUIN9ZPUWKGWPCE4AHMERRU",
"recipient_first_name": "Michael",
"recipient_last_name": "Franci",
"recipient_email": "michael@ongoody.com",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"message": "Test Message",
"thank_you_note": null,
"view_count_recipient": 0,
"is_swapped": false,
"order_batch_id": "a1f08600-eb39-49bd-b4b1-63ecd51d9cd2",
"expires_at": null,
"cart": {
"id": "b231795f-4f0a-4f74-a40d-ddf67606d119",
"items": [
{
"id": "04591a03-dc0b-41a3-8cb1-94b2275ebd56",
"quantity": 1,
"product": {
"id": "2c5f36b0-6716-46d3-9821-81d53a53545e",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"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": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "JNHKX5WZDVY6KVS4NHBEZPDH",
"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": "b231795f-4f0a-4f74-a40d-ddf67606d119",
"items": [
{
"id": "04591a03-dc0b-41a3-8cb1-94b2275ebd56",
"quantity": 1,
"product": {
"id": "2c5f36b0-6716-46d3-9821-81d53a53545e",
"name": "Cookies",
"brand": {
"id": "6570ca08-9506-4913-bab2-662884f3bf9a",
"name": "Cookie Company"
}
}
}
]
},
"is_scheduled_send": false,
"scheduled_send_on": null,
"expires_at": null,
"send_method": null,
"batch_name": "Thank You from Schaden-Leannon",
"card_id": "a617fddf-5691-430c-a3e7-aaa69d6eec79",
"sender": {
"first_name": "Test",
"last_name": "User",
"email": "15557400676@test.ongoody.com"
},
"workspace_id": "d5f149d4-51a1-406b-9a53-a7c477314acd",
"workspace_name": "Test Team",
"reference_id": "4CSUO55DFOJIZPWANKUPAAAW"
}
],
"list_meta": {
"total_count": 2
}
}