Set a discount's application method

curl --request PUT \
  --url https://api.mercemur.com/api/v1/discounts/{discountId}/application-method \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "percentage_basis_points": 2,
  "amount_minor": 2,
  "currency_code": "<string>",
  "apply_to_quantity": 2,
  "buy_rules_min_quantity": 2,
  "max_quantity": 2
}
'

const options = {
  method: 'PUT',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    percentage_basis_points: 2,
    amount_minor: 2,
    currency_code: '<string>',
    apply_to_quantity: 2,
    buy_rules_min_quantity: 2,
    max_quantity: 2
  })
};

fetch('https://api.mercemur.com/api/v1/discounts/{discountId}/application-method', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/discounts/{discountId}/application-method"

payload = {
    "percentage_basis_points": 2,
    "amount_minor": 2,
    "currency_code": "<string>",
    "apply_to_quantity": 2,
    "buy_rules_min_quantity": 2,
    "max_quantity": 2
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/discounts/{discountId}/application-method"

	payload := strings.NewReader("{\n  \"percentage_basis_points\": 2,\n  \"amount_minor\": 2,\n  \"currency_code\": \"<string>\",\n  \"apply_to_quantity\": 2,\n  \"buy_rules_min_quantity\": 2,\n  \"max_quantity\": 2\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/discounts/{discountId}/application-method",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'percentage_basis_points' => 2,
    'amount_minor' => 2,
    'currency_code' => '<string>',
    'apply_to_quantity' => 2,
    'buy_rules_min_quantity' => 2,
    'max_quantity' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "allocation": "<string>",
    "amount_minor": 123,
    "apply_to_quantity": 123,
    "buy_rules_min_quantity": 123,
    "created_at": "<string>",
    "currency_code": "<string>",
    "discount_id": "<string>",
    "id": "<string>",
    "max_quantity": 123,
    "percentage_basis_points": 123,
    "target_type": "<string>",
    "type": "<string>",
    "updated_at": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

PUT

api

discounts

{discountId}

application-method

Set a discount's application method

curl --request PUT \
  --url https://api.mercemur.com/api/v1/discounts/{discountId}/application-method \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "percentage_basis_points": 2,
  "amount_minor": 2,
  "currency_code": "<string>",
  "apply_to_quantity": 2,
  "buy_rules_min_quantity": 2,
  "max_quantity": 2
}
'

const options = {
  method: 'PUT',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    percentage_basis_points: 2,
    amount_minor: 2,
    currency_code: '<string>',
    apply_to_quantity: 2,
    buy_rules_min_quantity: 2,
    max_quantity: 2
  })
};

fetch('https://api.mercemur.com/api/v1/discounts/{discountId}/application-method', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/discounts/{discountId}/application-method"

payload = {
    "percentage_basis_points": 2,
    "amount_minor": 2,
    "currency_code": "<string>",
    "apply_to_quantity": 2,
    "buy_rules_min_quantity": 2,
    "max_quantity": 2
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/discounts/{discountId}/application-method"

	payload := strings.NewReader("{\n  \"percentage_basis_points\": 2,\n  \"amount_minor\": 2,\n  \"currency_code\": \"<string>\",\n  \"apply_to_quantity\": 2,\n  \"buy_rules_min_quantity\": 2,\n  \"max_quantity\": 2\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/discounts/{discountId}/application-method",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'percentage_basis_points' => 2,
    'amount_minor' => 2,
    'currency_code' => '<string>',
    'apply_to_quantity' => 2,
    'buy_rules_min_quantity' => 2,
    'max_quantity' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "allocation": "<string>",
    "amount_minor": 123,
    "apply_to_quantity": 123,
    "buy_rules_min_quantity": 123,
    "created_at": "<string>",
    "currency_code": "<string>",
    "discount_id": "<string>",
    "id": "<string>",
    "max_quantity": 123,
    "percentage_basis_points": 123,
    "target_type": "<string>",
    "type": "<string>",
    "updated_at": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key

string

required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

discountId

string

required

Body

application/json

THE SHAPE OF THE DISCOUNT, and the most dangerous write in this family. target_type decides whether the discount comes off the ORDER SUBTOTAL or off the SHIPPING, so one call can turn "10% off the order" into "10% off shipping"; it has no default for that reason. A discount with NO application method still discounts: the money path falls back to the discount's own type and value against the subtotal. Send exactly one of percentage_basis_points or amount_minor. A PUT replaces the whole method and keeps the existing row's id, so replaying converges by construction.

target_type

enum<string>

required

Required, with no default. shipping_methods discounts the SHIPPING and leaves the goods at full price; order and items both discount the subtotal today, because per-line allocation is not implemented. This is the field that decides which total the discount comes off, which is why omitting it is refused rather than defaulted.

Available options:

order,

items,

shipping_methods

allocation

enum<string>

Defaults to across. Stored and published so a client can read back what it set; nothing on the money path branches on it today.

Available options:

across,

each

percentage_basis_points

integer

Sets a percentage method. Basis points, so 15% is 1500. 1..10000. Mutually exclusive with amount_minor, and a currency_code beside it is refused: a ratio has none.

Required range: x >= 1

amount_minor

integer

Sets a fixed method, in minor units. Mutually exclusive with percentage_basis_points, and requires currency_code in the same object. On a buy-get method it is PER DISCOUNTED UNIT, not per order.

Required range: x >= 1

currency_code

string

Required with amount_minor and refused without it. Stored on this table, unlike on the discount itself, but still asserted: it must equal the store's base currency or the write is refused with 409 currency_mismatch, because the amount is subtracted from the cart total without conversion.

apply_to_quantity

integer

The SWITCH that makes this a Buy X Get Y method: with it set, the money path computes a buy-get discount and never runs the standard one. Discounted target units granted per trigger. Must be sent together with buy_rules_min_quantity, and needs buy and target rules on the discount, or the offer computes zero.

Required range: x >= 1

buy_rules_min_quantity

integer

Units matching the discount's buy rules required to trigger the offer. Only read on a buy-get method, so it is refused without apply_to_quantity rather than stored where nothing would read it.

Required range: x >= 1

max_quantity

integer

Cap on total discounted units. Only read on a buy-get method, so it is refused without apply_to_quantity. Omit for uncapped.

Required range: x >= 1

Response

Success

data

object

Show child attributes

Overview

Endpoints

Set a discount's application method

Authorizations

Headers

Path Parameters

Body

Response