# Coupon Redemptions

Operations related to coupon redemptions.

## Get Coupon Redemptions

> Retrieves a list of all redemptions for a specific coupon.

```json
{"openapi":"3.0.0","info":{"title":"Vauchar API","version":"1.0.0"},"tags":[{"name":"Coupon Redemptions","description":"Operations related to coupon redemptions."}],"servers":[{"url":"https://api.vauchar.com","description":"Production Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication. The username is your Merchant ID and the password is your API Key. The combined string `Merchant_Id:Api_Key` should be Base64 encoded."}},"schemas":{"Redemption":{"type":"object","properties":{"href":{"type":"string","description":"The direct URL to this specific redemption resource."},"type":{"type":"string","description":"The type of the object, in this case, \"redemption\"."},"id":{"type":"string","description":"The unique identifier for the redemption."},"coupon_id":{"type":"string","description":"The ID of the coupon that was redeemed."},"user_id":{"type":"string","description":"The ID of the user who redeemed the coupon."},"customer_id":{"type":"string","description":"The ID of the customer associated with the redemption."},"user_email":{"type":"string","description":"The email of the user who redeemed the coupon."},"user_phone":{"type":"string","description":"The phone number of the user who redeemed the coupon."},"transaction_id":{"type":"string","description":"The ID of the transaction associated with this redemption."},"value_used":{"type":"string","description":"The value of the discount applied in this redemption."},"team_id":{"type":"string","description":"The ID of the team associated with this redemption, if any."},"created":{"type":"integer","format":"int64","description":"The timestamp when the redemption occurred (Unix timestamp)."}}}}},"paths":{"/coupons/{couponId}/redemptions":{"get":{"summary":"Get Coupon Redemptions","description":"Retrieves a list of all redemptions for a specific coupon.","operationId":"getCouponRedemptions","tags":["Coupon Redemptions"],"parameters":[{"name":"couponId","in":"path","description":"The ID of the coupon for which to retrieve redemptions.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A successful response returns a list of redemption objects.","content":{"application/json":{"schema":{"type":"object","properties":{"href":{"type":"string"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Redemption"}}}}}}},"401":{"description":"Unauthorized. The API Key or Merchant ID is missing or invalid."},"404":{"description":"Not Found. The coupon with the specified ID does not exist."},"500":{"description":"Internal Server Error."}}}}}}
```

## Create Coupon Redemption

> Redeems a coupon for a specific user. While only user\_id is mandatory, providing more details is recommended for better tracking.

```json
{"openapi":"3.0.0","info":{"title":"Vauchar API","version":"1.0.0"},"tags":[{"name":"Coupon Redemptions","description":"Operations related to coupon redemptions."}],"servers":[{"url":"https://api.vauchar.com","description":"Production Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication. The username is your Merchant ID and the password is your API Key. The combined string `Merchant_Id:Api_Key` should be Base64 encoded."}},"schemas":{"RedemptionRequest":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The unique identifier for the user redeeming the coupon."},"user_email":{"type":"string","description":"The email address of the user."},"user_phone":{"type":"string","description":"The phone number of the user."},"transaction_id":{"type":"string","description":"The identifier for the transaction this redemption is part of."},"value_used":{"type":"number","description":"The value used in this specific transaction."}}},"Redemption":{"type":"object","properties":{"href":{"type":"string","description":"The direct URL to this specific redemption resource."},"type":{"type":"string","description":"The type of the object, in this case, \"redemption\"."},"id":{"type":"string","description":"The unique identifier for the redemption."},"coupon_id":{"type":"string","description":"The ID of the coupon that was redeemed."},"user_id":{"type":"string","description":"The ID of the user who redeemed the coupon."},"customer_id":{"type":"string","description":"The ID of the customer associated with the redemption."},"user_email":{"type":"string","description":"The email of the user who redeemed the coupon."},"user_phone":{"type":"string","description":"The phone number of the user who redeemed the coupon."},"transaction_id":{"type":"string","description":"The ID of the transaction associated with this redemption."},"value_used":{"type":"string","description":"The value of the discount applied in this redemption."},"team_id":{"type":"string","description":"The ID of the team associated with this redemption, if any."},"created":{"type":"integer","format":"int64","description":"The timestamp when the redemption occurred (Unix timestamp)."}}}}},"paths":{"/coupons/{couponId}/redemptions":{"post":{"summary":"Create Coupon Redemption","description":"Redeems a coupon for a specific user. While only user_id is mandatory, providing more details is recommended for better tracking.","operationId":"createCouponRedemption","tags":["Coupon Redemptions"],"parameters":[{"name":"couponId","in":"path","description":"The ID of the coupon to redeem.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Redemption details","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedemptionRequest"}}}},"responses":{"200":{"description":"Successful redemption. Returns the created redemption object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redemption"}}}},"400":{"description":"Bad Request. The redemption is invalid (e.g., coupon expired, redemption limit reached)."},"401":{"description":"Unauthorized. The API Key or Merchant ID is missing or invalid."},"404":{"description":"Not Found. The coupon with the specified ID does not exist."},"500":{"description":"Internal Server Error."}}}}}}
```

## Get Specific Redemption

> Retrieves the details of a specific redemption by providing the coupon ID and redemption ID.

```json
{"openapi":"3.0.0","info":{"title":"Vauchar API","version":"1.0.0"},"tags":[{"name":"Coupon Redemptions","description":"Operations related to coupon redemptions."}],"servers":[{"url":"https://api.vauchar.com","description":"Production Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication. The username is your Merchant ID and the password is your API Key. The combined string `Merchant_Id:Api_Key` should be Base64 encoded."}},"schemas":{"Redemption":{"type":"object","properties":{"href":{"type":"string","description":"The direct URL to this specific redemption resource."},"type":{"type":"string","description":"The type of the object, in this case, \"redemption\"."},"id":{"type":"string","description":"The unique identifier for the redemption."},"coupon_id":{"type":"string","description":"The ID of the coupon that was redeemed."},"user_id":{"type":"string","description":"The ID of the user who redeemed the coupon."},"customer_id":{"type":"string","description":"The ID of the customer associated with the redemption."},"user_email":{"type":"string","description":"The email of the user who redeemed the coupon."},"user_phone":{"type":"string","description":"The phone number of the user who redeemed the coupon."},"transaction_id":{"type":"string","description":"The ID of the transaction associated with this redemption."},"value_used":{"type":"string","description":"The value of the discount applied in this redemption."},"team_id":{"type":"string","description":"The ID of the team associated with this redemption, if any."},"created":{"type":"integer","format":"int64","description":"The timestamp when the redemption occurred (Unix timestamp)."}}}}},"paths":{"/coupons/{couponId}/redemptions/{redemptionId}":{"get":{"summary":"Get Specific Redemption","description":"Retrieves the details of a specific redemption by providing the coupon ID and redemption ID.","operationId":"getSpecificRedemption","tags":["Coupon Redemptions"],"parameters":[{"name":"couponId","in":"path","description":"The ID of the coupon.","required":true,"schema":{"type":"string"}},{"name":"redemptionId","in":"path","description":"The ID of the redemption to retrieve.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A successful response returns the specified redemption object.","content":{"application/json":{"schema":{"type":"object","properties":{"href":{"type":"string"},"data":{"$ref":"#/components/schemas/Redemption"}}}}}},"401":{"description":"Unauthorized. The API Key or Merchant ID is missing or invalid."},"404":{"description":"Not Found. The redemption with the specified ID could not be found."},"500":{"description":"Internal Server Error."}}}}}}
```

## Delete Specific Redemption

> Deletes a specific coupon redemption. This can be useful for correcting mistaken redemptions.

```json
{"openapi":"3.0.0","info":{"title":"Vauchar API","version":"1.0.0"},"tags":[{"name":"Coupon Redemptions","description":"Operations related to coupon redemptions."}],"servers":[{"url":"https://api.vauchar.com","description":"Production Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication. The username is your Merchant ID and the password is your API Key. The combined string `Merchant_Id:Api_Key` should be Base64 encoded."}}},"paths":{"/coupons/{couponId}/redemptions/{redemptionId}":{"delete":{"summary":"Delete Specific Redemption","description":"Deletes a specific coupon redemption. This can be useful for correcting mistaken redemptions.","operationId":"deleteSpecificRedemption","tags":["Coupon Redemptions"],"parameters":[{"name":"couponId","in":"path","description":"The ID of the coupon.","required":true,"schema":{"type":"string"}},{"name":"redemptionId","in":"path","description":"The ID of the redemption to delete.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content. The redemption was successfully deleted."},"401":{"description":"Unauthorized. The API Key or Merchant ID is missing or invalid."},"404":{"description":"Not Found. The redemption with the specified ID could not be found."},"500":{"description":"Internal Server Error."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://vauchar.gitbook.io/vauchar/api-references/coupons/coupon-redemptions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.