LogoLogo
Build appsContact API support
  • Build apps
  • Site Templates
  • API Reference
  • Changelog
  • REST API
    • REST API overview
    • Store Profile
      • Get store profile
      • Update store profile
      • Upload store logo image
      • Delete store logo image
      • Store reports
        • Get store reports
        • Get latest store update stats
        • Get deleted items history
    • Orders
      • Search orders
      • Get order
      • Get last order
      • Calculate order details
      • Update order
      • Create order
      • Delete order
      • Get repeat order URL
      • Order invoices
        • Get order receipt PDF
        • Get tax invoices for order
        • Generate tax invoice for order
      • Order statuses
        • Search order statuses
        • Get order status
        • Update custom order status
      • Order extra fields
        • Search order extra fields
        • Update order extra field
        • Add extra fields to order
        • Delete order extra field
      • Abandonned carts
        • Search abandoned carts
        • Get abandoned cart
        • Update abandoned cart
        • Convert abandoned cart to order
      • Recurring subscriptions
        • Search recurring subscriptions
        • Get recurring subscription
        • Update recurring subscription
    • Products
      • Search products
      • Get product
      • Update product
      • Create product
      • Delete product
      • Delete all products
      • Adjust product stock
      • Get product filters
      • Get recently used product swatches
      • Search product brands
      • Product images and videos
        • Upload main product image
        • Upload main product image (async)
        • Upload gallery product image
        • Upload gallery product image (async)
        • Delete main product image
        • Delete gallery product image
        • Delete all gallery product images
        • Upload main product video
        • Upload gallery product video
        • Upload cover for gallery video
        • Delete main product video
        • Delete gallery product video
        • Download gallery product video
        • Bulk update product images and videos
      • Product files
        • Upload product file
        • Download product file
        • Delete product file
        • Delete all product files
        • Change product file description
      • Product variations
        • Search product variations
        • Get product variation
        • Update product variation
        • Create product variation
        • Delete product variation
        • Delete all product variations
        • Adjust product variation stock
        • Upload product variation image
        • Upload product variation image (async)
        • Delete product variation image
      • Product types and attributes
        • Search product types
        • Get product type
        • Update product type and attributes
        • Create product type
        • Delete product type
      • Product reviews
        • Search product reviews
        • Get product reviews stats
        • Update product review status
        • Bulk update/delete product reviews
        • Delete product review
    • Categories
      • Search categories
      • Search categories by path
      • Get category
      • Update category
      • Create category
      • Delete category
      • Category images
        • Upload category image
        • Upload category image (async)
        • Delete category image
      • Manage order of categories in the store
        • Get order of categories
        • Update order of categories
      • Manage order of products in the category
        • Get order of products
        • Update order of products
        • Assign products to the category
        • Unassign products from the category
    • Customers
      • Search customers
      • Get customer
      • Update customer
      • Create customer
      • Delete customer
      • Customer groups
        • Search customer groups
        • Get customer group
        • Update customer group name
        • Create customer group
        • Delete customer group
      • Customer contacts
        • Search customer contacts
        • Get customer contact
        • Update customer contact
        • Create customer contact
        • Delete customer contact
      • Customer extra fields
        • Search customer extra fields
        • Get customer extra field
        • Update customer extra field
        • Create customer extra field
        • Delete customer extra field
    • Discounts
      • Promotions
        • Search promotions
        • Update promotion
        • Create promotion
        • Delete promotion
      • Discount coupons
        • Search discount coupons
        • Get discount coupon
        • Update discount coupon
        • Create discount coupon
        • Delete discount coupon
    • Domains
      • Search store domains
      • Update store domains
      • Search domains for purchase
      • Purchase domain
      • Send domain verification email
      • Reset domain password
    • Dictionaries
      • Country codes
      • Currency codes
      • Currency codes by country
      • State codes by country
      • Tax classes by country
    • Staff accounts
      • Search staff accounts
      • Get staff account
      • Get staff account scopes
      • Update staff account
      • Create staff account
      • Delete staff account
      • Resend staff account invite
      • Cancel staff account invite
    • Application
      • Get app subscription status
      • Cancel app subscription
      • Get all app storage data
      • Get specific app storage data
      • Update specific app storage data
      • Delete specific app storage data
      • Add app storage data
      • Custom charge with Ecwid billing
    • Batch requests
      • Create batch request
      • Get batch status
      • Search batch requests by status
      • Stop batch request
      • Stop and delete batch request
    • Shipping options
      • Search shipping options
      • Update shipping option
      • Create shipping option
      • Delete shipping option
    • Payment options
      • Search payment options
      • Get payment option
      • Update payment option
      • Create payment option
      • Delete payment option
    • Checkout extra fields
      • Add checkout extra fields with JavaScript
      • Manage checkout extra fields with REST API
        • Search checkout extra fields
        • Get checkout extra field
        • Update checkout extra field
        • Create checkout extra field
        • Delete checkout extra field
    • Storefront widget details
      • Get page slug and static code
      • Set base URL for storefront widgets
      • Optimize custom website SEO with better URLs
        • Enable Clean Store URLs on a custom website
        • Set Custom Page Slugs on a custom website
      • Dynamic loading for storefront widget
      • SSO (Single-Sign-On) for websites
        • Add SSO to the website
        • Customize SSO on the website
        • SSO code examples
      • Static store pages
        • Static code for home page
        • Static code for category page
        • Static code for product page

Lightspeed® 2025

On this page
  • Required access scopes
  • Path params
  • Query params
  • Headers
  • Response JSON

Was this helpful?

  1. REST API
  2. Discounts
  3. Discount coupons

Get discount coupon

GET https://app.ecwid.com/api/v3/{storeId}/discount_coupons/{discountCouponId}

Request and response example

Request:

curl --location 'https://app.ecwid.com/api/v3/1003/discount_coupons/DISC' \
--header 'Authorization: Bearer secret_ab***cd'

Response:

{
    "id": 162428889,
    "name": "Summer Promo",
    "code": "DISC",
    "discountType": "ABS",
    "status": "ACTIVE",
    "discount": 10,
    "launchDate": "2022-07-28 23:00:00 +0000",
    "usesLimit": "UNLIMITED",
    "repeatCustomerOnly": false,
    "applicationLimit": "UNLIMITED",
    "creationDate": "2022-07-29 15:22:35 +0000",
    "updateDate": "2024-05-01 05:26:28 +0000",
    "orderCount": 1
}

Required access scopes

Your app must have the following access scopes to make this request: read_discount_coupons

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

discountCouponId

number

Internal discount coupon ID.

Query params

All query params are optional.

Name
Type
Description

responseFields

string

Specify the exact fields to receive in response JSON. If not specified, the response JSON will have all available fields for the entity. For example: ?responseFields=id,name,status

Example of using responseFields param:

curl --location 'https://app.ecwid.com/api/v3/1003/discount_coupons/DISC?responseFields=id,name,status' \
--header 'Authorization: Bearer secret_ab***cd'
{
    "id": 162428889,
    "name": "Summer Promo",
    "status": "ACTIVE"
}

Headers

The Authorization header is required.

Header
Format
Description

Authorization

Bearer secret_ab***cd

Access token of the application.

Response JSON

A JSON object with the following fields:

Field
Type
Description

id

number

Internal unique coupon ID.

name

string

Discount coupon name visible on the storefront.

code

string

Discount coupon code used for its activation at the checkout.

discountType

string

Discount type One of: ABS PERCENT SHIPPING ABS_AND_SHIPPING PERCENT_AND_SHIPPING

status

string

Current state of the discount coupon. One of: ACTIVE PAUSED EXPIRED USEDUP

discount

number

Discount coupon value.

launchDate

string

The date of coupon launch, for example, 2014-06-06 08:00:00 +0400. Any date provided will be corrected to the UTC +0 timezone.

expirationDate

string

Coupon expiration date, e.g. 2014-06-06 08:00:00 +0400. Any date provided will be corrected to the UTC +0 timezone.

totalLimit

number

Minimum order subtotal for the discount coupon to be applied.

usesLimit

string

Number of uses limitation. One of: UNLIMITED ONCEPERCUSTOMER SINGLE

applicationLimit

string

User application limit for the discount coupon.

One of: UNLIMITED - no user application limits. NEW_CUSTOMER_ONLY - discount coupon can be applied only by customers without placed orders. REPEAT_CUSTOMER_ONLY - discount coupon can be applied only by customers who placed orders in the store before.

creationDate

string

Coupon creation date. Format example: 2023-06-29 11:36:55 +0000

updateDate

string

Coupon update date. Format example: 2023-06-29 11:36:55 +0000

orderCount

number

Count of orders where the discount coupon was used.

catalogLimit

Product and category limitations for the discount coupon. If empty, discount coupon can be applied to all products and categories available on the storefront.

shippingLimit

Shipping method limitations for the discount coupon. If empty, discount coupon can be applied to any shipping method available at the checkout.

catalogLimit

Field
Type
Description

products

array of numbers

List of product IDs the discount coupon can be applied to, for example, [123456,234567]

categories

array of numbers

List of category IDs the discount coupon can be applied to, for example, [0,87253552,765257901]

shippingLimit

Field
Type
Description

shippingMethods

array of strings

List of shipping method IDs the discount coupon can be applied to, for example, ["18765-8651899366181"]

Last updated 2 months ago

Was this helpful?

object

object

catalogLimit
shippingLimit