Update Order Discount

Beta

PATCH/v1/sales/order-discounts/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates an order discount.

Only the fields you send are changed; the rest keep their current values. Changing code to one another discount already holds returns a conflict error. Edits apply to future orders only — orders that already used this discount keep the reduction they were given.

Permissions requiredValues:discounts:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Order discount ID.

nameoptional string

Display name of the discount.

codeoptional string

The code a buyer enters to apply this discount to an order.

Codes are unique within your account and are compared without regard to letter case.

percentageoptional string (decimal)

The fraction of the order total to take off, as a decimal string.

This is a multiplier, not a whole percent: send 0.1 to take 10% off. Only read when discount_type is percentage.

amountoptional string (decimal)

The flat amount to take off the order total, as a decimal string.

Only read when discount_type is amount.

discount_typeoptional stringenumValues:percentageamount

How the discount is calculated.

percentage: the order total is reduced by the fraction in percentage.
amount: the order total is reduced by the flat amount in amount.

Switching the type does not move the stored figure across, so send the matching percentage or amount in the same request or the discount will take nothing off.

idstring

Order discount ID.

objectstringenumValues:order_discount

Resource type identifier.

namestring

Display name of the discount.

codestring

The code a buyer enters to apply this discount to an order.

Codes are unique within your account and are matched without regard to letter case.

percentagestring (decimal)

The fraction of the order total taken off, as a decimal string.

This is a multiplier, not a whole percent: 0.1 takes 10% off. Only read when discount_type is percentage.

amountstring (decimal)

The flat amount taken off the order total, as a decimal string.

Only read when discount_type is amount.

discount_typestringenumValues:percentageamount

How the discount is calculated.

percentage: the order total is reduced by the fraction in percentage.
amount: the order total is reduced by the flat amount in amount.

order_countinteger

How many sales orders this discount has been applied to, across all buyers.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Order Discount

Update Order Discount

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const orderDiscount = await client.sales.orderDiscounts.update('ords_qnbrjvq5ih2q', {
  code: 'SAVE15',
  name: '15% Off',
});

console.log(orderDiscount.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const orderDiscount = await client.sales.orderDiscounts.update('ords_qnbrjvq5ih2q', {
  code: 'SAVE15',
  name: '15% Off',
});

console.log(orderDiscount.id);

200 example

{
  "id": "ords_qnbrjvq5ih2q",
  "object": "order_discount",
  "name": "10% Off",
  "code": "SAVE10",
  "percentage": "10.000000000000000000000000000000",
  "amount": "0.000000000000000000000000000000",
  "discount_type": "percentage",
  "order_count": 5,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ords_qnbrjvq5ih2q",
  "object": "order_discount",
  "name": "10% Off",
  "code": "SAVE10",
  "percentage": "10.000000000000000000000000000000",
  "amount": "0.000000000000000000000000000000",
  "discount_type": "percentage",
  "order_count": 5,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Order Discount

Authorization

Path Parameters

Request Body

Returns

Responses