Skip to main content
Permission: Read · Workspace: required (from goody_workspaces_list) Fetches full detail for a single gift batch — read back the cart, see who received it, or check scheduled-send timing.

Parameters

string
required
Workspace UUID — from goody_workspaces_list. The batch must belong to this workspace.
string
required
Batch UUID — from goody_order_batches_list.

Returns

string
Batch UUID.
string | null
The batch’s name.
string
Where the batch is in its lifecycle.
string | null
The “From” name recipients see.
string | null
The gift-card message.
integer
Number of orders in the batch.
object[]
Up to 10 orders from the batch, for a quick look.
integer
Number of recipients.
object[]
Up to 10 recipients, for a quick look.
object | null
The gift contents (products) for the batch.
object | null
Who sent the batch.
boolean | null
True if the batch is set to send at a future time.
string | null
When the batch is scheduled to send.
string | null
When the gift expires. null means it does not expire on a fixed date.
string | null
How recipients are notified.
string | null
The gift card chosen for the batch.
string | null
card, balance, workspace_balance, corporate_account, or commerce_stored_value; null when unknown or for commerce app orders. For a batch, this describes the selected funding source, not a combined payment result for its orders.
string (uuid) | null
Goody card payment method UUID, including inactive cards. Null for account funding, commerce app orders, or when the card is unknown.
string | null
The workspace the batch belongs to.
string | null
The workspace’s name.
string | null
Caller-supplied reference, if one was set.
string | null
The sender’s “see what you sent” link.
string[]
Per-recipient preview links for the sender.

Example

You’ll get a not-found error if the id is unknown or belongs to another workspace.
To browse other batches, use goody_order_batches_list; to list every individual order inside this batch, use goody_orders_list.