> ## 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. # Create a catalog > Creates a catalog. Add products and assign audiences (customer group, or company subtree) afterwards. **Required scope:** `write_products` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml post /api/v3/admin/catalogs 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/catalogs: post: tags: - Catalogs summary: Create a catalog description: >- Creates a catalog. Add products and assign audiences (customer group, or company subtree) afterwards. **Required scope:** `write_products` (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/CatalogCreateParams' required: true responses: '201': description: catalog created content: application/json: example: id: cat_gbHJdmfrXB name: VIP Assortment description: null active: false position: 2 metadata: {} minimum_order_quantity: null order_multiple: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' products_count: 0 pricing_strategy: base '422': description: invalid request content: application/json: example: error: code: validation_error message: Name can't be blank details: name: - code: blank message: can't be blank specific: false 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', }) // The catalog and the price list it charges through are written together, so // standing up an agreement never means visiting the price-lists page. const catalog = await client.catalogs.create({ name: 'VIP Assortment', price_list: { price_adjustment_percentage: '-15.0' }, }) - lang: bash label: Spree CLI source: >- spree api post /catalogs -d '{"name":"VIP Assortment","price_list":{"price_adjustment_percentage":"-15.0"}}' components: schemas: CatalogCreateParams: type: object properties: name: type: string example: VIP Assortment description: type: string description: Internal note on what the agreement is, never shown to shoppers. nullable: true active: type: boolean example: true position: type: integer minimum_order_quantity: type: integer description: >- The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule. nullable: true order_multiple: type: integer description: >- The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule. nullable: true metadata: type: object additionalProperties: true assignments: type: array items: $ref: '#/components/schemas/CatalogAssignmentParams' description: >- The whole audience. An entry left out is withdrawn; omitting the key leaves the audience alone. order_minimums: type: array items: $ref: '#/components/schemas/CatalogOrderMinimumParams' description: >- The whole order-minimum set. A currency left out has its minimum lifted; omitting the key leaves them alone. price_list: allOf: - $ref: '#/components/schemas/CatalogPriceListParams' description: >- The price list this catalog prices through, written inline: an object creates the owned list or updates it. Null deletes the list (a soft delete). Omit the key, or send `{}`, to leave the pricing alone. A catalog with an empty assortment prices without hiding anything; curate or import products to make it restrictive. nullable: true required: - name CatalogAssignmentParams: type: object properties: assignable_type: type: string enum: - customer_group - company description: Buyer audiences only. A company assignment covers its subtree. example: company assignable_id: type: string example: comp_86Rf07xd4z required: - assignable_type - assignable_id CatalogOrderMinimumParams: type: object properties: currency: allOf: - $ref: '#/components/schemas/CurrencyCode' description: ISO 4217 code. Required on create; one minimum per currency. example: USD amount: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ example: '500.00' CatalogPriceListParams: type: object properties: name: type: string description: type: string nullable: true status: type: string match_policy: type: string starts_at: type: string format: date-time nullable: true ends_at: type: string format: date-time nullable: true price_adjustment_percentage: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ description: 'Signed: negative discounts off base prices, positive marks up.' example: '-15.0' nullable: true adjust_compare_at: type: boolean rules: type: array items: $ref: '#/components/schemas/PriceListRuleParams' description: >- Contextual rules, in practice a `volume_rule`. Audience rules are left as they are, and an empty list clears the contextual rules. prices: type: array items: $ref: '#/components/schemas/PriceListPriceOverrideParams' description: >- Explicit per-variant amounts. An empty list clears them, which is what switching to a percentage sends. price_adjustment_tiers: type: array items: $ref: '#/components/schemas/PriceAdjustmentTierParams' description: >- Quantity bands on the percentage. The payload is the whole ladder, so an empty list clears it. CurrencyCode: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SKK - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMM - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYI - UYU - UYW - UZS - VED - VEF - VES - VND - VUV - WST - XAF - XCD - XCG - XOF - XPF - YER - ZAR - ZMK - ZMW - ZWD - ZWG - ZWL - ZWN - ZWR PriceListRuleParams: type: object properties: id: type: string description: Present for existing rules. Omit to create a new one. nullable: true type: type: string description: >- Wire shorthand for the rule kind, from the price rule types endpoint. example: volume_rule preferences: type: object additionalProperties: true description: The rule kind's settings, keyed by preference name. required: - type PriceListPriceOverrideParams: type: object properties: id: type: string description: >- Updates this price row. Without it, the row upserts on `(variant_id, currency, min_quantity)`. variant_id: type: string example: variant_xY9 currency: allOf: - $ref: '#/components/schemas/CurrencyCode' example: USD min_quantity: type: integer description: The rung of the variant's ladder. Omit for the bottom rung. amount: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ example: '19.99' nullable: true compare_at_amount: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ example: '19.99' nullable: true PriceAdjustmentTierParams: type: object properties: min_quantity: type: integer description: Above 1; quantity 1 is the list's own `price_adjustment_percentage`. example: 10 percentage: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ description: 'Signed: negative discounts, positive marks up.' example: '-10.0' required: - min_quantity - percentage 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.