> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Register an application > Registers a client that merchants can then connect. What the client may do is not set here — the merchant grants that at consent, so a registration carries no permissions of its own. Clients are public rather than confidential: a hosted connector cannot keep a secret, which is why PKCE is required. **Required scope:** `write_oauth_applications` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml post /api/v3/admin/oauth/applications openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/oauth/applications: post: tags: - OAuth summary: Register an application description: >- Registers a client that merchants can then connect. What the client may do is not set here — the merchant grants that at consent, so a registration carries no permissions of its own. Clients are public rather than confidential: a hosted connector cannot keep a secret, which is why PKCE is required. **Required scope:** `write_oauth_applications` (for API-key authentication). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OauthApplicationCreateParams' required: true responses: '201': description: application registered content: application/json: example: id: oauthapp_UkLWZg9DAJ name: Claude redirect_uri: https://claude.ai/api/mcp/auth_callback created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' client_id: W1yx4buwyE2LcIwCdbhN-PlRaoqCVJJ5z4jOejnK3Xs connected: false scopes: [] last_authorized_at: null authorized_at: null authorized_by: null schema: $ref: '#/components/schemas/OauthApplication' '422': description: the registration is not valid content: application/json: example: error: code: validation_error message: Name can't be blank and Redirect uri can't be blank details: name: - code: blank message: can't be blank specific: false redirect_uri: - code: blank message: can't be blank specific: false schema: $ref: '#/components/schemas/ErrorResponse' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: |- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const application = await client.oauth.applications.create({ name: 'Claude', redirect_uri: 'https://claude.ai/api/mcp/auth_callback', }) - lang: bash label: Spree CLI source: >- spree api post /oauth/applications -d '{"name":"Claude","redirect_uri":"https://claude.ai/api/mcp/auth_callback"}' components: schemas: OauthApplicationCreateParams: type: object properties: name: type: string example: Claude redirect_uri: type: string description: Where the authorization server sends the browser back to. example: https://claude.ai/api/mcp/auth_callback required: - name OauthApplication: type: object properties: id: type: string name: type: string redirect_uri: type: string nullable: true created_at: type: string updated_at: type: string client_id: type: string connected: type: boolean scopes: type: array items: type: string last_authorized_at: type: string nullable: true authorized_at: type: string nullable: true authorized_by: type: string nullable: true required: - id - name - redirect_uri - created_at - updated_at - client_id - connected - scopes - last_authorized_at - authorized_at - authorized_by x-typelizer: true ErrorResponse: type: object properties: error: type: object properties: code: type: string example: record_not_found message: type: string example: Record not found details: type: object description: Field-specific validation errors nullable: true example: name: - is too short - is required email: - is invalid required: - code - message required: - error example: error: code: validation_error message: Validation failed details: name: - is too short email: - is invalid securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.