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

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

The GoDaddy Shoppers API (OTE - Operational Test Environment) provides programmatic access to customer account management, including creating subaccounts, managing shopper profiles, and accessing customer information. This test environment is designed for resellers and agencies managing multiple customer accounts before deploying to production. Shoppers are the core account entities in the GoDaddy system that own domains, orders, and other resources.

## For AI agents

Manage GoDaddy customer accounts and shopper profiles: create subaccounts, retrieve shopper information, and manage customer relationships in the OTE test environment.

## Scope

Does not manage authentication, passwords, or login sessions - use only for account provisioning and profile management in the context of domain operations.

## Capabilities

- Create subaccounts under a reseller or parent account
- Retrieve shopper profile information including contact details and account status
- Manage customer account relationships for resellers and agencies
- Access shopper IDs for use with other GoDaddy API operations
- Update shopper profile information and preferences

## Use cases

### Reseller Account Provisioning

Web hosting resellers and agencies can programmatically create and manage customer subaccounts. POST `/v1/shoppers/subaccount` creates a new shopper account linked to the reseller, returning a shopper ID that can be used with the X-Shopper-Id header in Domains and Orders API calls. This enables white-label domain management where customers never interact directly with GoDaddy.

Example prompt: POST `/v1/shoppers/subaccount` with customer contact details to create the account, then use the returned shopperId with X-Shopper-Id header in domain operations.

### Multi-Tenant Customer Management

SaaS platforms offering domain services can maintain separate shopper accounts per customer for billing isolation and access control. GET `/v1/shoppers/{shopperId}` retrieves profile information, and PUT `/v1/shoppers/{shopperId}` updates account details. Combined with the Domains and Orders APIs, this enables full multi-tenant domain portfolio management.

Example prompt: GET `/v1/shoppers/{shopperId}` to retrieve customer profile, then use that shopper ID in GET `/v1/domains` with X-Shopper-Id to list their domains.

### Agency Customer Onboarding

Web agencies onboarding new clients can automate account creation and initial domain setup. POST `/v1/shoppers/subaccount` provisions the account, followed by POST `/v1/domains/purchase` with the X-Shopper-Id header to register domains under the client's account. Agents can orchestrate multi-step onboarding workflows without manual account creation.

Example prompt: POST `/v1/shoppers/subaccount` for the new client, capture the shopperId, then POST `/v1/domains/purchase` with X-Shopper-Id header to register their domain.

### AI Agent for Customer Operations

Let an AI agent handle customer account tasks for a reseller - creating subaccounts, looking up shopper information, and managing customer relationships. 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 'create godaddy subaccount' to find POST `/v1/shoppers/subaccount`, load its schema, and execute with customer contact information.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/shoppers/subaccount` | Create a new subaccount under the authenticated reseller account |
| GET | `/v1/shoppers/{shopperId}` | Retrieve shopper profile information |
| PUT | `/v1/shoppers/{shopperId}` | Update shopper profile information |
| GET | `/v1/shoppers` | List shoppers with filtering options |

## Key resources

- **Shoppers** — Customer account entities that own domains, orders, and other GoDaddy resources
- **Subaccounts** — Child shopper accounts linked to reseller or agency parent accounts
- **Shopper Profiles** — Contact information, preferences, and account metadata
- **Shopper IDs** — Unique identifiers used with X-Shopper-Id header for multi-account operations

## Why Jentic

- **Setup:** Wiring the GoDaddy Shoppers API by hand means setting up the GoDaddy API key and secret pair, targeting the api.godaddy.com host, and managing your own retries around account provisioning calls. Through Jentic you install once, import the GoDaddy Shoppers API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Shoppers API puts the shopper id in the URL path (`/v1/shoppers/{shopperId}`), so a rule can pin your agent to reading one shopper. You choose the operations it may call, so subaccount creation and profile updates are not included unless you add 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 'create a shopper subaccount' or 'read a shopper profile', and Jentic returns the matching GoDaddy Shoppers operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **GoDaddy Domains API (OTE)** — Manages domains owned by shoppers created via the Shoppers API.
- **GoDaddy Orders API (OTE)** — Retrieves order history for shoppers managed via the Shoppers API.
- **Auth0 Management API** — Alternative customer identity and account management for custom applications.

## FAQ

### What is a shopper in the GoDaddy API?

A shopper is a customer account entity in the GoDaddy system that owns domains, orders, and other resources. Each shopper has a unique shopper ID that can be used with the X-Shopper-Id header to perform operations on behalf of that account.

### 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 accounts. No real charges or account changes occur in OTE.

### Who can create subaccounts?

Only reseller accounts with appropriate permissions can create subaccounts via POST `/v1/shoppers/subaccount.` Standard customer accounts cannot create subaccounts. Reseller status is configured in the GoDaddy developer portal.

### How do I use a shopper ID with other APIs?

Include the X-Shopper-Id header in requests to the Domains, Orders, or other GoDaddy APIs. This tells the API to perform the operation on behalf of that shopper account rather than the authenticated account.

### Can I retrieve a list of all subaccounts I've created?

The specific endpoint for listing subaccounts depends on the API version and your account permissions. Contact GoDaddy developer support for the exact endpoint to list subaccounts under your reseller account.

### Can I limit what my agent is allowed to do with the GoDaddy Shoppers API?

Yes. Because you run Jentic One yourself, you decide which Shoppers operations your agent may call, so you can allow it to read a profile with GET `/v1/shoppers/{shopperId}` while withholding subaccount creation via POST `/v1/shoppers/subaccount` and profile updates via PUT `/v1/shoppers/{shopperId}.` Since the shopper id sits in the URL path, your own rules can pin the agent to a single shopper rather than every account under your reseller. Your GoDaddy API key and secret are stored by your instance and injected only at execution time, so the agent never sees them.