Goody Order Batches API
The Order Batches API from Goody — 5 operation(s) for order batches.
OpenAPI Specification
openapi: 3.0.1
info:
title: Goody Brands Order Batches API
version: 1.0.0
contact:
name: Goody Support
email: support@ongoody.com
servers:
- url: https://api.ongoody.com
description: Production
- url: https://api.sandbox.ongoody.com
description: Sandbox
tags:
- name: Order Batches
paths:
/v1/order_batches:
post:
summary: Create an order batch
tags:
- Order Batches
security:
- bearer: []
parameters: []
responses:
'201':
description: Order batch created using product URL in cart
content:
application/json:
examples:
Order batch created (10 or fewer recipients):
value:
id: 2fe7a598-bff4-4a4a-a423-47d9a6464a40
send_status: complete
from_name: John
message: Thank you!
orders_count: 2
orders_preview:
- id: a3316403-9b84-4b55-92d6-453dcc3e5b48
status: created
individual_gift_link: https://gifts.ongoody.com/gift/3KwUVkzoygOD0OyNQba9bg4h
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: fbbe04d8-2568-4f95-ab68-4589b757c521
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 2fe7a598-bff4-4a4a-a423-47d9a6464a40
expires_at: null
cart:
id: 4d42623b-4842-4f16-b58d-d346181bf688
items:
- id: 9c8547f2-7331-4084-9b29-042c4b5e74e4
quantity: 1
product:
id: 48680ddb-37b2-48b3-8380-226c07bdede2
name: Cookies
brand:
id: 002daabe-9cd2-486f-9729-11b7df740105
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: JEUYIPRNHZX6C1K4RZMSCV7G
payment_link: null
- id: 0033096f-637b-408d-821b-59c60aadfc01
status: created
individual_gift_link: https://gifts.ongoody.com/gift/DP31GxMZ5rOWRwollNdi8HCN
recipient_first_name: Michael
recipient_last_name: Franci
recipient_email: michael@ongoody.com
card_id: fbbe04d8-2568-4f95-ab68-4589b757c521
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 2fe7a598-bff4-4a4a-a423-47d9a6464a40
expires_at: null
cart:
id: 4d42623b-4842-4f16-b58d-d346181bf688
items:
- id: 9c8547f2-7331-4084-9b29-042c4b5e74e4
quantity: 1
product:
id: 48680ddb-37b2-48b3-8380-226c07bdede2
name: Cookies
brand:
id: 002daabe-9cd2-486f-9729-11b7df740105
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: OSPHLVULRNQDZQYT080V1ZOF
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: 4d42623b-4842-4f16-b58d-d346181bf688
items:
- id: 9c8547f2-7331-4084-9b29-042c4b5e74e4
quantity: 1
product:
id: 48680ddb-37b2-48b3-8380-226c07bdede2
name: Cookies
brand:
id: 002daabe-9cd2-486f-9729-11b7df740105
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: null
send_method: link_multiple_custom_list
batch_name: Alena Kenter and Michael Franci
card_id: fbbe04d8-2568-4f95-ab68-4589b757c521
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
reference_id: NJNJ27PDL9JAKIEBYPFUFAHG
customer_reference_id: null
Order batch created (more than 10 recipients):
value:
id: 703dbcda-f9f3-481f-b884-ee7f24b5fcb4
send_status: pending
from_name: John
message: Thank you!
orders_count: 0
orders_preview: []
recipients_count: 11
recipients_preview:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
id: 5e2514a9-2ff0-4149-a24e-15de787ed79e
items:
- id: d5a43998-58fd-4a0b-9e58-5615beb81e01
quantity: 1
product:
id: 3c638d59-f520-4e1d-aed8-25b2506dcb59
name: Cookies
brand:
id: 202ac25d-fa1a-410d-a795-0cd2cb430ec1
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: null
send_method: link_multiple_custom_list
batch_name: 0 recipients
card_id: 3da5c301-a121-4fa2-9058-16cc09f10368
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
reference_id: XMEEL7QJU7WHTFX4QHNJAAEF
customer_reference_id: null
Scheduled order batch created:
value:
id: 7e96ff95-9ad6-4712-8c88-bd9b44158ef0
send_status: pending
from_name: John
message: Thank you!
orders_count: 0
orders_preview: []
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: d8574b3d-4f5a-498d-aaf6-91ee0b052a7c
items:
- id: cd403ad9-432b-40a1-b259-e489f9212e56
quantity: 1
product:
id: 9ad51552-4b47-4a6f-9d9d-6c1d584d6511
name: Cookies
brand:
id: 8a80c8bb-7544-4eeb-a162-e63546ad8312
name: Cookie Company
is_scheduled_send: true
scheduled_send_on: '2026-06-10T12:24:24Z'
expires_at: '2026-07-01T12:24:24Z'
send_method: link_multiple_custom_list
batch_name: Alena Kenter and Michael Franci
card_id: b5542d5f-e5d9-4f03-87a1-1a81dced6d45
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
reference_id: XQPQQLYJ2GJNSZMYRHPQGO0H
customer_reference_id: null
Order batch created with recipient address:
value:
id: c80f3909-3f23-4075-bf90-6951a5ed8b27
send_status: complete
from_name: John
message: Thank you!
orders_count: 2
orders_preview:
- id: 16b29623-4d60-41b0-94ee-b81f9bb1d9aa
status: created
individual_gift_link: https://gifts.ongoody.com/gift/APTvshiuXF2zAo2rI0ktJKow
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: 5b0432b6-489f-4d66-b263-e8fb1f8bff2a
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: c80f3909-3f23-4075-bf90-6951a5ed8b27
expires_at: null
cart:
id: d1afca1b-5f78-4d42-a4bf-1928836f9bd4
items:
- id: cfc83321-24d0-440f-9083-4cc15e8849bf
quantity: 1
product:
id: 00a822ab-4d20-4e0c-bbd7-a572fdf9fef8
name: Cookies
brand:
id: 8552d59e-f14f-4120-a8e1-8a6f4e49b89d
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: O2USE6TOSFUMEGQLFWY7KZ4K
payment_link: null
- id: 206b70c1-21c1-4061-8a4f-5381ad7a7d1e
status: created
individual_gift_link: https://gifts.ongoody.com/gift/v6UyaGtEnNHa6oKGkPz2WZ0j
recipient_first_name: Michael
recipient_last_name: Franci
recipient_email: michael@ongoody.com
card_id: 5b0432b6-489f-4d66-b263-e8fb1f8bff2a
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: c80f3909-3f23-4075-bf90-6951a5ed8b27
expires_at: null
cart:
id: d1afca1b-5f78-4d42-a4bf-1928836f9bd4
items:
- id: cfc83321-24d0-440f-9083-4cc15e8849bf
quantity: 1
product:
id: 00a822ab-4d20-4e0c-bbd7-a572fdf9fef8
name: Cookies
brand:
id: 8552d59e-f14f-4120-a8e1-8a6f4e49b89d
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: G8LJ2WRXAIW4NHQFMQOWYAGI
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: d1afca1b-5f78-4d42-a4bf-1928836f9bd4
items:
- id: cfc83321-24d0-440f-9083-4cc15e8849bf
quantity: 1
product:
id: 00a822ab-4d20-4e0c-bbd7-a572fdf9fef8
name: Cookies
brand:
id: 8552d59e-f14f-4120-a8e1-8a6f4e49b89d
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: null
send_method: link_multiple_custom_list
batch_name: Alena Kenter and Michael Franci
card_id: 5b0432b6-489f-4d66-b263-e8fb1f8bff2a
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
reference_id: IOMT5YVUWZFFAX5CTGMHTUZ9
customer_reference_id: null
Order batch created (using product URL in cart):
value:
id: ffa13115-d567-4081-8e93-12a72e49aa54
send_status: complete
from_name: John
message: Thank you!
orders_count: 2
orders_preview:
- id: 47d19ed3-1ce7-471d-bb72-e017007c9c8a
status: created
individual_gift_link: https://gifts.ongoody.com/gift/RHsVV7JepMuHRljl6nWens5x
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: fc8e36c5-e4c7-4ba4-93a1-bac37514230e
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: ffa13115-d567-4081-8e93-12a72e49aa54
expires_at: '2026-07-01T12:24:40Z'
cart:
id: 5757add5-57ca-4a44-8fea-698368b651b7
items:
- id: 26c6d966-99a7-4e37-9874-917d9f4ef7ae
quantity: 1
product:
id: ad76b601-2074-4772-b5bf-4af442502183
name: Cookies
brand:
id: 6538b48d-2537-46b4-9afc-5d3997fc50da
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: 3SFN2R3FR8O3WAOXXLENCQJH
payment_link: null
- id: 7e3f9c70-6366-45ba-a229-a748928d0768
status: created
individual_gift_link: https://gifts.ongoody.com/gift/STQ08GcZCWSxTH9Q2yN6Mll6
recipient_first_name: Michael
recipient_last_name: Franci
recipient_email: michael@ongoody.com
card_id: fc8e36c5-e4c7-4ba4-93a1-bac37514230e
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: ffa13115-d567-4081-8e93-12a72e49aa54
expires_at: '2026-07-01T12:24:40Z'
cart:
id: 5757add5-57ca-4a44-8fea-698368b651b7
items:
- id: 26c6d966-99a7-4e37-9874-917d9f4ef7ae
quantity: 1
product:
id: ad76b601-2074-4772-b5bf-4af442502183
name: Cookies
brand:
id: 6538b48d-2537-46b4-9afc-5d3997fc50da
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: NQDOPHIAMN2R3KQOQT3USQDH
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: 5757add5-57ca-4a44-8fea-698368b651b7
items:
- id: 26c6d966-99a7-4e37-9874-917d9f4ef7ae
quantity: 1
product:
id: ad76b601-2074-4772-b5bf-4af442502183
name: Cookies
brand:
id: 6538b48d-2537-46b4-9afc-5d3997fc50da
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: '2026-07-01T12:24:40Z'
send_method: link_multiple_custom_list
batch_name: Alena Kenter and Michael Franci
card_id: fc8e36c5-e4c7-4ba4-93a1-bac37514230e
sender:
first_name: Test
last_name: User
email: 15558842084@test.ongoody.com
workspace_id: a1002766-acb7-432c-ada3-d832309d1353
workspace_name: Test Team
reference_id: 8K4BAROWNJADABI25LWWG3W1
customer_reference_id: null
schema:
$ref: '#/components/schemas/OrderBatch'
'400':
description: Bad request when using invalid product URL in cart
content:
application/json:
examples:
Order batch without recipients fails to create:
value:
error: Recipients can't be blank
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderBatchInput'
examples:
Order batch created:
summary: Order batch created
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: fbbe04d8-2568-4f95-ab68-4589b757c521
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
items:
- product_id: 48680ddb-37b2-48b3-8380-226c07bdede2
quantity: 1
Scheduled order batch created:
summary: Scheduled order batch created
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: b5542d5f-e5d9-4f03-87a1-1a81dced6d45
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
items:
- product_id: 9ad51552-4b47-4a6f-9d9d-6c1d584d6511
quantity: 1
scheduled_send_on: '2026-06-10T12:24:24Z'
expires_at: '2026-07-01T12:24:24Z'
Order batch created with recipient address:
summary: Order batch created with recipient address
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: 5b0432b6-489f-4d66-b263-e8fb1f8bff2a
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
mailing_address:
first_name: Alena
last_name: Kenter
address_1: 1 Main St
address_2: Apt 123
city: New York
state: NY
postal_code: '10022'
country: US
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
mailing_address:
first_name: Michael
last_name: Franci
address_1: 1 Main St
address_2: Apt 124
city: New York
state: NY
postal_code: '10022'
country: US
cart:
items:
- product_id: 00a822ab-4d20-4e0c-bbd7-a572fdf9fef8
quantity: 1
Order batch created using product URL in cart:
summary: Order batch created using product URL in cart
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: fc8e36c5-e4c7-4ba4-93a1-bac37514230e
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
items:
- product_url: http://example.com/browse/brands/cookie-company-1/cookies
quantity: 1
expires_at: '2026-07-01T12:24:40Z'
Bad request:
summary: Bad request
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: 1796e72f-0114-4436-993e-4ad3828f76a0
recipients: []
cart:
items:
- product_id: 51d3e838-8f30-4d56-985e-3e093705548d
quantity: 1
Bad request when using invalid product URL in cart:
summary: Bad request when using invalid product URL in cart
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: 203210fd-894b-4e9c-9fc5-7eb729c87d3b
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
items:
- product_url: https://www.ongoody.com/browse/brands/invalid-brand/invalid-product
quantity: 1
scheduled_send_on: '2026-06-10T12:24:46Z'
expires_at: '2026-07-01T12:24:46Z'
get:
summary: List order batches
tags:
- Order Batches
security:
- bearer: []
parameters:
- name: page
in: query
schema:
type: integer
default: 1
minimum: 1
description: Page for pagination, starting at 1
required: false
- name: per_page
in: query
schema:
type: integer
default: 20
minimum: 1
maximum: 100
description: Items per page for pagination
required: false
responses:
'200':
description: Order batches retrieved
content:
application/json:
examples:
Order batches retrieved:
value:
data:
- id: 662b8afb-b89d-4b74-87ef-df032f8c65d8
send_status: complete
from_name: Earle
message: null
orders_count: 2
orders_preview:
- id: b2f9ca52-ec39-4381-8465-0b01a37d0504
status: created
individual_gift_link: https://gifts.ongoody.com/gift/ZIOM9VVVMANJBKL6JZSMRUD2
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: 2ca309cc-2f7c-4da9-9b4c-dce1dc662e31
message: Test Message
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 662b8afb-b89d-4b74-87ef-df032f8c65d8
expires_at: null
cart:
id: fe880b4a-473d-4165-9ffd-edfd0bbc6518
items:
- id: 0e82cf86-1b6d-482a-9002-19edcef5d910
quantity: 1
product:
id: a78ee9d6-9c49-4aa5-889d-60483e512d53
name: Cookies
brand:
id: c7f4ed50-0f22-446c-be7d-42cac2678426
name: Cookie Company
shipments: []
amounts:
# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/goody/refs/heads/main/openapi/goody-order-batches-api-openapi.yml