Update a coupon

This endpoint allows you to perform an update on a coupon.

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

bearerAuth

AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Path Parameters

coupon*integer

The coupon path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

code?string

type?string

Value in"PERCENTAGE" | "AMOUNT"

discount?number

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?integer|null

expires_at?|

Formatdate-time

minimum_amount?number|null

Response Body

`application/json`

curl -X PATCH "https://sell.app/api/v1/coupons/0" \  -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": true,
    "minimum_amount": null,
    "expires_at": null,
    "created_at": "2022-12-12T12:12:12.000000Z",
    "updated_at": "2022-12-12T12:12:12.000000Z",
    "store_id": 1,
    "deleted_at": null,
    "products": [],
    "product_variants": []
  }
}