canonical: https://jentic.com/apis/ote-godaddy.com/orders

# GoDaddy (OTE Test Environment) GoDaddy Orders API (OTE)

The GoDaddy Orders API (OTE - Operational Test Environment) provides access to order history and billing information for products purchased through GoDaddy. This test environment allows developers to retrieve order details, track purchase history, and access invoicing information for domain registrations, renewals, hosting services, and other GoDaddy products before deploying to production.

## For AI agents

Retrieve and manage GoDaddy order history, billing information, and purchase records in the OTE test environment.

## Scope

Does not process payments, issue refunds, or create orders - use only for retrieving and querying existing order history.

## Capabilities

- List all orders for an account with filtering by date range, domain, or product group
- Retrieve detailed information for a specific order including line items and payment details
- Filter orders by payment profile or parent order ID
- Paginate through large order histories with configurable limits and offsets
- Sort orders by creation date, modification date, or total amount

## Use cases

### Billing Reconciliation and Reporting

Finance teams can programmatically retrieve order history for reconciliation with payment systems. GET `/v1/orders` returns orders filtered by date range, product group, or payment profile. Agents can generate billing reports, match invoices to bank statements, and track spending across domain registrations, renewals, and other services.

Example prompt: GET `/v1/orders` with periodStart and periodEnd parameters covering the billing cycle, then aggregate order totals by product group.

### Customer Portal Order Lookup

SaaS platforms managing domain services for customers can provide order history through their own interfaces. GET `/v1/orders/{orderId}` retrieves full order details including line items and payment information. Combined with the X-Shopper-Id header, resellers can expose order history per customer account.

Example prompt: GET `/v1/orders` filtered by domain parameter to find the order, then GET `/v1/orders/{orderId}` for complete details.

### Automated Renewal Tracking

Operations teams can cross-reference domain renewals from the Domains API with actual billing via the Orders API. After calling POST `/v1/domains/{domain}/renew`, agents can verify the order was created and payment processed by searching orders by domain name and date range.

Example prompt: After domain renewal, wait 1-2 minutes then GET `/v1/orders` with domain filter to retrieve the renewal order and confirm payment status.

### AI Agent for Billing Operations

Let an AI agent handle billing inquiries for a web agency - retrieving order history, identifying charges, and matching orders to domains. Through Jentic, the agent loads only the required operations and the GoDaddy API key is injected at execution time.

Example prompt: Use the Jentic search query 'get godaddy order history' to find GET `/v1/orders`, load its schema, and execute with date range parameters.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/orders` | List orders with filtering by date, domain, product group, or payment profile |
| GET | `/v1/orders/{orderId}` | Get detailed information for a specific order |

## Key resources

- **Orders** — Purchase records with order IDs, dates, amounts, and payment status
- **Order Line Items** — Individual products purchased within an order
- **Payment Profiles** — Payment methods used for orders
- **Product Groups** — Categories of GoDaddy products (domains, hosting, SSL, etc.)

## Why Jentic

- **Setup:** Wiring the GoDaddy Orders API by hand means setting up the GoDaddy API key and secret pair, targeting the api.godaddy.com host, and handling retries yourself around order lookups. Through Jentic you install once, import the GoDaddy Orders API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Orders API puts the order id in the URL path (`/v1/orders/{orderId}`), so a rule can pin your agent to reading one order or listing order history. You choose the operations it may call, and since the surface is read-only, an agent can query orders without any ability to change them.
- **Credential handling:** Your GoDaddy API key and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list recent orders' or 'retrieve details for one order', and Jentic returns the matching GoDaddy Orders operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **GoDaddy Domains API (OTE)** — Manages domain registration and renewals that create orders in the Orders API.
- **GoDaddy Shoppers API (OTE)** — Manages customer account information linked to orders.
- **Stripe API** — Alternative payment and billing API for SaaS platforms managing their own billing.

## FAQ

### What is the GoDaddy OTE environment?

OTE (Operational Test Environment) is GoDaddy's sandbox for development and testing. It mirrors the production API but operates on test data and test orders. No real charges occur in OTE. Once integration is tested in OTE, switch to production credentials.

### What authentication does the GoDaddy Orders API use?

The GoDaddy API uses API key authentication sent via the Authorization header. API keys are generated in the GoDaddy developer portal. Through Jentic, keys are stored encrypted and injected at execution time.

### Can I retrieve orders for other GoDaddy accounts?

Yes, resellers and agencies can use the X-Shopper-Id header to retrieve orders for customer accounts they manage. This requires appropriate delegated access permissions.

### How do I find an order for a specific domain?

Use GET `/v1/orders` with the domain query parameter to filter orders by domain name. The response includes all orders associated with that domain.

### What order information is available through the API?

The API returns order IDs, creation and modification dates, total amounts, payment status, line items with product details, and payment profile information. Full invoice PDFs are not available via the API.