Validate a coupon code

Public. Resolves a coupon code the register calls at checkout. It reports is_valid with reason_invalid: unknown codes 404, else 200 and is_valid false.

GET/api/v1/coupons/validate/{code}

Path parameters

codestringrequired

The coupon code, matched case insensitively.

Responses

200

The coupon and whether it may be applied

idstringrequired

codestringrequired

typestringrequired

discount_typestringrequired

discount_valuenumberrequired

descriptionstringrequired

is_validbooleanrequired

reason_invalidstring | nullrequired

404

Coupon not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Parameters

codepath*The coupon code, matched case insensitively.

Request

curl -X GET 'http://localhost:8000/api/v1/coupons/validate/string'

const response = await fetch("http://localhost:8000/api/v1/coupons/validate/string", {
  method: "GET"
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/coupons/validate/string",
)

Response

{
  "id": "string",
  "code": "string",
  "type": "string",
  "discount_type": "string",
  "discount_value": 0,
  "description": "string",
  "is_valid": true,
  "reason_invalid": "string"
}

{
  "detail": "string"
}