OrderBatch

id

string

required

send_status

enum<string>

required

The pending status indicates that an order batch is being prepared to be sent out. If it is not scheduled, it is being sent asynchronously. If it is scheduled, it will stay in pending state until the scheduled time is reached, at which point it will be processed and moved to complete. When it is in pending status, no orders are created yet. When the order batch is in complete status, all orders are created and available.

Available options:

pending,

complete,

failed,

canceled

from_name

string

required

The name of the sender. This is displayed on the order and notifications.

orders_count

integer

required

The total number of orders in this order batch. This might be blank if the order batch is scheduled for the future, or it could be fewer than the recipient count if the order batch is in the process of being sent.

orders_preview

object[]

required

A preview of the first 10 orders in this order batch. To paginate through all of the orders, use the /order_batches/:id/orders endpoint with ?page&per_page. If your use case never sends more than 10 orders in a single batch, you can use this field instead of calling /order_batches/:id/orders. For order batches with more than 10 recipients, this array will be empty while the orders are asynchronously created in the background.

orders_preview.id

string

required

orders_preview.recipient_first_name

string

required

orders_preview.recipient_last_name

string | null

orders_preview.recipient_email

string | null

orders_preview.status

enum<string>

required

Available options:

created,

notified,

opened,

accepted,

pending_payment,

paid,

ordered,

shipped,

delivered,

failed,

canceled

orders_preview.individual_gift_link

string

required

This gift link can be sent to the recipient or shared with the sender. For privacy reasons, this gift link does not display tracking information. A separate link, the recipient link, is sent directly to the recipient after they accept their gift, which does contain tracking information.

orders_preview.cart

object

required

The cart currently on this order. If the order is a gift that was swapped, cart displays the most recent products selected (i.e. post-swap).

orders_preview.shipments

object[]

required

A list of the shipments for the order.

orders_preview.workspace_id

string | null

Organizations are sub-divided into workspaces. Orders are contained in workspaces, identified by this ID.

orders_preview.workspace_name

string | null

orders_preview.expires_at

string | null

For gifts, the date and time the gift is set to expire.

orders_preview.card_id

string | null

The digital greeting card on this gift.

orders_preview.message

string | null

The message in this gift, provided by the sender.

orders_preview.thank_you_note

string | null

A thank you note sent by the recipient.

orders_preview.view_count_recipient

integer

The number of times the recipient viewed the gift.

orders_preview.is_swapped

boolean

If this gift was swapped by the recipient. Swapping allows a recipient to select another product or products, which replaces the cart. The original products are saved to original_cart.

orders_preview.order_batch_id

string

On Goody for Business, all orders are attached to a order batch, which is a collection of one or more orders.

orders_preview.amounts

object

required

Costs in USD cents (i.e. $1.00 = 100). If the order was swapped, amounts displays the most recent amounts (i.e. post-swap).

orders_preview.event_times

object | null

Only provided when calling the /orders/:id endpoint.

orders_preview.original_cart

object | null

If this order is a gift that was swapped, this displays the original cart that was sent to the recipient.

orders_preview.original_amounts

object | null

If this order is a gift that was swapped, this displays the original amounts of the cart that was sent to the recipient.

orders_preview.sender

object

required

The Goody user who sent this order.

orders_preview.payment_link

string | null

For commerce apps using Hosted Payment, the payment link for the gift with the credit card entry form. Available when the gift is in pending_payment status (after it has been accepted).

orders_preview.reference_id

string

required

The reference ID displayed on receipts and other locations as the ID for this order.

recipients_count

integer

required

The total number of recipients in this order batch.

recipients_preview

object[]

required

A preview of the first 10 recipients in this order batch. To see all of the recipients, use /order_batches/:id/recipients. Recipients contain the original contact information provided for each recipient when the order batch was created.

cart

object

required

The cart that was sent for this order batch. This is the original cart that was created for this order batch. If individual orders were swapped, this still remains the same, whereas orders' cart would change if they were swapped.

sender

object

required

The sender of the order batch.

reference_id

string

required

The reference ID displayed on receipts and other locations as the ID for this order batch.

message

string | null

The message in this order batch, provided by the sender.

is_scheduled_send

boolean

Whether this order batch was set up as a scheduled send. This stays as true after the scheduled send is complete. To determine if the order batch is scheduled to be sent for the future, check if status is pending and scheduled_send_on is in the future. When a order batch is scheduled, orders are only created on the scheduled send date.

scheduled_send_on

string | null

The date and time the order batch is scheduled to be sent. This will be null if the order batch is not a scheduled send. This field remains after the scheduled send completes. ISO 8601, UTC.

expires_at

string | null

The date and time the order batch is set to expire. ISO 8601, UTC.

send_method

enum<string> | null

The method for sending a order batch. email_and_link sends a gift email to the recipient (specify email for each recipient). link_multiple_custom_list generates a gift link without an automatic email. direct_send ships the product directly to the recipient (specify mailing_address for each recipient). For more information, see Send Methods.

Available options:

email_and_link,

link_multiple_custom_list,

direct_send

batch_name

string | null

An internal name for the order batch, falling back to an auto-generated batch name. Not displayed to recipients.

card_id

string | null

The digital greeting card on this order batch.

workspace_id

string | null

Organizations are sub-divided into workspaces. Order batches are contained in workspaces, identified by this ID.

workspace_name

string | null

Order Batches

Orders

Products

Payment Methods

Workspaces

Cards

Me

Schemas