API Reference

Goody

Commerce API Keys

Automation API Keys

List all order batches

An individual order contains the gift link to be sent to the recipient (if applicable) and other information about the order.

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

Total amount of credit applied to this order.

Total cost of global shipping for this order through the Global Relay service.

Total cost of the products, shipping, and processing fees in this order.

Total cost of processing fees for this order.

Total cost of the products in this order.

Total cost of the products, shipping, processing fees, tax, and global shipping costs in this order.

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).

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

For gifts, when the recipient accepted the order.

When the order was delivered. If there are multiple shipments, this is when all shipments were delivered.

When the recipient was notified of the order.

For gifts, when the recipient opened the order.

When the order entered pending payment status.

When the order was first shipped. If there are multiple shipments, this is when the first shipment shipped.

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

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.

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`.

The message in this gift, provided by the sender.

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

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

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

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).

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

The number of times the recipient viewed the gift.

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

An order batch is the primary resource created by the API. Order batches contain an array of orders.

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

The digital greeting card on this order batch.

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.

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

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

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.

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

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.

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.

The total number of recipients in this order batch.

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.

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

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.

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.

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

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](/introduction/send-methods).

The name of the brand that this shipment is from.

The estimated delivery time of this shipment.

bearer

List order batches

Goody's API lets you send physical products and gifts programmatically.

Overview

Goody API

Order lifecycle

Send methods

Enable Developer Mode on the Goody website to get product IDs and card IDs.

Developer mode

Ship products directly to an address with the Direct Send send method.

Ship to address

Sell physical products in your app without handling inventory, vendor partnerships, or logistics, and earn a revenue share on orders.

Goody Commerce API

Production and Sandbox accounts are separate, and you have different API keys for each environment for isolation.

Authentication

Commerce API: Authentication

Access the catalog

Commerce API: Access the product catalog

Create an order

Commerce API: Create an order

Retrieve order status

Commerce API: Retrieve order status

Webhooks allow you to be notified when events happen on Goody orders and order batches. You can subscribe to all webhooks, or a subset of them. Webhooks are sent by the Svix platform.

Webhooks

Commerce API: Webhooks

Payment

Commerce API: Payment

Goody Automation API

Automation API: Authentication

Automation API: Create an order

Automation API: Retrieve order status

Automation API: Webhooks

Automation API: Access the product catalog

Create automations without code using Zapier workflows

Zapier

Automation API: Zapier

Webhook Setup

To ensure the integrity of the webhooks you receive, we recommend verifying the signatures of the webhooks you receive. The webhook platform we use, Svix, provides packages for multiple languages that make verifying signatures easy.

Security

Webhook security

Event: order_batch.created

Emitted when a order batch is created in the organization.

order_batch.created

Emitted when an order batch is fully processed, which is when all orders are created for each recipient in the order batch.

order_batch.completed

Event: order_batch.completed

Emitted when an order has been created and is ready to be opened and accepted (if it's a gift). An individual gift link is available (`individual_gift_link`).

order.created

Event: order.created

Emitted when a gift is first opened. Note that if you open the gift link yourself, you might trigger this event.

order.gift_opened

Event: order.gift_opened

Emitted when a gift has been accepted by a recipient, and the final costs of the order have been calculated. You can also view whether they swapped the gift (`is_swapped`) and what they swapped to (`cart`).

order.gift_accepted

Event: order.gift_accepted

Emitted when the recipient adds a thank you note to a gift. This typically happens shortly after the gift has been accepted, but can happen anytime after acceptance. You can access the thank you note on the `thank_you_note` property of the order.

order.thank_you_note_added

Event: order.thank_you_note_added

Emitted when the order is shipped. If there are multiple shipments, this is emitted when the first shipment for this order is in transit.

order.shipped

Event: order.shipped

Emitted when an order has been delivered. If the order has multiple shipments, this is emitted when all shipments have been delivered.

Order Batches

Orders

Products

Payment Methods

Workspaces

Cards

Me

Schemas

List all order batches

Authorizations

Query Parameters

Response