Coupons

Manage discount coupons and promotional codes for your store. Create percentage or fixed-amount discounts with rules, expiration dates, and usage limits.

Basic CRUD Actions

Get Coupons listing

View on Postman

Get a list of all coupons.

JavaScript

let coupons = await Client.API.Core.Coupons.all();

TypeScript

import { Response, Coupons } from "@tscommerce/sdk-typescript"

Client.API.Core.Coupons.all().then((response:Response<Coupons>) => {
    response.resource.forEach((coupon) => {
        console.log(coupon.id, coupon.code);
    });
});

PHP

$coupons = $client->API->Core->Coupons->all();

Create new Coupon

View on Postman

Create a brand new coupon code.

JavaScript

const payload = {
    code: 'SUMMER2025',
    discount_type: 'percentage',
    discount_value: 20,
    valid_from: '2025-06-01',
    valid_to: '2025-08-31'
};
let coupon = await Client.API.Core.Coupons.create(payload);

TypeScript

import { Response, Coupon, CreateCouponPayload } from "@tscommerce/sdk-typescript"

const payload:CreateCouponPayload = {
    code: 'SUMMER2025',
    discount_type: 'percentage',
    discount_value: 20,
    valid_from: '2025-06-01',
    valid_to: '2025-08-31'
};

Client.API.Core.Coupons.create(payload).then((response:Response<Coupon>) => {
    console.log('Created coupon:', response.resource);
});

PHP

$payload = [
    'code' => 'SUMMER2025',
    'discount_type' => 'percentage',
    'discount_value' => 20,
    'valid_from' => '2025-06-01',
    'valid_to' => '2025-08-31'
];
$coupon = $client->API->Core->Coupons->create($payload);

Get Coupon

View on Postman

Get an existing coupon by ID.

JavaScript

const couponId = 123;
let coupon = await Client.API.Core.Coupons.read(couponId);

TypeScript

import { Response, Coupon } from "@tscommerce/sdk-typescript"

const couponId:Coupon['id'] = 123;
Client.API.Core.Coupons.read(couponId).then((response:Response<Coupon>) => {
    console.log('Coupon:', response.resource);
});

PHP

$couponId = 123;
$coupon = $client->API->Core->Coupons->read($couponId);

Update Coupon

View on Postman

Update an existing coupon.

JavaScript

const couponId = 123;
const payload = {
    discount_value: 25,
    valid_to: '2025-09-30'
};
let coupon = await Client.API.Core.Coupons.update(couponId, payload);

TypeScript

import { Response, Coupon, UpdateCouponPayload } from "@tscommerce/sdk-typescript"

const couponId:Coupon['id'] = 123;
const payload:UpdateCouponPayload = {
    discount_value: 25,
    valid_to: '2025-09-30'
};

Client.API.Core.Coupons.update(couponId, payload).then((response:Response<Coupon>) => {
    console.log('Updated coupon:', response.resource);
});

PHP

$couponId = 123;
$payload = [
    'discount_value' => 25,
    'valid_to' => '2025-09-30'
];
$coupon = $client->API->Core->Coupons->update($couponId, $payload);

Delete Coupon

View on Postman

Delete a coupon.

JavaScript

const couponId = 123;
Client.API.Core.Coupons.delete(couponId);

TypeScript

import { Response, Coupon } from "@tscommerce/sdk-typescript"

const couponId:Coupon['id'] = 123;
Client.API.Core.Coupons.delete(couponId).then((response:Response) => {
    console.log('Coupon deleted successfully');
});

PHP

$couponId = 123;
$client->API->Core->Coupons->delete($couponId);

Bulk Actions

Bulk delete Coupons

View on Postman

Delete multiple coupons at once.

JavaScript

const couponIds = [123, 456, 789];
Client.API.Core.Coupons.bulkDelete({ ids: couponIds });

TypeScript

import { Response, BulkDeleteCouponPayload } from "@tscommerce/sdk-typescript"

const payload:BulkDeleteCouponPayload = {
    ids: [123, 456, 789]
};

Client.API.Core.Coupons.bulkDelete(payload).then((response:Response) => {
    console.log('Coupons deleted successfully');
});

PHP

$payload = ['ids' => [123, 456, 789]];
$client->API->Core->Coupons->bulkDelete($payload);