> ## 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 promotion > Creates a new promotion. `code` is required for single-code coupon promotions; pass `multi_codes: true` with `number_of_codes` to auto-generate a batch. Rules and actions can be created in the same request by passing arrays of `{ type, preferences, ... }` rows. The server reconciles to the desired set: new rows are built, existing rows (by `id`) are updated, omitted rows are removed. **Required scope:** `write_promotions` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml post /api/v3/admin/promotions 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: Exports description: Async CSV exports of admin resources - 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: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, store credit categories - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - 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/promotions: post: tags: - Promotions summary: Create a promotion description: >- Creates a new promotion. `code` is required for single-code coupon promotions; pass `multi_codes: true` with `number_of_codes` to auto-generate a batch. Rules and actions can be created in the same request by passing arrays of `{ type, preferences, ... }` rows. The server reconciles to the desired set: new rows are built, existing rows (by `id`) are updated, omitted rows are removed. **Required scope:** `write_promotions` (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: type: object properties: name: type: string code: type: string nullable: true description: type: string nullable: true starts_at: type: string format: date-time nullable: true expires_at: type: string format: date-time nullable: true usage_limit: type: integer nullable: true match_policy: type: string enum: - all - any kind: type: string enum: - coupon_code - automatic multi_codes: type: boolean number_of_codes: type: integer nullable: true code_prefix: type: string nullable: true promotion_category_id: type: string nullable: true rules: type: array items: type: object properties: type: type: string example: currency preferences: type: object additionalProperties: true product_ids: type: array items: type: string category_ids: type: array items: type: string customer_ids: type: array items: type: string required: - type actions: type: array items: type: object properties: type: type: string example: free_shipping preferences: type: object additionalProperties: true calculator: type: object properties: type: type: string example: flat_percent_item_total preferences: type: object additionalProperties: true required: - type required: - name responses: '201': description: promotion created with rules and actions content: application/json: example: id: promo_gbHJdmfrXB name: Black Friday description: null code: blackfriday-os starts_at: '2026-07-26T14:25:46.152Z' expires_at: null usage_limit: null match_policy: all path: null kind: coupon_code multi_codes: false number_of_codes: null code_prefix: null promotion_category_id: null metadata: {} created_at: '2026-07-26T14:25:46.152Z' updated_at: '2026-07-26T14:25:46.179Z' action_ids: - pact_UkLWZg9DAJ - pact_gbHJdmfrXB rule_ids: - prorule_UkLWZg9DAJ - prorule_gbHJdmfrXB - prorule_EfhxLZ9ck8 '422': description: invalid params content: application/json: example: error: code: validation_error message: Name can't be blank and Code can't be blank details: name: - can't be blank code: - can't be blank 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', }) // Single coupon code, no rules/actions const promotion = await client.promotions.create({ name: 'Black Friday', code: 'BLACKFRIDAY', starts_at: '2026-11-29T00:00:00Z', expires_at: '2026-12-01T00:00:00Z', }) // One-shot: promotion + rules + actions in a single request const blackFriday = await client.promotions.create({ name: 'Black Friday', code: 'BLACKFRIDAY', kind: 'coupon_code', starts_at: '2026-11-29T00:00:00Z', expires_at: '2026-12-01T00:00:00Z', match_policy: 'all', rules: [ { type: 'currency', preferences: { currency: 'USD' }, }, { type: 'item_total', preferences: { amount_min: 100, operator_min: 'gte' }, }, { type: 'product', preferences: { match_policy: 'any' }, product_ids: ['prod_abc123', 'prod_def456'], }, ], actions: [ { type: 'create_item_adjustments', calculator: { type: 'percent_on_line_item', preferences: { percent: 25 }, }, }, { type: 'free_shipping' }, ], }) - lang: bash label: Spree CLI source: >- spree api post /promotions -d '{"name":"Black Friday","code":"BLACKFRIDAY","starts_at":"2026-11-29T00:00:00Z","expires_at":"2026-12-01T00:00:00Z"}' components: 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 ````