Skip to main content
POST
/
discount-codes
/
percentage
/
update
Update Percentage Discount Code
curl --request POST \
  --url https://api.nuwebgroup.com/v1/discount-codes/percentage/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "amount": 10,
  "maxUsesPerOrder": 2,
  "currencyId": 1,
  "maxUsesPerCustomer": 2,
  "minimumSpend": 1000,
  "saleItems": [
    1,
    2
  ],
  "maximumUses": 100,
  "validFrom": "2021-01-01",
  "validTo": "2021-02-01"
}
'
{
  "data": {
    "type": "discountCodes",
    "id": 1,
    "attributes": {
      "type": "percentage",
      "code": "PERCENTAGE10",
      "amount": 10,
      "maximumUses": 100,
      "maxUsesPerCustomer": 2,
      "minimumSpend": 1000,
      "validFrom": "2021-11-22T11:59:00.000000Z",
      "validTo": "2021-11-25T11:59:00.000000Z",
      "boxOfficeOnly": false,
      "disabledAt": null,
      "createdAt": "2021-11-22T11:59:00.000000Z",
      "updatedAt": "2021-11-22T11:59:00.000000Z"
    },
    "relationships": {
      "currencies": {
        "data": {
          "type": "currencies",
          "id": 1
        }
      },
      "saleItems": {
        "data": [
          {
            "type": "saleItems",
            "id": 1
          },
          {
            "type": "saleItems",
            "id": 2
          }
        ]
      }
    },
    "links": {
      "self": "http://api.willms.com/v1/discount-codes?id=1"
    }
  },
  "included": [
    {
      "type": "currencies",
      "id": 1,
      "attributes": {
        "name": "Pounds",
        "code": "GBP",
        "symbol": "Ā£",
        "subunit": 2,
        "isCashless": false,
        "isCustom": false,
        "isPrimary": true
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Body

application/json

Request body for updating a percentage discount code.

id
integer

Used to determine which discount code we are editing. Can use either this or the code field.

code
string

Used to determine which discount code we are editing. Can use either this or the id field.

amount
number

The amount of the discount. For percentage discounts, this is the percentage value with up to two decimal places, e.g., 12.34 = 12.34%.

maxUsesPerOrder
integer
currencyId
integer
maxUsesPerCustomer
integer
minimumSpend
integer
maximumDiscount
object

An object containing maximum discounts that can be applied to an order using this code. Keyed by currency code.

saleItems
any[]

An array of sale item ID's.

maximumUses
integer
validFrom
string
validTo
string

Response

Successfully updated the percentage discount code.

data
object
included
object[]