Create a discount

POST

/api/v1/commerce/discounts

curl --request POST \
  --url https://digize.com/api/v1/commerce/discounts \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "code": "example", "kind": "percent", "value": 1, "appliesTo": "example", "minimumOrder": 1, "usageLimit": 1, "oncePerCustomer": true, "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z", "disabled": true, "id": "example" }'

• Digize

Adds a code customers enter at checkout: a percentage or an amount off, or free shipping.

Needs the commerce:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

code

required

string

<= 40 characters

kind

required

string

Allowed values: percent fixed free_shipping

value

required

integer

<= 100000000

appliesTo

string

<= 120 characters

minimumOrder

In the store currency’s minor unit: 1900 is $19.00.

integer

<= 100000000

usageLimit

Any of:

integer

integer

>= 1 <= 9007199254740991

null

null

oncePerCustomer

boolean

startsAt

string format: date-time

endsAt

Any of:

string

string format: date-time

null

null

disabled

boolean

id

string

>= 1 characters <= 64 characters

Responses

201

Done

Media typeapplication/json

object

id

required

string

code

required

string

kind

required

string

Allowed values: percent fixed free_shipping

value

required

A percentage for percent, an amount for fixed, 0 for free shipping.

number

appliesTo

required

“All products”, a category, or a product’s name.

string

minimumOrder

required

number

usageLimit

required

number | null

oncePerCustomer

required

boolean

used

required

number

status

required

string

Allowed values: active scheduled expired disabled

startsAt

required

string format: date-time

endsAt

required

Any of:

string

string format: date-time

null

null

revenue

required

Sales from orders that used it, the last 90 days.

number

discounted

required

What it took off those orders.

number

Example

{
  "kind": "percent",
  "status": "active"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}