> ## 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 sale > Adds a sale. A store holds up to 30. Needs the `sales.write` permission (Change Sales). ## OpenAPI ````yaml /api-reference/openapi.json post /stores/{storeId}/sales 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}/sales: post: tags: - Sales summary: Create a sale description: |- Adds a sale. A store holds up to 30. Needs the `sales.write` permission (Change Sales). operationId: sales.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 `startsAt` and `endsAt` are read in when they name none, 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: name: type: string description: >- What the sale is called, up to 60 characters. Buyers see it on the storefront's countdown. example: Autumn sale discountType: type: string description: A share of each price, or an amount in the store's currency. enum: - percent - fixed default: percent value: type: number description: >- How much comes off: above 0 and up to 100 for `percent`, an amount with at most 2 decimals for `fixed`. example: 20 appliesTo: type: string description: Every product, or only the ones in `targets`. enum: - all - some default: all targets: type: array description: >- The products on sale 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 startsAt: type: string description: When it starts, as a date and time. example: '2026-11-27T00:00:00Z' endsAt: type: string description: >- When it ends, as a date and time. After `startsAt`, and not already past. example: '2026-11-30T23:59:00Z' couponRule: type: string description: >- What coupons do while the sale runs. `rest`: a coupon counts only the items in the cart that are not on sale. `all`: coupons work on sale items too. `none`: no coupon works anywhere in the store. enum: - rest - all - none default: rest exceptions: type: array description: >- Up to 100 coupons or coupon categories that `couponRule` is turned around for. items: type: object properties: kind: type: string description: What `id` names. enum: - coupon - category id: type: string description: The coupon or the coupon category. required: - kind - id enabled: type: boolean description: Whether the sale runs when its time comes. default: true showBar: type: boolean description: Whether the storefront shows the sale's countdown bar. default: true required: - name - value - startsAt - endsAt 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 name: type: string enabled: type: boolean status: type: string discountType: type: string value: type: integer appliesTo: type: string targets: type: - array - object startsAt: type: string endsAt: type: string couponRule: type: string exceptions: type: - array - object showBar: type: boolean orders: type: integer revenue: type: integer dateCreated: type: string updatedAt: type: string example: success: true message: null code: null data: id: b9f77894-db3d-4db7-8fdf-22d434957cf3 name: Autumn sale enabled: true status: scheduled discountType: percent value: 20 appliesTo: all targets: [] startsAt: '2026-10-23T16:20:18Z' endsAt: '2026-10-29T16:20:18Z' couponRule: rest exceptions: [] showBar: true orders: 0 revenue: 0 dateCreated: '2026-10-22T16:20:18Z' updatedAt: '2026-10-22T16:20:18.820Z' '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.sales.create({ name: "Autumn sale", value: 20, startsAt: "2026-11-27T00:00:00Z", endsAt: "2026-11-30T23:59:00Z", }); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->sales->create([ 'name' => 'Autumn sale', 'value' => 20, 'startsAt' => '2026-11-27T00:00:00Z', 'endsAt' => '2026-11-30T23:59:00Z', ]); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.sales.create( name="Autumn sale", value=20, startsAt="2026-11-27T00:00:00Z", endsAt="2026-11-30T23:59:00Z", ) 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.