### Getting Started with Goody API

Source: https://developer.ongoody.com/commerce-api/overview

A guide for developers to begin integrating with the Goody API. It covers essential setup steps including account creation, obtaining API keys, sending gifts, and configuring webhooks for order event notifications.

```APIDOC
Getting Started Guide:

Steps to integrate with the Goody API:

1. Set up an account on our sandbox environment.
2. Obtain an API key for authentication.
3. Send a gift using the API.
4. Set up webhooks for order events.
```

--------------------------------

### Example JSX for Navigation

Source: https://developer.ongoody.com/api-reference/order-batches/create-an-order-batch

This snippet demonstrates how to render navigation links using JSX, likely within a React application. It includes links to 'Automation API Getting Started' and 'Commerce API Getting Started'.

```jsx
import { _jsx, _jsxs } from "react/jsx-runtime";
import { _components } from "./_components";

function MDXContent(props = {}) {
  // ... other content ...
  return _jsxs("div", {
    children: [
      "This is a guide for the ",
      _jsx(_components.a, {
        href: "/automation-api/create-an-order",
        children: "Automation API Getting Started"
      }),
      " guide or the ",
      _jsx(_components.a, {
        href: "/commerce-api/create-an-order",
        children: "Commerce API Getting Started"
      }),
      " guide."
    ]
  });
}

```

--------------------------------

### Goody Introduction

Source: https://developer.ongoody.com/commerce-api/overview

Guides for getting started with Goody, including an overview of the order lifecycle and developer mode.

```APIDOC
Introduction:
  Overview:
    - General introduction to the Goody platform.
  Order Lifecycle:
    - Detailed explanation of the stages an order goes through.
  Send Methods:
    - Available methods for sending data or requests.
  Developer Mode:
    - How to enable and utilize developer mode.
  Send to Address:
    - Instructions for sending data to specific addresses.
```

--------------------------------

### Getting Started Steps

Source: https://developer.ongoody.com/commerce-api/overview

Outlines the initial steps required to begin using the Goody Commerce API. This includes setting up an account in the sandbox environment, obtaining API credentials, sending a test gift, and configuring webhooks for order event notifications.

```javascript
function renderGettingStarted() {
  return (
    <>
      <p>In this guide, we’ll walk through how to:</p>
      <ol>
        <li>Set up an account on our sandbox environment</li>
        <li>Obtain an API key</li>
        <li>Send a gift</li>
        <li>Set up webhooks for order events.</li>
      </ol>
      <p>Let’s start with setting up an account and authentication.</p>
    </>
  );
}
```

--------------------------------

### Example JSX for Navigation

Source: https://developer.ongoody.com/api-reference

This snippet demonstrates how to render navigation links using JSX, likely within a React application. It includes links to 'Automation API Getting Started' and 'Commerce API Getting Started'.

```jsx
import { _jsx, _jsxs } from "react/jsx-runtime";
import { _components } from "./_components";

function MDXContent(props = {}) {
  // ... other content ...
  return _jsxs("div", {
    children: [
      "This is a guide for the ",
      _jsx(_components.a, {
        href: "/automation-api/create-an-order",
        children: "Automation API Getting Started"
      }),
      " guide or the ",
      _jsx(_components.a, {
        href: "/commerce-api/create-an-order",
        children: "Commerce API Getting Started"
      }),
      " guide."
    ]
  });
}

```

--------------------------------

### Automation API Order Creation Guide

Source: https://developer.ongoody.com/api-reference

Reference to the Automation API Getting Started guide for instructions on how to create an order. This guide provides the necessary steps and information for programmatic order creation.

```APIDOC
Automation API Getting Started:
  /automation-api/create-an-order
  - Provides documentation and examples for creating orders using the Automation API.
```

--------------------------------

### Getting Started with Goody APIs

Source: https://developer.ongoody.com/api-reference/~1v1~1order_batches

To begin using Goody's APIs, users must sign up for a Goody for Business account. Specific steps are required to obtain API keys for both the Automation and Commerce APIs, and to set up payment methods for production use.

```APIDOC
Sign Up:
  Visit https://www.ongoody.com/business for a Goody for Business account.

Automation API Key:
  For production: Navigate to your Account page and click 'API Keys'. A payment method must be added for production sending.
  For sandbox: Navigate to https://sandbox.ongoody.com/plus/account/api-keys and click 'API Keys'.

Commerce API Key:
  Refer to the "getting started guide" at /commerce-api/overview.
```

--------------------------------

### Introduction to Goody APIs

Source: https://developer.ongoody.com/api-reference/products/list-all-active-products

Provides foundational information for developers getting started with Goody. This section covers an overview of the platform, the order lifecycle, different sending methods, and developer mode.

```APIDOC
Introduction:
  - overview: "/introduction/overview"
  - order-lifecycle: "/introduction/order-lifecycle"
  - send-methods: "/introduction/send-methods"
  - developer-mode: "/introduction/developer-mode"
  - send-to-address: "/introduction/send-to-address"
```

--------------------------------

### Automation API Order Creation Guide

Source: https://developer.ongoody.com/api-reference/order-batches/create-an-order-batch

Reference to the Automation API Getting Started guide for instructions on how to create an order. This guide provides the necessary steps and information for programmatic order creation.

```APIDOC
Automation API Getting Started:
  /automation-api/create-an-order
  - Provides documentation and examples for creating orders using the Automation API.
```

--------------------------------

### Commerce API Order Creation Guide

Source: https://developer.ongoody.com/api-reference/order-batches/create-an-order-batch

Reference to the Commerce API Getting Started guide for instructions on how to create an order. This guide details the process for integrating order creation into commerce platforms.

```APIDOC
Commerce API Getting Started:
  /commerce-api/create-an-order
  - Provides documentation and examples for creating orders using the Commerce API.
```

--------------------------------

### Commerce API Order Creation Guide

Source: https://developer.ongoody.com/api-reference

Reference to the Commerce API Getting Started guide for instructions on how to create an order. This guide details the process for integrating order creation into commerce platforms.

```APIDOC
Commerce API Getting Started:
  /commerce-api/create-an-order
  - Provides documentation and examples for creating orders using the Commerce API.
```

--------------------------------

### Install Svix Webhook Libraries

Source: https://docs.svix.com/receiving/verifying-payloads/how

Instructions for installing the Svix webhook verification libraries for various programming languages and platforms. Ensure you have the correct package manager or tool installed for your environment.

```javascript
npm install svix
// or
yarn add svix
```

```python
pip install svix
```

```go
go get github.com/svix/svix-webhooks/go
```

```java
Gradle:
implementation "com.svix:svix:0.x.y"

Maven:
<dependency>
  <groupId>com.svix</groupId>
  <artifactId>svix</artifactId>
  <version>0.x.y</version>
</dependency>
```

```kotlin
Gradle:
implementation "com.svix.kotlin:svix-kotlin:0.x.y"

Maven:
<dependency>
  <groupId>com.svix.kotlin</groupId>
  <artifactId>svix-kotlin</artifactId>
  <version>0.x.y</version>
</dependency>
```

```ruby
gem install svix
```

```csharp
composer require svix/svix
// or
dotnet add package Svix
```

```cli
macOS:
brew install svix/svix/svix-cli

Windows:
scoop bucket add svix https://github.com/svix/scoop-svix.git
scoop install svix

For other platforms, checkout the CLI docs on Github.
```

```curl
# Install cURL. E.g. on arch linux:
pacman -S curl
```

--------------------------------

### Ongoody Commerce API /me Endpoint Example

Source: https://context7_llms

Provides an example of how to call the `/me` endpoint to verify authentication. It includes the request details and the expected JSON response.

```APIDOC
Calling /me:
To check that you're authenticated, you can send a request to the `/me` endpoint:

GET https://api.sandbox.ongoody.com/v1/me
Authorization: Bearer YOUR_GOODY_COMMERCE_API_KEY

And it should respond with:

{
  "public_app_id": "YOUR_PUBLIC_APP_ID"
}
```

--------------------------------

### Example Order Batch Payload

Source: https://context7_llms

A JSON example demonstrating the structure for creating an order batch to send a gift.

```JSON
{
  "from_name": "John",
  "send_method": "link_multiple_custom_list",
  "recipients": [
    {
      "first_name": "Alena",
      "last_name": "Kenter",
      "email": "alena@ongoody.com"
    }
  ],
  "cart": {
    "items": [
      {
        "product_id": "9abf2d67-e4f3-4d43-9142-4a1f0d10aaa0",
        "quantity": 1
      }
    ]
  },
  "payment_method_id": "COMMERCE_STORED_VALUE",
  "card_id": "ff957080-192d-4032-b4c5-fbb057141c4b",
  "message": "Thank you!"
}
```

--------------------------------

### Goody Automation API Overview

Source: https://developer.ongoody.com/commerce-api/overview

Guides for using the Goody Automation API, covering authentication, order creation, status retrieval, and webhook integration.

```APIDOC
Automation API:
  Overview:
    - Functionality for automating workflows within the Goody platform.
  Authentication:
    - Methods for authenticating automation requests.
  Create an Order:
    - API calls to create orders programmatically.
  Retrieve Order Status:
    - Fetching the current status of automated orders.
  Webhooks:
    - Setting up and handling webhooks for automation events.
  Access the Catalog:
    - Accessing product catalog data for automation purposes.
  Zapier:
    - Integration details for Zapier workflows.
```

--------------------------------

### Create Order Batch Response Example

Source: https://developer.ongoody.com/automation-api/create-an-order

This snippet shows an example JSON response for the create order batch operation, detailing the structure of a successful order creation.

```json
{
  "id": "f0903768-609c-4851-bc9a-c17ea245e120",
  "status": "pending"
}
```

--------------------------------

### Goody Commerce API: Order Creation

Source: https://developer.ongoody.com/api-reference

Guides on creating new orders via the Goody Commerce API. This covers the necessary steps and parameters for initiating an order.

```APIDOC
commerce-api/create-an-order
  - Step-by-step instructions and API endpoints for creating a new order.
```

--------------------------------

### Next.js MDX Content Rendering Setup

Source: https://developer.ongoody.com/api-reference/commerce-user-payment-methods/create-a-commerce-user-payment-method

This snippet details the initialization and configuration for rendering MDX content within a Next.js application. It includes setup for fragments, JSX transformation, and component provision, essential for dynamic content pages.

```javascript
self.__next_f.push([1,"31:[\"$\",\"$L1f\",null,{\"id\":\"\_mintlify-page-mode-script\",\"strategy\":\"beforeInteractive\",\"dangerouslySetInnerHTML\":{\"__html\":\"document.documentElement.setAttribute('data-page-mode', 'none');\"}}]\n32:[\"$\",\"$L36\",null,{\"theme\":\"mint\"}]\n33:[[\"$\",\"span\",null,{\"className\":\"fixed inset-0 bg-background-light dark:bg-background-dark -z-10 pointer-events-none\"}],null,false,false]\n3e:T8c4,\"\n
```

--------------------------------

### Install Svix Webhook Packages

Source: https://context7_llms

Install the Svix SDK for various programming languages to easily verify incoming webhook signatures. These commands cover package managers like npm, yarn, pip, gem, and dependency management tools like Cargo, Go modules, Gradle, Maven, and Composer.

```JavaScript
npm install svix
// Or
yarn add svix
```

```Python
pip install svix
```

```Ruby
gem install svix
```

```Rust
svix = "0"
```

```Go
go get github.com/svix/svix-webhooks/go
```

```Java (Gradle)
implementation "com.svix:svix:0.x.y"
```

```Java (Maven)
<dependency>
  <groupId>com.svix</groupId>
  <artifactId>svix</artifactId>
  <version>0.x.y</version>
</dependency>
```

```Kotlin (Gradle)
implementation "com.svix.kotlin:svix-kotlin:0.x.y"
```

```Kotlin (Maven)
<dependency>
  <groupId>com.svix.kotlin</groupId>
  <artifactId>svix-kotlin</artifactId>
  <version>0.x.y</version>
</dependency>
```

```C#
dotnet add package Svix
```

```PHP
composer require svix/svix
```

--------------------------------

### Order Batch Creation Response Example

Source: https://context7_llms

Example JSON response for creating an order batch. It includes details about the batch status, sender, recipient previews, and the initial cart items. The `send_status` field indicates whether orders were processed immediately or are pending background creation.

```json
{
  "id": "f0903768-609c-4851-bc9a-c17ea245e120",
  "send_status": "complete",
  "from_name": "John",
  "message": "Thank you!",
  "orders_count": 1,
  "orders_preview": [
    {
      "id": "a74adf4b-1837-43f5-8e51-f74803cd8832",
      "status": "created",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "alena@ongoody.com",
      "individual_gift_link": "https://gifts.ongoody.com/gift/gHBMKuXkiVgAFDyXx00h4XGs",
      "card_id": "ff957080-192d-4032-b4c5-fbb057141c4b",
      "message": "Thank you!",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "f0903768-609c-4851-bc9a-c17ea245e120",
      "cart": {
        "id": "fad70b58-896e-4e11-b80b-d807f57e5e3d",
        "items": [
          {
            "id": "0bc34fa6-d036-4300-a743-dec8eda7f2bd",
            "quantity": 1,
            "product": {
              "id": "9abf2d67-e4f3-4d43-9142-4a1f0d10aaa0",
              "name": "Cookies",
              "brand": {
                "id": "d8782dff-10b2-49ca-87ed-ed6c9d34e4bd",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "shipments": [],
      "amounts": {
        "amount_product": 1000,
        "amount_shipping": 1000,
        "amount_processing_fee": 100,
        "amount_pre_tax_total": 2100,
        "amount_tax": null,
        "amount_total": null,
        "amount_global_relay_cost": null
      },
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "15557426864@test.ongoody.com"
      },
      "workspace_id": "b99bf758-104f-4570-a3a9-bc59e64646b1",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "5NRQ9IKCVECOHFCUOZWJHTWW"
    }
  ],
  "recipients_count": 1,
  "recipients_preview": [
    {
      "first_name": "Alena",
      "last_name": "Kenter",
      "email": "alena@ongoody.com"
    }
  ],
  "cart": {
    "id": "fad70b58-896e-4e11-b80b-d807f57e5e3d",
    "items": [
      {
        "id": "0bc34fa6-d036-4300-a743-dec8eda7f2bd",
        "quantity": 1,
        "product": {
          "id": "9abf2d67-e4f3-4d43-9142-4a1f0d10aaa0",
          "name": "Cookies",
          "brand": {
            "id": "d8782dff-10b2-49ca-87ed-ed6c9d34e4bd",
            "name": "Cookie Company"
          }
        }
      }
    ]
  },
  "is_scheduled_send": false,
  "scheduled_send_on": null,
  "expires_at": null,
  "send_method": "link_multiple_custom_list",
  "batch_name": "Alena Kenter",
  "card_id": "ff957080-192d-4032-b4c5-fbb057141c4b",
  "sender": {
    "first_name": "Test",
    "last_name": "User",
    "email": "15557426864@test.ongoody.com"
  },
  "workspace_id": "b99bf758-104f-4570-a3a9-bc59e64646b1",
  "workspace_name": "Test Team",
  "reference_id": "XNYLJMW5JIFOFRM0PQIPNA56"
}
```

--------------------------------

### Go: Standard Library Webhook Handling

Source: https://docs.svix.com/receiving/verifying-payloads/how

Provides an example of setting up an HTTP server using Go's standard library to receive and verify incoming webhooks. It demonstrates how to read the request body and headers for signature verification with the Svix Go library.

```go
package main

import (
	"io"
	"log"
	"net/http"
	svix "github.com/svix/svix-webhooks/go"
)

const secret = "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"

func main() {
	wh, err := svix.NewWebhook(secret)
	if err != nil {
		log.Fatal(err)
	}

	http.HandleFunc("/webhook", func(w http.ResponseWriter, r *http.Request) {
		headers := r.Header
	
payload, err := io.ReadAll(r.Body)
		if err != nil {
			w.WriteHeader(http.StatusBadRequest)
			return
		}

		err = wh.Verify(payload, headers)
		if err != nil {
			w.WriteHeader(http.StatusBadRequest)
			return
		}

		// Do something with the message...
		w.WriteHeader(http.StatusNoContent)
	})

	log.Println("Starting server on :8080")
	http.ListenAndServe(":8080", nil)
}
```

--------------------------------

### Mintlify Documentation Configuration

Source: https://developer.ongoody.com/api-reference/products/list-all-active-products

Configuration object for Mintlify, specifying theme, project name, colors, favicon, and the structure of the navigation menu. It lists sections for Introduction, Commerce API, and Automation API.

```json
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Goody",
  "colors": {
    "primary": "#9159D6",
    "light": "#B584F1",
    "dark": "#9159D6"
  },
  "favicon": "/favicon.png",
  "navigation": {
    "anchors": [
      {
        "anchor": "Documentation",
        "icon": "book-open",
        "groups": [
          {
            "group": "Introduction",
            "pages": [
              "introduction/overview",
              "introduction/order-lifecycle",
              "introduction/send-methods",
              "introduction/developer-mode",
              "introduction/send-to-address"
            ]
          },
          {
            "group": "Commerce API",
            "pages": [
              "commerce-api/overview",
              "commerce-api/authentication",
              "commerce-api/access-the-catalog",
              "commerce-api/create-an-order",
              "commerce-api/retrieve-order-status",
              "commerce-api/webhooks",
              "commerce-api/payment",
              "commerce-api/embedded-payment-form"
            ]
          },
          {
            "group": "Automation API",
            "pages": [
              "automation-api/overview",
              "automation-api/authentication",
              "automation-api/create-an-order",
              "automation-api/retrieve-order-status",
              "automation-api/webhooks",
              "automation-api/access-the-catalog",
              "automation-api/zapier"
            ]
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Goody API Overview

Source: https://developer.ongoody.com/commerce-api/embedded-payment-form

Provides a general overview of the Goody API, its purpose, and how to get started.

```APIDOC
Commerce API:
  Overview
    - Provides access to Goody's e-commerce functionalities.

Automation API:
  Overview
    - Enables automation of business processes within Goody.

Webhooks:
  Overview
    - Information on receiving real-time event notifications from Goody.
```

--------------------------------

### Retrieve Order Batch using cURL

Source: https://developer.ongoody.com/api-reference/order-batches/retrieve-an-order-batch

Demonstrates how to fetch order batch details using the cURL command-line tool. This example shows the necessary GET request, URL structure, and how to include the authorization token.

```bash
curl --request GET \
  --url https://api.ongoody.com/v1/order_batches/{id} \
  --header 'Authorization: Bearer <token>'
```

--------------------------------

### Next.js Initialization - Root Layout and Banner Logic

Source: https://developer.ongoody.com/introduction/developer-mode

Defines the root layout structure, including head elements, script for banner state management, and links to external CSS and KaTeX. This snippet sets up the main HTML structure, handles dynamic banner visibility based on local storage, and includes essential stylesheets and math rendering libraries.

```javascript
self.__next_f.push([1, "0:{\"P\":null,\"b\":\"J5X0FjWc8NWmED0AfvH0Y\",\"p\":\"/mintlify-assets\",\"c\":[\"\",\"_sites\",\"developer.ongoody.com\",\"introduction\",\"developer-mode\"],\"i\":false,\"f\":[[[\"\",{\"children\":[\"%5Fsites\",{\"children\":[[ \"subdomain\", \"developer.ongoody.com\", \"d\"],{\"children\":[[ \"(multitenant)\",{\"topbar\":[\"children\",{\"children\":[[\"slug\", \"introduction/developer-mode\", \"oc\"],{\"children\":[[\"__PAGE__\",{}]]}]},\"children\":[[\"slug\", \"introduction/developer-mode\", \"oc\"],{\"children\":[[\"__PAGE__\",{}]]}]}]}]},\"$undefined\",\"$undefined\",true], [\"\",[\"$\",\"$1\",\"c\",{\"children\":[[[\"$\",\"link\",\"0\",{\"rel\":\"stylesheet\",\"href\":\"/mintlify-assets/_next/static/css/ca797da4e9f8f21c.css\",\"precedence\":\"next\",\"crossOrigin\":\"$undefined\",\"nonce\":\"$undefined\"}], [\"$\",\"link\",\"1\",{\"rel\":\"stylesheet\",\"href\":\"/mintlify-assets/_next/static/css/f61b4e54ca51c353.css\",\"precedence\":\"next\",\"crossOrigin\":\"$undefined\",\"nonce\":\"$undefined\"}]]}, [\"$\",\"html\",null,{\"suppressHydrationWarning\":true,\"lang\":\"en\",\"className\":\"__variable_5f106d __variable_3bbdad dark\",\"data-banner-state\":\"visible\",\"data-page-mode\":\"none\",\"children\":[[\"$\",\"head\",null,{\"children\":[[\"$\",\"script\",null,{\"type\":\"text/javascript\",\"dangerouslySetInnerHTML\":{\"__html\":\"(function(a,b,c){try{let d=localStorage.getItem(a);if(null==d)for(let c=0;c<localStorage.length;c++){let e=localStorage.key(c);if(e?.endsWith(`-${b}`))&& (d=localStorage.getItem(e),null!=d)){localStorage.setItem(a,d),localStorage.setItem(e,d);break}}let e=document.getElementById(\"banner\")?.innerText,f=null==d||!!e&&d!==e;document.documentElement.setAttribute(c,f?\\"visible\\":\\"hidden\\\")}catch(a){console.error(a),document.documentElement.setAttribute(c,\\"hidden\\\")}})(\\n \\"__mintlify-bannerDismissed\\",\\n \\"bannerDismissed\\",\\n \\"data-banner-state\\",\\n)\"}}], [\"$\",\"link\",null,{\"rel\":\"stylesheet\",\"href\":\"https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css\",\"integrity\":\"sha384-Xi8rHCmBmhbuyyhbI88391ZKP2dmfnOl4rT9ZfRI7mLTdk1wblIUnrIq35nqwEvC\",\"crossOrigin\":\"anonymous\"}]]}, [\"$\",\"body\",null,{\"children\":[[\"$\",\"$L2\",null,{\"parallelRouterKey\":\"children\",\"error\":\"$3\",\"errorStyles\":[],\"errorScripts\":[],\"template\":[\"$\",\"$L
```

--------------------------------

### Next.js Initialization - Site and Chunk Configuration

Source: https://developer.ongoody.com/introduction/developer-mode

Loads detailed configuration for site structure, routing, and JavaScript chunks. This snippet includes references to various static chunk files and defines the application's site structure, including tenant-specific routing.

```javascript
self.__next_f.push([1, "5:I[85506,[\"3473\",\"static/chunks/891cff7f-2ca7d0df884db9d0.js\",\"4129\",\"static/chunks/7bf36345-5ba13855b95a82b2.js\",\"1725\",\"static/chunks/d30757c7-d1a658b63aa94b97.js\",\"803\",\"static/chunks/cd24890f-549fb4ba2f588ca6.js\",\"7261\",\"static/chunks/7261-1f4bcac893329b6b.js\",\"3892\",\"static/chunks/3892-251b69e2384ed286.js\",\"7417\",\"static/chunks/7417-548f041b716e378a.js\",\"1953\",\"static/chunks/1953-639d64e349958881.js\",\"9095\",\"static/chunks/9095-5e8c25cebc4b2bd6.js\",\"9779\",\"static/chunks/9779-7bb45d52151006b8.js\",\"3619\",\"static/chunks/3619-3e497b0446e2fdfc.js\",\"2398\",\"static/chunks/2398-3c77a562bc9286bb.js\",\"1862\",\"static/chunks/1862-2618531eb3119cc9.js\",\"2755\",\"static/chunks/2755-e2a765a591a8496d.js\",\"1350\",\"static/chunks/1350-f25dfa5f4f88ddb4.js\",\"5456\",\"static/chunks/app/%255Fsites/%5Bsubdomain%5D/(multitenant)/layout-b596e085fd7c2d45.js\"],\"ThemeProvider\" ]\n"]);
```

--------------------------------

### Example Application Integration

Source: https://developer.ongoody.com/commerce-api/embedded-payment-form

Links to example applications demonstrating integration with Goody's Commerce API using Next.js for the frontend and Python FastAPI for the backend. These resources provide practical code examples for implementation.

```APIDOC
GitHub Repository:
  URL: https://github.com/ongoody/commerce-api-dcc-sample-fastapi-nextjs
  Description: Source code for an example app with a Next.js frontend and Python FastAPI backend.

Live Demo:
  URL: https://commerce-api-dcc-sample-fastapi-nextjs.vercel.app/
  Description: A live demonstration of the example application.
```

--------------------------------

### Example Data Structure

Source: https://developer.ongoody.com/api-reference/orders/cancel-an-order

An example JSON structure representing order or payment-related data, including sender information and workspace details.

```json
{
  "amount_total": null,
  "amount_global_relay_cost": null
},
"sender": {
  "first_name": "Test",
  "last_name": "User",
  "email": "15552839974@test.ongoody.com"
},
"workspace_id": "3075861c-6678-4cc1-95e2-37dd1f24cf6e",
"workspace_name": "Test Team",
"original_cart": null,
"original_amounts": null,
"reference_id": "SAVWCIEL10ROW00L9UEJ6HKI",
"payment_link": null
```

--------------------------------

### Example Data Payload

Source: https://developer.ongoody.com/commerce-api/create-an-order

This snippet shows an example JSON payload representing user or workspace information, likely used in API requests or responses.

```json
{
  "email": "15557426864@ongoody.com",
  "workspace_id": "b99bf758-104f-4570-a3a9-bc59e64646b1",
  "workspace_name": "Test Team",
  "reference_id": "XNYLJMW5JIFOFRM0PQIPNA56"
}
```

--------------------------------

### Goody Webhooks: Event Handling

Source: https://developer.ongoody.com/api-reference/order-batches/create-an-order-batch

Documentation for setting up and managing webhooks in Goody. This includes an overview of webhook security and a list of available event types.

```APIDOC
webhooks/overview
  - General information about Goody's webhook system.
webhooks/webhook-security
  - Best practices and methods for securing webhook endpoints.
webhooks/events/order_batch.created
  - Triggered when a new order batch is created.
webhooks/events/order_batch.completed
  - Triggered when an order batch processing is completed.
webhooks/events/order.created
  - Triggered when a new order is successfully created.
webhooks/events/order.gift_opened
  - Triggered when a gift associated with an order is opened.
webhooks/events/order.gift_accepted
  - Triggered when a gift associated with an order is accepted.
webhooks/events/order.thank_you_note_added
  - Triggered when a thank you note is added to an order.
webhooks/events/order.shipped
  - Triggered when an order has been shipped.
webhooks/events/order.delivered
  - Triggered when an order has been successfully delivered.
webhooks/events/order.canceled
  - Triggered when an order has been canceled.
webhooks/events/order.refunded
  - Triggered when an order has been refunded.
```

--------------------------------

### Goody Automation API: Order Creation

Source: https://developer.ongoody.com/api-reference

Guides on creating new orders via the Goody Automation API. This covers the necessary steps and parameters for initiating an order programmatically.

```APIDOC
automation-api/create-an-order
  - Step-by-step instructions and API endpoints for creating a new order via automation.
```

--------------------------------

### Example: Sending a Gift Batch

Source: https://developer.ongoody.com/commerce-api/create-an-order

A conceptual example illustrating the structure of a request to create an order batch for sending gifts. This includes the `recipients` array.

```javascript
function createGiftBatch() {
  // Example payload structure for creating an order batch
  const orderBatchPayload = {
    recipients: [
      {
        // recipient details like email, name, etc.
      },
      // ... more recipients
    ],
    // other batch-level configurations
  };

  // Call to the POST /v1/order_batches endpoint would go here
  // fetch('/v1/order_batches', { method: 'POST', body: JSON.stringify(orderBatchPayload) })
  // .then(response => response.json())
  // .then(data => console.log(data));
}
```

--------------------------------

### Order Created Event JSON Example

Source: https://context7_llms

An example JSON payload for the `order.created` webhook event, illustrating the structure and data fields emitted when an order is created.

```json
{
  "event_type": "order.created",
  "id": "ad097c47-bf12-45c9-8feb-0536a0012c09",
  "data": {
    "id": "10c588dd-d566-45bf-86e9-c23bd1f1587b",
    "status": "created",
    "individual_gift_link": "https://gifts.ongoody.com/gift/vWtUe8lQRJuoyYzKlYeHMkbV",
    "recipient_first_name": "Alena",
    "recipient_last_name": "Kenter",
    "recipient_email": "alena@ongoody.com",
    "card_id": "ae4cb4ce-75fc-4782-a9ab-2f30d9b7b41d",
    "message": "Thank you!",
    "thank_you_note": null,
    "view_count_recipient": 0,
    "is_swapped": false,
    "order_batch_id": "4133078a-c35f-441e-8e92-57645342b299",
    "expires_at": null,
    "cart": {
      "id": "39b04e91-6a40-468d-8ed4-f59e9059afae",
      "items": [
        {
          "id": "d59dead0-a44c-44df-885f-030612038a48",
          "quantity": 1,
          "product": {
            "id": "c399bafb-3fbc-40c5-bef3-9158b7a19abc",
            "name": "Cookies",
            "brand": {
              "id": "db631527-c59c-409c-823f-42a24c972283",
              "name": "Cookie Company"
            }
          }
        }
      ]
    },
    "shipments": [],
    "amounts": {
      "amount_product": 1000,
      "amount_shipping": 1000,
      "amount_processing_fee": 100,
      "amount_pre_tax_total": 2100,
      "amount_tax": null,
      "amount_total": null,
      "amount_global_relay_cost": null
    },
    "sender": {
      "first_name": "Test",
      "last_name": "User",
      "email": "15556038009@test.ongoody.com"
    },
    "workspace_id": "8779bb01-ca47-4e9e-a845-d05f509c4be3",
    "workspace_name": "Test Team",
    "original_cart": null,
    "original_amounts": null,
    "reference_id": "PCI7GLZ3KFIEN8MWWSD5LDCF"
  }
}
```

--------------------------------

### Goody Webhook Events and Setup

Source: https://context7_llms

This section details the available webhook events for Goody orders and order batches, and outlines the process for setting up a new webhook endpoint. It includes parameters for configuring webhook delivery and filtering.

```APIDOC
Automation API: Webhooks

Description:
  Allows real-time notifications for events related to Goody orders and order batches. Requires organization administrator privileges.

Setup:
  To set up webhooks, navigate to Organization > Automation API.

  Parameters:
    Endpoint URL: The URL where webhook events will be sent.
    Message Filtering: Allows selection of specific events to receive. Leave blank to receive all events.

Available Webhook Events:
  - order_batch.created: Notifies when an order batch is newly created. The batch might still be processing or scheduled for the future.
  - order_batch.completed: Notifies when an order batch is fully processed and all associated orders have been created.
  - order.created: Notifies when an order is created and ready for processing.
  - order.gift_opened: Notifies when a gift associated with an order is opened by the recipient.
  - order.gift_accepted: Notifies when a gift associated with an order has been accepted by the recipient.
  - order.thank_you_note_added: Notifies when a recipient adds a thank you note to an order after accepting it.
  - order.shipped: Notifies when an order begins its shipping process. For orders with multiple shipments, this event triggers on the first shipment.
  - order.delivered: Notifies when an order is fully delivered. For orders with multiple shipments, this event triggers when all shipments are delivered.
  - order.canceled: Notifies when an order has been canceled.
  - order.refunded: Notifies when an order has been refunded.

Security:
  It is recommended to verify webhook signatures using Svix packages to ensure integrity. Refer to the Webhook Security page for implementation details.

Logs:
  Webhook delivery logs are available for each endpoint, allowing for monitoring and re-sending of failed webhooks.
```

--------------------------------

### Mintlify Documentation Configuration

Source: https://developer.ongoody.com/commerce-api/create-an-order

Configuration object for Mintlify, defining the documentation theme, site name, colors, favicon, and navigation structure. It outlines the organization of content into sections like Introduction, Commerce API, Automation API, Webhooks, and Resources.

```json
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Goody",
  "colors": {
    "primary": "#9159D6",
    "light": "#B584F1",
    "dark": "#9159D6"
  },
  "favicon": "/favicon.png",
  "navigation": {
    "anchors": [
      {
        "anchor": "Documentation",
        "icon": "book-open",
        "groups": [
          {
            "group": "Introduction",
            "pages": [
              "introduction/overview",
              "introduction/order-lifecycle",
              "introduction/send-methods",
              "introduction/developer-mode",
              "introduction/send-to-address"
            ]
          },
          {
            "group": "Commerce API",
            "pages": [
              "commerce-api/overview",
              "commerce-api/authentication",
              "commerce-api/access-the-catalog",
              "commerce-api/create-an-order",
              "commerce-api/retrieve-order-status",
              "commerce-api/webhooks",
              "commerce-api/payment",
              "commerce-api/embedded-payment-form"
            ]
          },
          {
            "group": "Automation API",
            "pages": [
              "automation-api/overview",
              "automation-api/authentication",
              "automation-api/create-an-order",
              "automation-api/retrieve-order-status",
              "automation-api/webhooks",
              "automation-api/access-the-catalog",
              "automation-api/zapier"
            ]
          },
          {
            "group": "Webhooks",
            "pages": [
              "webhooks/overview",
              "webhooks/webhook-security",
              {
                "group": "Events",
                "pages": [
                  "webhooks/events/order_batch.created",
                  "webhooks/events/order_batch.completed",
                  "webhooks/events/order.created",
                  "webhooks/events/order.gift_opened",
                  "webhooks/events/order.gift_accepted",
                  "webhooks/events/order.thank_you_note_added",
                  "webhooks/events/order.shipped",
                  "webhooks/events/order.delivered",
                  "webhooks/events/order.canceled",
                  "webhooks/events/order.refunded"
                ]
              }
            ]
          },
          {
            "group": "Resources",
            "pages": [
              "resources/changelog"
            ]
          }
        ]
      },
      {
        "anchor": "API Reference",
        "icon": "code"
      }
    ]
  }
}
```

--------------------------------

### Order Batch Creation Payload Example

Source: https://developer.ongoody.com/commerce-api/create-an-order

An example JSON payload demonstrating the structure required to create an order batch. It specifies sender details and recipient information.

```json
{
  "from_name": "John",
  "send_method": "link_multiple_custom_list",
  "recipients": [
    {
      "first_name": "Alena",
      "last_name": "Doe"
    }
  ]
}
```