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

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

​
Returns

​
id
string
Batch UUID.
​
batch_name
string | null
The batch’s name.
​
send_status
string
Where the batch is in its lifecycle.
​
from_name
string | null
The “From” name recipients see.
​
message
string | null
The gift-card message.
​
orders_count
integer
Number of orders in the batch.
​
orders_preview
object[]
Up to 10 orders from the batch, for a quick look.
​
recipients_count
integer
Number of recipients.
​
recipients_preview
object[]
Up to 10 recipients, for a quick look.
​
cart
object | null
The gift contents (products) for the batch.
​
sender
object | null
Who sent the batch.
​
is_scheduled_send
boolean | null
True if the batch is set to send at a future time.
​
scheduled_send_on
string | null
When the batch is scheduled to send.
​
expires_at
string | null
When the gift expires. null means it does not expire on a fixed date.
​
send_method
string | null
How recipients are notified.
​
card_id
string | null
The gift card chosen for the batch.
​
workspace_id
string | null
The workspace the batch belongs to.
​
workspace_name
string | null
The workspace’s name.
​
reference_id
string | null
Caller-supplied reference, if one was set.
​
preview_url
string | null
The sender’s “see what you sent” link.
​
sender_preview_urls
string[]
Per-recipient preview links for the sender.

​
Example

"Show me the details of that batch."

{
  "name": "goody_order_batches_get",
  "arguments": { "workspace_id": "3f8a…", "order_batch_id": "b92e…" }
}

{
  "id": "b92e…",
  "batch_name": "Q2 client thank-yous",
  "send_status": "sent",
  "from_name": "Jordan at Acme",
  "message": "Thank you for a great quarter, {{firstname}}!",
  "orders_count": 12,
  "orders_preview": [
    { "id": "1c4d…", "recipient_first_name": "Sarah", "status": "accepted" }
  ],
  "recipients_count": 12,
  "recipients_preview": [
    { "first_name": "Sarah", "last_name": "Chen", "email": "sarah@acme.com" }
  ],
  "cart": {
    "items": [
      { "product_id": "0f3c…", "name": "Cold Brew Starter Kit" }
    ]
  },
  "sender": {
    "first_name": "Jordan",
    "last_name": "Lee",
    "email": "jordan@acme.com"
  },
  "is_scheduled_send": false,
  "scheduled_send_on": null,
  "expires_at": null,
  "send_method": "email",
  "card_id": "a7f9…",
  "workspace_id": "3f8a…",
  "workspace_name": "Acme",
  "reference_id": null,
  "preview_url": "https://ongoody.com/g/b92e…",
  "sender_preview_urls": [
    "https://ongoody.com/g/b92e…/1c4d…"
  ]
}
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.