Create a customer discount

POST https://api.tamio.com/v2/discounts/customer-discount/create

Creates a new customer-specific discount. Customer discounts always use the "coupon" condition and require a customer UUID and coupon code.

Note: At least one of amount_off, percent_off, shipping_amount_off, or shipping_percent_off must be greater than zero.

Body Parameters

type string*

customer_discount

label string*

Display name for the discount

customer string*

UUID of the customer this discount is restricted to

coupon string*

Coupon code the customer must enter

applies_to string*

What products this discount applies to

selected_productsall_products

currency string*

Currency code for amount-based discounts

amount_off integer*

Fixed amount discount in smallest currency unit

percent_off number*

Percentage discount (0-100)

shipping_percent_off number*

Percentage discount on shipping (0-100)

shipping_amount_off integer*

Fixed amount discount on shipping in smallest currency unit

active boolean*

Whether the discount is currently active

coupon_max_redemptions integer

Maximum number of times this coupon can be redeemed

expiry_date string

Date when the discount expires (null for no expiry)

subscription_discount_duration string

How long the discount applies to subscriptions

once

duration integer

Duration in months for recurring discounts

order_condition string

Additional order-level condition

order_subtotalorder_shippingorder_quantity

rule_amount integer

Minimum amount for order conditions

products array of string

Product UUIDs (required when applies_to is "selected_products")

Example

{
  "type": "customer_discount",
  "label": "VIP Customer Discount",
  "customer": "550e8400-e29b-41d4-a716-446655440001",
  "coupon": "VIP20OFF",
  "coupon_max_redemptions": 5,
  "applies_to": "all_products",
  "currency": "EUR",
  "amount_off": 2000,
  "percent_off": 0,
  "shipping_percent_off": 0,
  "shipping_amount_off": 0,
  "active": true
}

Responses

200 Customer discount created successfully

Customer discount created successfully

status integer

discount Discount

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`1002`	Customer or product UUID not found
`10273`	Required conditional parameters missing (products)

status integer

error string

error_code integer

401 Unauthorized – invalid or missing Bearer token

Create a product discount

Update a product discount

/discounts/customer-discount/create

1 const response = await fetch("https://api.tamio.com/v2/discounts/customer-discount/create", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "type": "customer_discount",
9     "label": "VIP Customer Discount",
10     "customer": "550e8400-e29b-41d4-a716-446655440001",
11     "coupon": "VIP20OFF",
12     "coupon_max_redemptions": 5,
13     "applies_to": "all_products",
14     "currency": "EUR",
15     "amount_off": 2000,
16     "percent_off": 0,
17     "shipping_percent_off": 0,
18     "shipping_amount_off": 0,
19     "active": true
20   })
21 });
22 const data = await response.json();

1 require "uri"
2 require "net/http"
3 require "json"
4 
5 url = URI("https://api.tamio.com/v2/discounts/customer-discount/create")
6 
7 https = Net::HTTP.new(url.host, url.port)
8 https.use_ssl = true
9 
10 request = Net::HTTP::Post.new(url)
11 request["Accept"] = "application/json"
12 request["Authorization"] = "Bearer YOUR_API_KEY"
13 request["Content-Type"] = "application/json"
14 request.body = {
15   type: "customer_discount",
16   label: "VIP Customer Discount",
17   customer: "550e8400-e29b-41d4-a716-446655440001",
18   coupon: "VIP20OFF",
19   coupon_max_redemptions: 5,
20   applies_to: "all_products",
21   currency: "EUR",
22   amount_off: 2000,
23   percent_off: 0,
24   shipping_percent_off: 0,
25   shipping_amount_off: 0,
26   active: true
27 }.to_json
28 
29 response = https.request(request)
30 puts response.read_body

Responses

{
  "status": 200,
  "discount": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "object": "discount",
    "label": "Summer Sale 10% Off",
    "currency": "EUR",
    "percent_off": 10,
    "amount_off": 0,
    "shipping_percent_off": 0,
    "shipping_amount_off": 0,
    "active": true,
    "type": "product_discount",
    "condition": "coupon",
    "applies_to": "all_products",
    "rule_amount": 5000,
    "order_condition": "order_subtotal",
    "block_affiliates": false,
    "destinations": [
      "worldwide"
    ],
    "payments": [
      "all"
    ],
    "expiry_date": 1735689600,
    "subscription_discount_duration": "once",
    "number_of_months": 3,
    "domain": 12,
    "customer": "660e8400-e29b-41d4-a716-446655440001",
    "products": [
      "770e8400-e29b-41d4-a716-446655440002"
    ],
    "categories": {
      "physical": [
        "clothing",
        "accessories"
      ],
      "digital": [],
      "services": [],
      "billing_plans": []
    },
    "coupon": "SUMMER10",
    "coupon_max_redemptions": 100,
    "coupon_times_redeemed": 45,
    "vouchers": [],
    "voucher_method": "autogenerated",
    "voucher_prefix": "SALE_",
    "number_of_vouchers": 100,
    "created_at": 1700000000
  }
}

1	const response = await fetch("https://api.tamio.com/v2/discounts/customer-discount/create", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"type": "customer_discount",
9	"label": "VIP Customer Discount",
10	"customer": "550e8400-e29b-41d4-a716-446655440001",
11	"coupon": "VIP20OFF",
12	"coupon_max_redemptions": 5,
13	"applies_to": "all_products",
14	"currency": "EUR",
15	"amount_off": 2000,
16	"percent_off": 0,
17	"shipping_percent_off": 0,
18	"shipping_amount_off": 0,
19	"active": true
20	})
21	});
22	const data = await response.json();

1	require "uri"
2	require "net/http"
3	require "json"
4
5	url = URI("https://api.tamio.com/v2/discounts/customer-discount/create")
6
7	https = Net::HTTP.new(url.host, url.port)
8	https.use_ssl = true
9
10	request = Net::HTTP::Post.new(url)
11	request["Accept"] = "application/json"
12	request["Authorization"] = "Bearer YOUR_API_KEY"
13	request["Content-Type"] = "application/json"
14	request.body = {
15	type: "customer_discount",
16	label: "VIP Customer Discount",
17	customer: "550e8400-e29b-41d4-a716-446655440001",
18	coupon: "VIP20OFF",
19	coupon_max_redemptions: 5,
20	applies_to: "all_products",
21	currency: "EUR",
22	amount_off: 2000,
23	percent_off: 0,
24	shipping_percent_off: 0,
25	shipping_amount_off: 0,
26	active: true
27	}.to_json
28
29	response = https.request(request)
30	puts response.read_body