> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Create a coupon > Adds a coupon. Its expiry cannot already have passed. Needs the `coupons.write` permission (Change Coupons). ## OpenAPI ````yaml /api-reference/openapi.json post /stores/{storeId}/coupons openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/coupons: post: tags: - Coupons summary: Create a coupon description: |- Adds a coupon. Its expiry cannot already have passed. Needs the `coupons.write` permission (Change Coupons). operationId: coupons.create parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - name: tz in: query required: false description: >- The time zone a bare date in `expiresAt` is read in, as an IANA name. Left out, UTC. schema: type: string example: Europe/Berlin - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: >- What a buyer types. 3 to 64 letters, digits, hyphens or underscores, kept in capitals. One coupon a code in a store. example: WELCOME10 discountType: type: string description: A share of the order, or an amount in the store's currency. enum: - percent - fixed default: percent value: type: number description: >- How much comes off: 1 to 100 for `percent`, an amount for `fixed`. example: 10 maxUses: type: integer description: How many orders may use it. 0 is no limit. default: 0 minSubtotal: type: number description: >- The smallest order it works on, before discounts. 0 is any order. default: 0 expiresAt: type: string description: >- When it stops working: a date (`2026-12-31`, good to the end of that day) or a date and time. Empty is never. example: '2026-12-31' active: type: boolean description: Whether buyers can use it. default: true categoryId: type: string description: >- The coupon category it is filed in. Left out, it goes in the store's Default category. appliesTo: type: string description: Every product, or only the ones in `targets`. enum: - all - some default: all targets: type: array description: >- The products it works on when `appliesTo` is `some`. Each names a product, and optionally one variant of it. items: type: object properties: productId: type: string description: The product. variantId: type: string description: One variant of it. Left out, every variant. required: - productId customerTag: type: string description: >- Who may use it: empty for anybody with the code, `vip`, or the ID of one of the store's tags. The buyer's email has to wear the tag when the code is applied and when they pay. required: - code - value responses: '201': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: id: type: string storeId: type: string categoryId: type: string code: type: string discountType: type: string value: type: integer maxUses: type: integer uses: type: integer remainingUses: type: integer minSubtotal: type: integer expiresAt: nullable: true active: type: boolean appliesTo: type: string targets: type: - array - object customerTag: nullable: true sort: type: integer discountGiven: type: integer revenue: type: integer dateCreated: type: string updatedAt: type: string example: success: true message: null code: null data: id: e6ffacf4-0cef-460d-9a1d-a17c6f295a29 storeId: 743d82fb-6aad-44bb-ab00-d54c4b0eecb7 categoryId: 62fc3f0e-0160-47f3-9ba0-b02592d4590f code: WELCOME10 discountType: percent value: 10 maxUses: 100 uses: 0 remainingUses: 100 minSubtotal: 0 expiresAt: null active: true appliesTo: all targets: [] customerTag: null sort: 0 discountGiven: 0 revenue: 0 dateCreated: '2026-10-22T16:20:18Z' updatedAt: '2026-10-22T16:20:18.777Z' '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/Refused' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.coupons.create({ code: "WELCOME10", value: 10, }); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->coupons->create([ 'code' => 'WELCOME10', 'value' => 10, ]); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.coupons.create(code="WELCOME10", value=10) components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with `Idempotent-Replay: true`. schema: type: string responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' Refused: description: >- The request was understood and not carried out. `validation_failed` says what is wrong with each field under `errors`; other codes are the route's own. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.