Skip to main content
Permission: Write · Workspace: required (from goody_workspaces_list) A quick price estimate — cart subtotal, tax, shipping, and total — before sending. Use it when the user just wants a number; use goody_order_batches_preview for the richer confirm-against-it step that returns a shareable link. Nothing is charged.
Relay the total, the from_name, and the notification_preview before calling goody_order_batches_create.

Parameters

string
required
Workspace UUID — from goody_workspaces_list. Scopes the estimate to this workspace.
string
A single product UUID — from goody_products_search. Use this or cart, never both.
integer
default:"1"
Quantity for product_id. Defaults to 1.
integer
Amount to fund, in cents, for a variable-amount Gift of Choice or variable gift card. Must fall within the gift’s [price_min, price_max]. Only applies to product_id.
object
A multi-item cart — an object with an items array (not a bare array). Use this or product_id, never both.
string
A single saved-contact UUID — from goody_contacts_search. Use this or recipients.
object[]
The people to send to. Use this or contact_id.
string
default:"link_single"
How the recipient receives the gift. One of link_single, email_and_link, or direct_send (ships a physical product — requires a mailing_address on every recipient). Affects shipping in the estimate.
string
default:"single"
Whether the recipient may swap the gift. One of single (swap once), multiple (swap freely), or disabled (no swapping).
string
The “From” name the recipient sees. When the user states a From name, pass it. Defaults to the authenticated user.
string
Optional. A funding source — from goody_payment_methods_list. When supplied, the result echoes the resolved payment_method so the user can confirm where the charge would land.

Returns

object
The cart subtotal before tax and shipping.
object
The full total — subtotal, tax, and shipping. Relay this to the user.
string
The resolved sender name. Show it to the user so they can confirm who the gift is from.
string
How recipients are reached for the chosen send_method (e.g. emailed a link, or shipped directly). State this before sending.
object | null
The resolved funding source — present only when a payment_method_id was supplied.

Example

For a shareable preview link the user can review before sending, use goody_order_batches_preview. When the user confirms, send it with goody_order_batches_create.