Coupons

Updates a specific coupon.

put/v1/shops/{shopId}/coupons/{couponId}/update

Request

Request body

codestring required
globalboolean required
discountnumber required

Must be at least -999999. Must not be greater than 999999.

type'percentage' | 'fixed' required
max_usesnumber nullable

Must be at least 1. Must not be greater than 999999.

max_uses_per_customernumber nullable

Must be at least 1. Must not be greater than 999999.

min_invoice_pricenumber nullable

Must be at least 0. Must not be greater than 999999.

start_datestring nullable

Must be a valid date. Must be a date before <code>2038-01-19</code>.

expiration_datestring nullable

Must be a valid date. Must be a date after <code>today</code>. Must be a date before <code>2038-01-19</code>.

allowed_emailsstring[]

Must be a valid email address.

payment_method_idsstring[]

Must match an existing stored value.

uses_count_mode'pending' | 'paid' nullable
applies_to_renewalsboolean nullable
disable_if_volume_discountboolean nullable
disable_if_quantity_dealboolean nullable
disable_if_bundle_offerboolean nullable
disable_if_gateway_discountboolean nullable
disable_if_affiliate_discountboolean nullable
disable_if_reseller_discountboolean nullable

Example request

{
  "code": "consequatur",
  "global": true,
  "discount": 15,
  "type": "fixed",
  "max_uses": 25,
  "max_uses_per_customer": 19,
  "min_invoice_price": 14,
  "start_date": "2012-05-18",
  "expiration_date": "2012-05-18",
  "allowed_emails": [
    "oerdman@example.org"
  ],
  "uses_count_mode": "pending",
  "items": [
    {
      "product_id": "consequatur"
    }
  ],
  "disable_if_volume_discount": true,
  "disable_if_quantity_deal": true,
  "disable_if_bundle_offer": true,
  "disable_if_gateway_discount": true
}

Changes

    • breaking

      added the new required request property //

    • breaking

      the / request property type changed from string to object

    • info

      added the new optional request property //

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property / became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the new optional request property