API Reference

Goody

Commerce API Keys

Automation API Keys

OrderBatchRecipient

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

Event: order.delivered

order.canceled

Event: order.canceled

order.refunded

Event: order.refunded

Changelog

Create an order batch

List all order batches

Retrieve an order batch

Retrieve orders for an order batch

Retrieve recipients for an order batch

Calculate the price for an order batch

List all orders

Retrieve an order

Cancel an order

Update expiration for an order

List all active products

Retrieve a product

List all payment methods

List all workspaces

List all active cards

Retrieve current user

Error

ListMeta

OrderBatch

Order

Cart

CartItem

OrderBatchSendStatus

OrderStatus

Shipment

Product

Brand

ProductImage

ProductVariant

Image

MailingAddress

Sender

OrderBatchInput

CartInput

CartItemInput

OrderBatchSendMethod

RecipientInput