How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Goody Order Batches API

The Order Batches API from Goody — 5 operation(s) for order batches.

Goody Order Batches API is one of 12 APIs that Goody publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order Batches. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 6 operations across 5 paths, and defines 24 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against 2 base URLs: https://api.ongoody.com, https://api.sandbox.ongoody.com.

6 operations 5 paths 24 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.ongoody.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Goody Order Batches API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer).

  • bearer — Your Goody API key.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Order Batches 6
POST
/v1/order_batches
Create an order batch
body → 201400
GET
/v1/order_batches
List order batches
2 params → 200
GET
/v1/order_batches/{id}/orders
Retrieve orders for an order batch
3 params → 200400404
POST
/v1/order_batches/price
Calculate the price for an order batch
body → 200400
GET
/v1/order_batches/{id}/recipients
Retrieve recipients for an order batch
3 params → 200400404
GET
/v1/order_batches/{id}
Retrieve an order batch
1 param → 200404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Order (25 properties), OrderBatch (20 properties), OrderBatchInput (17 properties), Shipment (9 properties). Each schema is shown below with its type and property counts.

CartInput
object
1 property
OrderBatchPrice
object
The price for an order batch (all in cents).
2 properties 2 required
OrderBatchInternationalShippingTier
string
Whether to enable international shipping on this order. disabled (default) only enables US shipping on this order. standard combined with internationalgiftcard…
Cart
object
2 properties
OrderBatchPriceInput
object
Input parameters for an order batch price calculation.
3 properties 3 required
OrderBatchPriceCart
object
Prices for a single recipient's cart in cents. This represents the price for each recipient in the order batch.
8 properties 8 required
OrderBatchPriceTotal
object
Total price estimates for the entire order batch in cents. This includes all recipients.
5 properties 1 required
OrderBatchSendMethod
string
The method for sending a order batch. emailandlink sends a gift email to the recipient (specify email for each recipient). linkmultiplecustomlist generates a g…
OrderBatchInput
object
Input parameters for an order batch.
17 properties 4 required
OrderBatchSendStatus
string
Shipment
object
9 properties 3 required
OrderStatus
string
RecipientInput
object
5 properties 1 required
Order
object
An individual order contains the gift link to be sent to the recipient (if applicable) and other information about the order.
25 properties 9 required
Sender
object
3 properties 3 required
CartItemInput
object
5 properties 2 required
CartSelection
object
Product variant selections for a specific gift cart product.
4 properties 4 required
OrderBatch
object
An order batch is the primary resource created by the API. Order batches contain an array of orders.
20 properties 10 required
MailingAddress
object
8 properties 5 required
Error
object
1 property 1 required
OrderBatchSwap
string
What method to use to allow recipients to swap their gift. single (default) allows the recipient to swap the gift for one item, with hidden gift prices. multip…
ListMeta
object
1 property
CartItem
object
3 properties 3 required
OrderBatchRecipient
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

goody-order-batches-api-openapi.yml Raw ↑

Other APIs Goody publishes across the network.

Goody Brands API
Goody Cards API
Goody Collections API
Goody Commerce User Payment Methods API
Goody Me API
Goody Order Activities API
Goody Orders API
Goody Payment Methods API
Goody Products API
Goody Webhooks API
Goody Workspaces API
Where this information came from

This is an independent, third-party profile of Goody Order Batches API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.