Update a coupon

Change a coupon's discount, limits, or eligible products.

To scope a coupon, set store_wide to false, send product/listing IDs in products, and optionally send variant IDs in product_variants. Every variant must belong to one of the selected products.

Omitting product_variants preserves existing variant restrictions. Sending an empty product_variants array clears the restrictions, making every variant of the selected products eligible. Changing products automatically removes restrictions for products that are no longer selected.

Authorization

AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Path Parameters

coupon*integer

The coupon path parameter.

Query Parameters

with_trashed?boolean

Include soft-deleted resources in the result.

Defaultfalse

only_trashed?boolean

Return only soft-deleted resources. Ignored when with_trashed is true.

Defaultfalse

Header Parameters

X-STORE?string

Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

code?string

Lengthlength <= 255

type?string

Value in"PERCENTAGE" | "AMOUNT"

discount?|

A decimal discount value of at least 1. Percentage discounts cannot exceed 100; amount discounts use the store currency's major unit.

Range1 <= value

Lengthlength <= 255

store_wide?boolean

products?array<integer>

Product IDs the coupon applies to when store_wide is false.

Items1 <= items

product_variants?array<integer>

Optional variant restrictions. Omit to preserve existing restrictions or send an empty array to allow every variant of the selected products.

limit?|

Range1 <= value

expires_at?|

A future date and time, or null for no expiry.

Formatdate-time

minimum_amount?||

A decimal minimum order amount in the store currency's major unit, or null for no minimum.

Range1 <= value

Lengthlength <= 255

Response Body

`application/json`

curl -X PATCH "https://sell.app/api/v2/coupons/1" \  -H "X-STORE: launch-lab" \  -H "Content-Type: application/json" \  -d '{    "store_wide": false,    "products": [      123    ],    "product_variants": [      1001,      1002    ]  }'

{
  "data": {
    "id": 1,
    "code": "BAZINGA",
    "type": "PERCENTAGE",
    "discount": "80",
    "limit": null,
    "store_wide": false,
    "minimum_amount": null,
    "expires_at": null,
    "created_at": "2022-12-12T12:12:12.000000Z",
    "updated_at": "2026-08-30T12:00:01.000000Z",
    "store_id": 1,
    "deleted_at": null,
    "products": [
      123
    ],
    "product_variants": [
      1001,
      1002
    ],
    "maximum_discount_amount": null
  }
}

{
  "type": "invalid_request_error",
  "code": "bad_request",
  "message": "The request could not be understood.",
  "status": 400,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#bad-request"
}

{
  "type": "authentication_error",
  "code": "unauthenticated",
  "message": "Unauthenticated.",
  "status": 401,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}

{
  "type": "authorization_error",
  "code": "forbidden",
  "message": "This action is unauthorized.",
  "status": 403,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#forbidden"
}

{
  "type": "not_found_error",
  "code": "resource_not_found",
  "message": "Not Found.",
  "status": 404,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#resource-not-found"
}

{
  "type": "validation_error",
  "code": "validation_failed",
  "message": "The selected product variant id is invalid.",
  "status": 422,
  "param": "product_variant_id",
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#validation-failed",
  "errors": {
    "product_variant_id": [
      "The selected product variant id is invalid."
    ]
  }
}

{
  "type": "rate_limit_error",
  "code": "rate_limit_exceeded",
  "message": "Too Many Attempts.",
  "status": 429,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}

{
  "type": "api_error",
  "code": "api_error",
  "message": "Server Error",
  "status": 500,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#api-error"
}

Authorization

AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Path Parameters

coupon*integer

The coupon path parameter.

Query Parameters

with_trashed?boolean

Include soft-deleted resources in the result.

Defaultfalse

only_trashed?boolean

Return only soft-deleted resources. Ignored when with_trashed is true.

Defaultfalse

Header Parameters

X-STORE?string

Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

code?string

Lengthlength <= 255

type?string

Value in"PERCENTAGE" | "AMOUNT"

discount?|

A decimal discount value of at least 1. Percentage discounts cannot exceed 100; amount discounts use the store currency's major unit.

Range1 <= value

Lengthlength <= 255

store_wide?boolean

products?array<integer>

Product IDs the coupon applies to when store_wide is false.

Items1 <= items

product_variants?array<integer>

Optional variant restrictions. Omit to preserve existing restrictions or send an empty array to allow every variant of the selected products.

limit?|

Range1 <= value

expires_at?|

A future date and time, or null for no expiry.

Formatdate-time

minimum_amount?||

A decimal minimum order amount in the store currency's major unit, or null for no minimum.

Range1 <= value

Lengthlength <= 255

Response Body

`application/json`

curl -X PUT "https://sell.app/api/v2/coupons/1" \  -H "X-STORE: launch-lab" \  -H "Content-Type: application/json" \  -d '{    "store_wide": false,    "products": [      123    ],    "product_variants": [      1001,      1002    ]  }'

{
  "data": {
    "id": 1,
    "code": "BAZINGA",
    "type": "PERCENTAGE",
    "discount": "80",
    "limit": null,
    "store_wide": false,
    "minimum_amount": null,
    "expires_at": null,
    "created_at": "2022-12-12T12:12:12.000000Z",
    "updated_at": "2026-08-30T12:00:01.000000Z",
    "store_id": 1,
    "deleted_at": null,
    "products": [
      123
    ],
    "product_variants": [
      1001,
      1002
    ],
    "maximum_discount_amount": null
  }
}

{
  "type": "invalid_request_error",
  "code": "bad_request",
  "message": "The request could not be understood.",
  "status": 400,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#bad-request"
}

{
  "type": "authentication_error",
  "code": "unauthenticated",
  "message": "Unauthenticated.",
  "status": 401,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}

{
  "type": "authorization_error",
  "code": "forbidden",
  "message": "This action is unauthorized.",
  "status": 403,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#forbidden"
}

{
  "type": "not_found_error",
  "code": "resource_not_found",
  "message": "Not Found.",
  "status": 404,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#resource-not-found"
}

{
  "type": "validation_error",
  "code": "validation_failed",
  "message": "The selected product variant id is invalid.",
  "status": 422,
  "param": "product_variant_id",
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#validation-failed",
  "errors": {
    "product_variant_id": [
      "The selected product variant id is invalid."
    ]
  }
}

{
  "type": "rate_limit_error",
  "code": "rate_limit_exceeded",
  "message": "Too Many Attempts.",
  "status": 429,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}

{
  "type": "api_error",
  "code": "api_error",
  "message": "Server Error",
  "status": 500,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#api-error"
}

Update a coupon

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`