Coupons API

API Endpoint
https://www.showclix.com/api

An API to fetch information about existing coupons.

Coupons API

Coupons Collection

GET https://www.showclix.com/api/coupons?sellerId=1&page=1&modifiedSince=1714594526
RequestsBasic seller levelBasic partner levelSpecific pageCoupons with modified time
Headers
Content-Type: application/json
Accept: application/json
Responses200400401403
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "My Coupon",
    "type": "Discount",
    "code": "my-code",
    "amount": 10,
    "amount_type": "percentage",
    "modified_time": 1719827944
  },
  {
    "id": 2,
    "name": "Reserved Coupon",
    "type": "Reserved",
    "code": "reserved-1",
    "modified_time": 1719827011
  }
]
Schema
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "id": {
                "type": "number"
            },
            "name": {
                "type": "string"
            },
            "type": {
                "type": "string"
            },
            "code": {
                "type": "string"
            },
            "amount": {
                "type": "number"
            },
            "amount_type" {
                "type": "string"
            },
            "modified_time": {
                "description": "Last time this coupon was modified",
                "format": "UNIX Timestamp",
                "type": "number"
            }
        }
    }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "400",
      "detail": [
        "Bad request"
      ]
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "401",
      "detail": "Unauthorized"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "403",
      "detail": "Forbidden"
    }
  ]
}
Headers
Content-Type: application/json
Accept: application/json
Responses200400401403
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "My Coupon",
    "type": "Discount",
    "code": "my-code",
    "amount": 10,
    "amount_type": "percentage",
    "modified_time": 1719827944
  },
  {
    "id": 2,
    "name": "Reserved Coupon",
    "type": "Reserved",
    "code": "reserved-1",
    "modified_time": 1719827011
  }
]
Schema
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "id": {
                "type": "number"
            },
            "name": {
                "type": "string"
            },
            "type": {
                "type": "string"
            },
            "code": {
                "type": "string"
            },
            "amount": {
                "type": "number"
            },
            "amount_type" {
                "type": "string"
            },
            "modified_time": {
                "description": "Last time this coupon was modified",
                "format": "UNIX Timestamp",
                "type": "number"
            }
        }
    }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "400",
      "detail": [
        "Bad request"
      ]
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "401",
      "detail": "Unauthorized"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "403",
      "detail": "Forbidden"
    }
  ]
}
Headers
Content-Type: application/json
Accept: application/json
Responses200400401403
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "My Coupon",
    "type": "Discount",
    "code": "my-code",
    "amount": 10,
    "amount_type": "percentage",
    "modified_time": 1719827944
  },
  {
    "id": 2,
    "name": "Reserved Coupon",
    "type": "Reserved",
    "code": "reserved-1",
    "modified_time": 1719827011
  }
]
Schema
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "id": {
                "type": "number"
            },
            "name": {
                "type": "string"
            },
            "type": {
                "type": "string"
            },
            "code": {
                "type": "string"
            },
            "amount": {
                "type": "number"
            },
            "amount_type" {
                "type": "string"
            },
            "modified_time": {
                "description": "Last time this coupon was modified",
                "format": "UNIX Timestamp",
                "type": "number"
            }
        }
    }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "400",
      "detail": [
        "Bad request"
      ]
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "401",
      "detail": "Unauthorized"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "403",
      "detail": "Forbidden"
    }
  ]
}
Headers
Content-Type: application/json
Accept: application/json
Responses200400401403
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "My Coupon",
    "type": "Discount",
    "code": "my-code",
    "amount": 10,
    "amount_type": "percentage",
    "modified_time": 1719827944
  },
  {
    "id": 2,
    "name": "Reserved Coupon",
    "type": "Reserved",
    "code": "reserved-1",
    "modified_time": 1719827011
  }
]
Schema
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "id": {
                "type": "number"
            },
            "name": {
                "type": "string"
            },
            "type": {
                "type": "string"
            },
            "code": {
                "type": "string"
            },
            "amount": {
                "type": "number"
            },
            "amount_type" {
                "type": "string"
            },
            "modified_time": {
                "description": "Last time this coupon was modified",
                "format": "UNIX Timestamp",
                "type": "number"
            }
        }
    }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "400",
      "detail": [
        "Bad request"
      ]
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "401",
      "detail": "Unauthorized"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "403",
      "detail": "Forbidden"
    }
  ]
}

Fetch a list of created coupons
GET/coupons?sellerId=1&page=1&modifiedSince=1714594526

Fetches created coupons visible to the user linked to your API token.

If your API token is seller level then the sellerId param is not required, it is inferred from the token.

Url Parameters

  • sellerId: (number, required if partner level) - The seller id to fetch coupons for.

  • page: (number) - The page number to fetch. 200 items are returned per page.

  • modifiedSince: (number) - The unix timestamp to fetch coupons modified since.

Coupon Details

GET https://www.showclix.com/api/coupons/1
Responses200400401403
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "My Coupon",
  "type": "Discount",
  "code": "my-code",
  "amount": 10,
  "amount_type": "percentage",
  "modified_time": 1719827944
}
Schema
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "id": {
            "type": "number"
        },
        "name": {
            "type": "string"
        },
        "type": {
            "type": "string"
        },
        "code": {
            "type": "string"
        },
        "amount": {
            "type": "number"
        },
        "amount_type" {
            "type": "string"
        },
        "modified_time": {
            "description": "Last time this coupon was modified",
            "format": "UNIX Timestamp",
            "type": "number"
        },
        "offers": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number"
                    },
                    "timezone": {
                        "type: "string"
                    },
                    "start_date": {
                        "type: "string"
                    },
                    "end_date": {
                        "type: "string"
                    },
                    "limit": {
                        "type: "number"
                    },
                    "ticket_limit": {
                        "type: "number"
                    },
                    "taggable": {
                        "type: "boolean"
                    },
                    "global": {
                        "type: "boolean"
                    },
                    "assignments": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "sellers": {
                                    "type": "array",
                                    "items": {
                                        "type": "number"
                                    }
                                },
                                "events": {
                                    "type": "array",
                                    "items": {
                                        "type": "number"
                                    }
                                },
                                "price_levels": {
                                    "type": "array",
                                    "items": {
                                        "type": "number"
                                    }
                                },
                                "bundles": {
                                    "type": "array",
                                    "items": {
                                        "type": "number"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "400",
      "detail": [
        "Bad request"
      ]
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "401",
      "detail": "Unauthorized"
    }
  ]
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "status": "403",
      "detail": "Forbidden"
    }
  ]
}

Fetch coupon's details by id
GET/coupons/{couponId}

Fetches coupon’s details.

URI Parameters
HideShow
couponId
number (required) Example: 1

Generated by aglio on 10 Jan 2025