68 lines
1.6 KiB
Markdown
68 lines
1.6 KiB
Markdown
---
|
|
name: coupons-routes
|
|
description: Handle 5 OpenAPI operation(s) under /v1/coupons for the coupons route group.
|
|
---
|
|
|
|
# coupons API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /v1/coupons for the coupons route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_coupons
|
|
|
|
- Operation ID: `get_coupons`
|
|
- Route: `GET /v1/coupons`
|
|
- Mode: READ
|
|
- Summary: List all coupons
|
|
- Parameters:
|
|
- `created` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_coupons
|
|
|
|
- Operation ID: `post_coupons`
|
|
- Route: `POST /v1/coupons`
|
|
- Mode: WRITE
|
|
- Summary: Create a coupon
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_coupons_coupon
|
|
|
|
- Operation ID: `delete_coupons_coupon`
|
|
- Route: `DELETE /v1/coupons/{coupon}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a coupon
|
|
- Parameters:
|
|
- `coupon` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_coupons_coupon
|
|
|
|
- Operation ID: `get_coupons_coupon`
|
|
- Route: `GET /v1/coupons/{coupon}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a coupon
|
|
- Parameters:
|
|
- `coupon` in `path` required
|
|
- `expand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_coupons_coupon
|
|
|
|
- Operation ID: `post_coupons_coupon`
|
|
- Route: `POST /v1/coupons/{coupon}`
|
|
- Mode: WRITE
|
|
- Summary: Update a coupon
|
|
- Parameters:
|
|
- `coupon` in `path` required
|
|
- Body: JSON request body accepted.
|