Skip to main content
Permission: Read · Workspace: required (from goody_workspaces_list) Lists individual orders — one per recipient. Without order_batch_id, it lists all orders in the workspace, newest first. With it, it lists the orders in that batch, oldest first.

​
Parameters

​
workspace_id
string
required
Workspace UUID — from goody_workspaces_list. Listing is always scoped to this workspace.
​
order_batch_id
string
Optional filter to one batch — from goody_order_batches_list. Omit to list all orders in the workspace.
​
page
integer
default:"1"
Page number, starting at 1.
​
per_page
integer
default:"25"
Orders per page. Defaults to 25, max 100.

​
Returns

​
orders
object[]
The matching orders, one per recipient.
​
total_count
integer
Total number of orders across all pages.

​
Example

"Who received the gifts in that batch?"

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

{
  "orders": [
    {
      "id": "1c4d…",
      "status": "accepted",
      "recipient_first_name": "Sarah",
      "recipient_last_name": "Chen",
      "recipient_email": "sarah@acme.com",
      "card_id": "a7f9…",
      "message": "Thank you for a great quarter, Sarah!",
      "cart": { "items": [{ "product_id": "0f3c…", "name": "Cold Brew Starter Kit" }] },
      "amounts": { "subtotal": 4200, "total": 4620 },
      "shipments": [],
      "sender": { "first_name": "Jordan", "last_name": "Lee", "email": "jordan@acme.com" },
      "workspace_id": "3f8a…",
      "order_batch_id": "b92e…",
      "reference_id": null
    }
  ],
  "total_count": 12
}
You’ll get a not-found error if order_batch_id references a batch outside the resolved workspace.
For the batch as a whole — cart, “From” name, send timing — use goody_order_batches_get; to cancel an order that hasn’t been accepted yet, use goody_orders_cancel.