Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Coupons
  • Welcome 👋
  • Get Started
  • Create Your First App
  • Authorization
  • Webhooks
  • Conditional Webhooks
  • Security Considerations
  • Multi-Language Support
  • Responses
  • Pagination
  • Rate Limiting
  • Versioning
  • Change Log
  • Support
  • APIs
    • Orders
      • Create Order
      • List Orders
      • Order Details
      • Create Drafted Order
      • Update Order
      • Duplicate Order
      • Order Actions
    • Order Status
      • Update Order Status
      • Create Custom Order Status
      • List Order Statuses
      • Order Status Details
      • Update Custom Order Status
      • Update Bulk Orders Statuses
      • Sort Orders Statuses
    • Order Histories
      • List Order Histories
      • Create Order History
    • Order Tags
      • Create Order Tag
      • List Order Tags
      • Delete Order Tag
    • Order Invoice
      • Create Invoice
      • List Invoices
      • Invoice Details
      • Send Order Invoice
      • Create Order Invoice
    • Order Reservations
      • List Order Reservations
    • Order Items
      • List Order Items
      • Create Order Item
      • Update Order Item
      • Delete Order Item
    • Products
      • Create Product
      • List Products
      • Product Details
      • Update Product
      • Delete Product
      • Change Product Status
      • Product Details By SKU
      • Update Product By SKU
      • Delete Product By SKU
      • Update Product Price By SKU
      • Update Bulk Product Prices
      • Import Products
      • Bulk Product Actions
    • Product Options
      • Create Product Option
      • Product Option Details
      • Update Product Option
      • Delete Product Option
    • Product Quantity
      • List Product Quantities
      • Update Bulk Quantities
      • List Quantity Change Reasons
      • List Quantity Audit
      • Update Bulk Quantities by SKU
      • Update Quantity
      • Update Quantity By SKU
    • Product Variants
      • List Product Variants
      • Product Variant Details
      • Update Product Variant
      • Update Product Variant Quantity
    • Product Tags
      • Create Product Tag
      • List Product Tags
    • Product Images
      • Attach Image by SKU
      • Attach Video by SKU
      • Attach Youtube Video
      • Attach Image
      • Update Image
      • Delete Image
    • Product Option Values
      • Create Product Option Value
      • Product Option Value Details
      • Update Product Option Value
      • Delete Product Option Value
    • Abandoned Carts
      • List Abandoned Carts
      • Abandoned Cart Details
    • Customer Groups
      • Create Customer Group
      • List Customer Groups
      • Add Customers To Group Customer
      • Update Default Customer Group
      • Update Customer Group
      • Delete Customer Group
    • Customers
      • Create Customer
      • List Customers
      • Customer Details
      • Update Customer
      • Delete Customer
      • Ban Customer
      • Un-Ban customer
      • Import Customers
    • Digitals Product
      • Attach Digital Code
      • Attach Digital File
      • Delete Digital File
    • Categories
      • Create Category
      • List Categories
      • Category Details
      • Update Category
      • Delete Category
      • Category Children
      • Categories Search
      • List Category Products
    • Exports
      • Export Orders
      • Exports Logs
      • List Export Templates
      • Create Export Template
      • Update Export Template
      • Delete Export Template
      • List Export Columns
      • Export Customers
      • Export Custom URLs
      • Export Products
    • Shipments
      • Create Shipment
      • List Shipments
      • Shipment Details
      • Shipment Tracking
      • Update Shipment Details
      • Cancel Shipment
      • Return Shipment
    • Shipping Companies
      • List Shipping Companies
      • Shipping Company Details
      • List Estimate Rates
      • Create Shipping Company
      • Update Shipping Company
      • Delete Shipping Company
      • Shipping Company Options
    • Shipping Zones
      • Create Shipping Zone
      • List Shipping Zones
      • Shipping Zone Details
      • Update Shipping Zone
      • Delete Shipping Zone
    • Shipping Rules
      • List Shipping Rules
      • Shipping Rule Details
      • Delete Shipping Rule
    • Countries
      • List Countries
      • Country Details
    • Product Option Templates
      • List Option Templates
      • Option Template Details
      • Delete Option Template
      • Update Option Template
      • Create Option Template
    • Taxes
      • Create Tax
      • List Taxes
      • Tax Details
      • Update Tax
      • Delete Tax
    • Coupons
      • Create Coupon
        POST
      • List Coupons
        GET
      • Coupon Details
        GET
      • Update Coupon
        PUT
      • Delete Coupon
        DELETE
      • List Coupon Codes
        GET
    • Affiliates
      • List Affiliates
      • Affiliate Details
      • Create Affiliate
      • Update Affiliate
      • Delete Affiliate
    • Order Assignment
      • List Auto Assignment Rules
      • Order Assigned Employees Details
      • Update Auto Assignment Rule
      • Create Auto Assignment Rules
    • Special Offers
      • Create Special Offer
      • List Special Offers
      • Special Offer Details
      • Update Special Offer
      • Delete Special Offer
      • Change Special Offer Status
    • Transactions
      • List Transactions
      • Transaction Details
      • Update Transaction
    • Payments
      • Available Payment Methods
      • List Banks
      • Payment Bank Details
    • Settlements
      • List Instant Settlements
      • Create Instant Settlement
      • Update Instant Settlement
      • Instant Settlement Details
    • Settings
      • Settings List
      • Update Setting Slug
      • Setting Details
    • Merchant
      • User Information Details
      • Store Information
    • Brands
      • Create Brand
      • List Brands
      • Brand Details
      • Update Brand
      • Delete Brand
    • Branches
      • Create Branch
      • List Branches
      • Branch Details
      • Update Branch
      • Delete Branch
    • Currencies
      • Activate Currencies
      • List Currencies
      • List Available Currencies
    • SEO
      • List SEO Settings
      • Update SEO Settings
    • Cities
      • List Cities
    • DNS Records
      • List DNS Records
      • Create DNS Record
      • Delete DNS Record
    • Languages
      • Add Language
      • List Languages
      • Update Language
    • Employees
      • List Employees
    • Advertisements
      • Create Advertisement
      • List Advertisements
      • Advertisement Details
      • Update Advertisement
      • Delete Advertisement
    • Webhooks
      • List Active Webhooks
      • List Events
      • Register Webhook
      • Deactivate Webhook
      • Update Webhook
    • Custom URLs
      • Import Custom URLs
    • Loyalty Points
      • Customer Loyalty Points
      • Update Customer Loyalty Points
    • Reviews
      • List Reviews
      • Review Details
      • Update Review
  • Webhooks - Store Events
    • Order
    • Product
    • Customer
    • Shippings
    • Shipments
    • Brand
    • Invoice
    • Category
    • Store
    • Special Offer
    • Cart
    • Miscellaneous
  1. Coupons

Coupon Details

Production
https://api.salla.dev/admin/v2
Production
https://api.salla.dev/admin/v2
GET
https://api.salla.dev/admin/v2
/coupons/{coupon_id}
Coupons
Last modified:2025-04-20 13:16:13
This endpoint allows you to fetch details regarding a coupon by passing the coupon_id as a path parameter.
Scopes
marketing.read- Marketing Read Only

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
coupon_id
string 
required
Unique identification number assigned to the Coupon. List Coupon IDs can be found here.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.salla.dev/admin/v2/coupons/'

Responses

🟢200Success
application/json
Body
status
number 
optional
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
success
boolean 
optional
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
data
object (Coupon) 
optional
id
number 
required
Coupon unique identifier. List of Coupon ID can be found here.
Example:
815296212
code
string 
required
Coupon code.
Example:
AAVVC
type
enum<string> 
required
Coupon type.
Allowed values:
percentagePercentagefixedFixedfp
Example:
percentage
status
enum<string> 
required
Coupon status.
Allowed values:
activeinactivedeleted
Example:
active
is_apply_with_offer
boolean  | null 
optional
In case the variable is set to true, the coupon will be applied with the created offer that has an apply with coupon option activated in the offers; otherwise, it will not be applied.
amount
object 
required
Coupon amount.
minimum_amount
object 
required
The minimum coupon amount.
maximum_amount
object 
required
The maximum coupon amount.
show_maximum_amount
boolean 
required
Whether or not to show the coupon's maximum amount
Default:
false
expiry_date
string 
required
Coupon expiry date. Value MUST be at least one day later than today. Supports two formats, either YYYY-MM-DD or YYYY-MM-DD HH:MM:SS
Example:
2022-12-31 12:59:59
start_date
string 
required
Coupon start date. Supports two formats, either YYYY-MM-DD or YYYY-MM-DD HH:MM:SS
Example:
2022-12-28 12:59:59
free_shipping
boolean 
required
Whether or not to the coupon includes free shipping
Default:
true
usage_limit
number 
required
Coupon's usage limit
Example:
89
usage_limit_per_user
number 
required
Coupon's usage limit per user
Example:
88
include_product_ids
array[string]
required
List of included products IDs. List of products can be found [here]https://docs.salla.dev/api-5394168).
exclude_product_ids
array[string]
required
List of excluded product IDs. List of products ca be found [here]https://docs.salla.dev/api-5394168).
is_sale_products_exclude
boolean 
required
Whether or not to exclude On-Sale Products
Default:
true
include_category_ids
array[string]
required
List of included product Category IDs. List of categories can be found [here] (https://docs.salla.dev/api-5394207)
exclude_category_ids
array[string]
required
List of included Category IDs. List of categories can be found [here] (https://docs.salla.dev/api-5394207)
include_customer_group_ids
array[string]
required
List of included Customer Group IDs. List of customer groups can be found [here] (https://docs.salla.dev/api-5394129)
exclude_customer_group_ids
array[string]
required
List of excluded Customer Group IDs. List of customer groups can be found [here] (https://docs.salla.dev/api-5394129)
exclude_brands_ids
array[string]
required
List of excluded Brand IDs. List of brands can be found [here] (https://docs.salla.dev/api-5394213)
exclude_shipping_ids
array[string]
required
List of excluded Shipment Company IDs. Shipping companies list can be found here
include_customer_ids
array[string]
required
List of excluded Customer IDs. List of customers can be found here
include_payment_methods
array[string]
required
List of included Payment Methods. List of Available Payment Methods can be found here.
Allowed values:
allapple_paybankcodcredit_cardknetmadapaypalspotii_paystc_paytabby_installmenttamara_installment
applied_in
enum<string> 
required
Coupon to be applied at. Value can either all or web or app
Allowed values:
allwebapp
Example:
all
is_group
boolean 
required
Whether or not the Coupon is part of a group of Coupons
Default:
true
group_name
string  | null 
required
Coupon Group Name. requiredif is_group = true; otherwise returns null value
Example:
Grouping1
group_coupons_count
number  | null 
required
Coupon Group Count.requiredif is_group = true; otherwise returns null value
Example:
90
group_coupon_suffix
string  | null 
required
Coupon Group Suffix. requiredif is_group = true; otherwise returns null value
Example:
xyz
group_coupons
array [object {1}] 
required
Group Coupons. requiredif is_group = true; otherwise returns null value
beneficiary_domain
string  | null 
required
Beneficiary’s email domain name
Example:
domain.test
statistics
object 
required
Coupon statistics.
Example:
domain.test
created_at
object 
required
Date and time of creating the coupon.
updated_at
object 
required
Date and time of updating the coupon.
marketing_active
boolean 
required
Whether or not the Marketing is active for a certain Coupon
Default:
true
marketing_name
string  | null 
required
Marketer name assoicated to the Coupon. requiredif marketing_active = true; otherwise returns null value
Example:
User Name
marketing_email
string  | null 
required
Marketer email assoicated to the Coupon. Value may appear if marketing_acive: true; otherwise returns null value.
Example:
[email protected]
marketing_type
enum<string> 
required
Coupon type.
Allowed values:
percentagePercentagefixedFixedfp
Example:
percentage
marketing_amount
object  | null 
required
The amount due to the marketer. requiredif marketing_active = true; otherwise returns null value
marketing_hide_total_sales
boolean  | null 
required
Whether or not to hide the total sales from the marketer's stastics page. Value may appear if marketing_acive: true; otherwise returns null value.
Default:
false
marketing_show_maximum_amount
boolean  | null 
required
Whether or not to show the maximum amount of marketing amount to the marketers. Value may appear if marketing_acive: true; otherwise returns null value.
Default:
true
marketing_maximum_amount
number  | null 
required
Marketing maximum amount. Value may appear if marketing_acive: true; otherwise returns null value.
Default:
0
Example:
4000
marketing_info
string  | null 
required
Additional notes to the Marketer. Value may appear if marketing_acive: true; otherwise returns null value.
Example:
Additional Notes
marketing_visits_count
number  | null 
required
Marketing visit counts. Value may appear if marketing_acive: true; otherwise returns null value.
Example:
33
marketing_url
string  | null 
required
Marketing URL. Value may appear if marketing_acive: true; otherwise returns null value.
Example:
https://salla.sa/teststore?utm_source=ref&utm_campaign=QAZCVS
marketing_statistics_url
string  | null 
required
Marketing statistics URL. value may appear if marketing_acive: true; otherwise returns null value.
Example:
https://mtjr.coupons/VvVMP
Example
{
  "status": 200,
  "success": true,
  "data": {
    "id": 6930446,
    "code": "DEAL",
    "type": "fixed",
    "status": "active",
    "is_apply_with_offer": true,
    "amount": {
      "amount": 30,
      "currency": "SAR"
    },
    "minimum_amount": null,
    "maximum_amount": {
      "amount": 0,
      "currency": "SAR"
    },
    "show_maximum_amount": false,
    "expiry_date": "2023-03-17 00:00:00",
    "start_date": null,
    "free_shipping": true,
    "usage_limit": null,
    "usage_limit_per_user": null,
    "include_product_ids": [],
    "exclude_product_ids": [],
    "is_sale_products_exclude": true,
    "include_category_ids": [],
    "exclude_category_ids": [],
    "include_customer_group_ids": [],
    "exclude_customer_group_ids": [],
    "exclude_brands_ids": [],
    "exclude_shipping_ids": [],
    "include_payment_methods": [],
    "applied_in": "all",
    "is_group": true,
    "group_name": "Deals",
    "group_coupons_count": 3,
    "group_coupon_suffix": "DEAL",
    "group_coupons": [
      {
        "code": "DEAL5Wsl"
      },
      {
        "code": "DEALgaNN"
      },
      {
        "code": "DEALFRa7"
      }
    ],
    "beneficiary_domain": null,
    "statistics": {
      "num_of_usage": 0,
      "num_of_customers": 0,
      "coupon_sales": {
        "amount": 0,
        "currency": "SAR"
      }
    },
    "created_at": {
      "date": "2022-04-06 12:55:06.000000",
      "timezone_type": 3,
      "timezone": "Asia/Riyadh"
    },
    "updated_at": {
      "date": "2022-04-06 12:55:06.000000",
      "timezone_type": 3,
      "timezone": "Asia/Riyadh"
    },
    "marketing_active": false,
    "marketing_name": null,
    "marketing_type": null,
    "marketing_amount": null,
    "marketing_hide_total_sales": false,
    "marketing_show_maximum_amount": false,
    "marketing_maximum_amount": null,
    "marketing_info": null,
    "marketing_visits_count": null,
    "marketing_url": null,
    "marketing_statistics_url": null
  }
}
🟠404Not Found
🟠422Error Validation
🟠401Unauthorized
Modified at 2025-04-20 13:16:13
Previous
List Coupons
Next
Update Coupon