# Glossary (https://developer.godaddy.com/en/docs/api-users/glossary) --- title: Glossary description: Definitions for terms used throughout the GoDaddy API documentation. keywords: >- async operation 202 poll, Classic Developer Key sso-key, Good as Gold prepaid balance, idempotency key UUID, mailbox provisioning entitlement, OTE sandbox environment, payment request checkout session, quote token expiry, rate limit 429 retry, redemption period recovery, registry lock out-of-band, scope bundle PAT picker, SKU fulfillment order status, status polling exponential backoff, TTL minimum 600 related: guides: - title: Authenticate href: /docs/api-users/auth - title: Rate limits href: /docs/api-users/rate-limits - title: Error handling href: /docs/api-users/errors - title: Manage orders and customers href: /docs/api-users/commerce/manage-orders-and-customers --- Learn about the terms used throughout the GoDaddy API documentation. Entries cover concepts that apply across all APIs as well as terms specific to [Domains](https://developer.godaddy.com/docs/api-users/domains), [Commerce](https://developer.godaddy.com/docs/api-users/commerce), and [Email](https://developer.godaddy.com/docs/api-users/email). API-specific terms are labeled *(Domains)*, *(Commerce)*, or *(Email)* in the Term column. Unlabeled terms apply across all GoDaddy REST APIs. | Term | Definition | | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **async operation** | An API operation that returns `202 Accepted` immediately and continues processing in the background. The caller receives an operation ID and polls a status endpoint until the operation reaches `COMPLETED` or `FAILED`. Domain registration, domain transfers, and mailbox provisioning use async operations. See [status polling](#status-polling). | | **authoritative nameserver** *(Domains)* | The nameserver that holds the definitive DNS records for a domain. When you update DNS records through the GoDaddy API, the change is applied to GoDaddy's authoritative nameservers. External resolvers cache the previous values until the TTL expires. See [TTL](#ttl-time-to-live). | | **channel** *(Commerce)* | A sales surface through which orders are placed. Values: `ONLINE` (web storefront), `RETAIL` (physical location), `MOBILE` (app), `MARKETPLACE` (Amazon, eBay), `SOCIAL` (Facebook, Instagram). Each channel has a unique `channelId` used when querying orders. | | **checkout session** *(Commerce)* | A Commerce object representing an active cart and payment context. Managed through the `commerce.checkout-session:read/write` scopes. Part of the Payments API surface. See [payment request](#payment-request). | | **Classic Developer Key** *(Domains, Auctions)* | A credential pair (API key and secret) used in the format `Authorization: sso-key :`. Required for the Auctions API and supported (but deprecated) for Domains v1/v2 endpoints. Not accepted by the v3 Domains API, Commerce, or Email APIs. See [PAT (Personal Access Token)](#pat-personal-access-token). | | **CNAME (Canonical Name record)** *(Domains)* | A DNS record type that aliases one domain name to another. A CNAME cannot coexist with other records at the same name — a CNAME at the apex (`@`) is invalid when other records (A, MX) are present. | | **domain status** *(Domains)* | The lifecycle state of a registered domain. Common values: `ACTIVE` (in use), `CANCELLED` (registration lapsed), `PENDING_TRANSFER` (outbound transfer in progress), `EXPIRED` (past expiration, in grace period), `REDEMPTION` (past grace period, recoverable at higher cost). Status values affect which API operations are permitted. | | **domain transfer** *(Domains)* | Moving a domain registration from one registrar to another. Outbound transfers require an authorization code (EPP code). Transfers take up to 5–7 days to complete and go through `PENDING_TRANSFER` status during that time. | | **entitlement** *(Email)* | A provisioning credit tied to a domain that authorizes creation of one or more mailboxes. Check the `eligibleAccounts` field returned by the check-eligibility endpoint to see available entitlements and any consent requirements before provisioning a mailbox. | | **fulfillment** *(Commerce)* | The process of delivering order line items to a customer. Each line item has a fulfillment mode: `SHIP` (physical shipment), `PICKUP` (in-store collection), or `DIGITAL` (electronic delivery). Fulfillment state is tracked through a [fulfillment plan](#fulfillment-plan). | | **fulfillment plan** *(Commerce)* | An object created automatically when an order transitions from `DRAFT` to `OPEN`. It lists the line items to fulfill and their fulfillment modes. Referenced by `fulfillmentPlanId` and accessed through the `commerce.fulfillment-plan:read` scope. | | **Good as Gold** | GoDaddy's prepaid balance program. Some accounts can use a Good as Gold balance to fund API operations that cost money (domain registration, renewal, transfer). If an account has neither a payment method nor a Good as Gold balance, write operations that require payment return `403 Forbidden`. Go to [Set up a payment profile](https://developer.godaddy.com/docs/api-users/payment-profile) for more information. | | **grace period** *(Domains)* | A period after domain expiration during which the domain can be renewed at normal pricing. After the grace period ends, the domain enters a redemption period and renewal costs increase significantly. | | **ICANN consent** *(Domains)* | The Internet Corporation for Assigned Names and Numbers (ICANN) requires registrants to confirm that their contact information is accurate before a domain is registered. In the v3 API, you provide this as a consent object in the registration request. Providing false information can result in domain suspension. | | **idempotency key** | A client-generated value (typically a UUID) included in the `Idempotency-Key` request header. If the server already processed a request with the same key, it returns the original response without executing the operation again. Use idempotency keys on all non-idempotent write operations — particularly domain registration and mailbox provisioning — to prevent duplicate charges or duplicate resource creation on retries. | | **mailbox** *(Email)* | A GoDaddy-hosted email address managed through the Email API. Each mailbox is identified by a `mailboxId`, associated with a domain you own, and hosted on GoDaddy's Titan email platform. See [provisioning](#provisioning) and [mailbox status](#mailbox-status). | | **mailbox status** *(Email)* | The lifecycle state of a mailbox provisioning operation. Values: `CONFIRMED` (creation initiated), `EXECUTING` (provisioning in progress), `COMPLETED` (mailbox ready to use), `FAILED` (provisioning failed). Poll the mailbox endpoint until status reaches `COMPLETED` or `FAILED`. See [async operation](#async-operation). | | **MX record (Mail Exchanger record)** *(Domains)* | A DNS record type that specifies the mail servers responsible for accepting email for a domain. MX records include a priority value — lower numbers indicate higher priority. | | **nameserver** *(Domains)* | A server that answers DNS queries for a domain. Nameservers are authoritative (hold the definitive records) or recursive (resolve queries by querying authoritative servers on behalf of clients). Changing a domain's nameservers delegates DNS management to a different provider. | | **NS record (Name Server record)** *(Domains)* | A DNS record type that delegates a DNS zone to a set of nameservers. GoDaddy-managed NS records cannot be modified through the DNS records API — use the dedicated nameservers endpoint instead. | | **OTE (Operational Test Environment)** | GoDaddy's sandbox environment for testing integrations. Base URL: `https://api.ote-godaddy.com`. Requests in OTE do not process real transactions or charge real accounts. Not all APIs offer an OTE environment — check the documentation for the API you are testing. OTE credentials are separate from production credentials. | | **PAT (Personal Access Token)** | A scoped Bearer token used to authenticate API requests. Generated from the [developer dashboard](https://developer.godaddy.com/personal-access-token). PATs are the recommended credential wherever an API accepts one and are required for v3 Domains API access. A PAT includes one or more scopes (for example, `domains.domain:read`, `commerce.order:read`) that determine which operations it can authorize. Go to [Authenticate](https://developer.godaddy.com/docs/api-users/auth) for the full credential guide. | | **payment request** *(Commerce)* | A Commerce object representing a request to collect payment for a purchase. Managed through the `commerce.payment-request:read/write` scopes. See [checkout session](#checkout-session). | | **provisioning** *(Email)* | The async process of creating a mailbox on GoDaddy's email platform. Submit a creation request, then poll for [mailbox status](#mailbox-status) until the operation reaches `COMPLETED` or `FAILED`. Use an [idempotency key](#idempotency-key) to prevent duplicate mailboxes on retried requests. See [async operation](#async-operation). | | **quote token** *(Domains)* | A short-lived token returned by `POST /v3/domains/registration-quotes`. The token locks the price for a domain registration and must be included in the subsequent `POST /v3/domains/registrations` call. Quote tokens expire quickly — re-quote if you receive a `QUOTE_EXPIRED` error. | | **rate limit** | The maximum number of API requests allowed per credential per time window. GoDaddy REST APIs currently limit requests to 600 per approximately 23-minute window per credential, though this value is subject to change. Exceeding the limit returns `429 Too Many Requests`. Read `RateLimit-Remaining` from response headers to track usage in real time rather than assuming a fixed number. Go to [Handle rate limits](https://developer.godaddy.com/docs/api-users/rate-limits) for retry guidance. | | **redemption period** *(Domains)* | A period after the grace period ends during which a domain can still be recovered, but at significantly higher cost. After the redemption period, the domain is released for re-registration by anyone. | | **registrar** *(Domains)* | A company accredited by ICANN to sell and manage domain registrations. GoDaddy is a registrar. The registrar manages the relationship with the registry on behalf of the registrant (the domain owner). | | **registry** *(Domains)* | The organization that manages a top-level domain (TLD) on behalf of ICANN. For example, Verisign manages `.com` and `.net`; the Public Interest Registry manages `.org`. The registry maintains the authoritative database of all domains under the TLD. | | **registry lock** *(Domains)* | A security feature that prevents unauthorized changes to a domain's nameservers, contact information, or transfer status by requiring out-of-band verification. Domains with registry lock cannot be updated programmatically until the lock is released. | | **scope** | A permission granted to a PAT that authorizes a specific category of API operations. Every API area has its own scope namespace: `domains.*` for Domains, `commerce.*` for Commerce, `email.*` for Email. For example, `domains.domain:read` allows read-only domain queries; `commerce.order:read` allows reading Commerce orders. A PAT must include all scopes required for each operation it performs. Go to [Authenticate — PAT scopes](https://developer.godaddy.com/docs/api-users/auth#pat-scopes) for the full reference. | | **scope bundle** | A named group of related PAT scopes selectable as a unit in the [developer dashboard](https://developer.godaddy.com/personal-access-token) token picker. For example, the **Domains & DNS** bundle selects all `domains.*` scopes at once. Selecting a bundle is equivalent to selecting each scope individually. Go to [Authenticate — PAT scopes](https://developer.godaddy.com/docs/api-users/auth#pat-scopes) for available bundles. | | **shopper ID / customer ID** *(Domains)* | GoDaddy's internal identifier for an account. In the v2 API, the `customerId` appears in operation paths (`/v2/customers/{customerId}/domains/...`). In the v3 API, the authenticated credential determines the account — no customer ID is required in the path. | | **SKU (Stock Keeping Unit)** *(Commerce)* | A single purchasable product variant — for example, a shirt in size M. Related SKUs are grouped into a SKU group (a product). An individual SKU is referenced by `skuId`; the group is referenced by `skuGroupId`. SKUs are managed through the Commerce catalog endpoints. | | **SOA record (Start of Authority record)** *(Domains)* | A DNS record that contains administrative information about a DNS zone, including the primary nameserver, zone serial number, and refresh intervals. SOA records are managed by GoDaddy and cannot be modified through the API. | | **status polling** | The process of repeatedly calling a status endpoint to check whether an async operation has completed. The recommended pattern is exponential backoff: wait 1 second, then 2, then 4, up to a reasonable maximum. Stop polling when status reaches `COMPLETED` or `FAILED`. See [async operation](#async-operation). | | **storeId** *(Commerce)* | The UUID uniquely identifying a GoDaddy Payments store. Required as the `x-store-id` header on all Commerce API calls. If you receive `403 Forbidden` on Commerce endpoints, verify you are sending the correct `storeId` for the merchant account. | | **TXT record** *(Domains)* | A DNS record type that stores arbitrary text associated with a domain. TXT records are commonly used for domain ownership verification (Google, GitHub, Stripe), SPF email authentication, and DKIM keys. | | **TTL (Time to Live)** *(Domains)* | The number of seconds a DNS record can be cached by resolvers before they must re-query the authoritative nameserver. Lower TTLs reduce propagation time for changes but increase query volume. The minimum TTL for GoDaddy-hosted DNS is 600 seconds (10 minutes). | | **v1 / v2 / v3 API** *(Domains)* | The three versioned namespaces of the GoDaddy Domains API. `v1` (`/v1/domains/...`) covers DNS, contacts, renewals, lock, and transfers. `v2` (`/v2/customers/{customerId}/domains/...`) adds async operation tracking. `v3` (`/v3/domains/...`) is the preferred namespace for new integrations — it separates quoting from execution, supports async operations, and requires ICANN consent. Go to the [Domains API overview](https://developer.godaddy.com/docs/references/rest/domains) for the version comparison table. | | **zone** *(Domains)* | The complete set of DNS records for a domain managed by a single authoritative nameserver. Managing DNS through the GoDaddy API operates on a domain's zone. If the domain uses external nameservers, GoDaddy's zone is inactive — DNS records must be managed at the external provider. |