Product Coupons

Authorization

Authorization<token>

In: header

Query Parameters

idstring

Generic ID filter (e.g., product, bundle, coupon, etc.)

couponCodestring

Coupon Code

couponValuenumber

Coupon Value

limitnumber

Coupon Usage Limit

startDatestring

Coupon Start Date (ISO 8601)

Format: "date-time"

endDatestring

Coupon End Date (ISO 8601)

Format: "date-time"

createdAtFromstring

Earliest creation date (ISO 8601 datetime)

Format: "date-time"

createdAtTostring

Latest creation date (ISO 8601 datetime)

Format: "date-time"

curl -X GET "https://dash.sellhub.cx/api/sellhub/products/coupons?id=%3Cstring%3E&couponCode=%3Cstring%3E&couponValue=0&limit=0&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&createdAtFrom=2019-08-24T14%3A15%3A22Z&createdAtTo=2019-08-24T14%3A15%3A22Z" \
  -H "Authorization: <token>"

List of coupons

{
  "data": {
    "coupons": [
      {
        "id": "coupon_123",
        "couponCode": "SUMMER2023",
        "couponValue": 20,
        "valueType": "percentage",
        "enableStartDate": true,
        "startDate": "2023-06-01T00:00:00Z",
        "enableEndDate": true,
        "endDate": "2023-08-31T23:59:59Z",
        "paymentsAccepted": [
          "credit_card",
          "paypal"
        ],
        "enableLimit": true,
        "couponLimit": 1000,
        "couponUsage": 20,
        "createdAt": "2023-05-15T10:30:00Z"
      }
    ]
  }
}

Authorization

Query Parameters

Response

TypeScript