2.4 KiB
2.4 KiB
name, description
| name | description |
|---|---|
| coupons-routes | Handle 7 OpenAPI operation(s) under /api/coupons for the coupons route group. |
coupons API Routes
Handle 7 OpenAPI operation(s) under /api/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 /api/coupons - Mode: READ
- Summary: Get Coupons
- Parameters:
fields[coupon]inquerypage[cursor]inquerypage[size]inqueryrevisioninheaderrequired
create_coupon
- Operation ID:
create_coupon - Route:
POST /api/coupons - Mode: WRITE
- Summary: Create Coupon
- Parameters:
fields[coupon]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
get_coupon
- Operation ID:
get_coupon - Route:
GET /api/coupons/{id} - Mode: READ
- Summary: Get Coupon
- Parameters:
idinpathrequiredfields[coupon]inqueryrevisioninheaderrequired
update_coupon
- Operation ID:
update_coupon - Route:
PATCH /api/coupons/{id} - Mode: WRITE
- Summary: Update Coupon
- Parameters:
idinpathrequiredfields[coupon]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
delete_coupon
- Operation ID:
delete_coupon - Route:
DELETE /api/coupons/{id} - Mode: WRITE
- Summary: Delete Coupon
- Parameters:
idinpathrequiredrevisioninheaderrequired
get_coupon_codes_for_coupon
- Operation ID:
get_coupon_codes_for_coupon - Route:
GET /api/coupons/{id}/coupon-codes - Mode: READ
- Summary: Get Coupon Codes for Coupon
- Parameters:
idinpathrequiredfields[coupon-code]inqueryfilterinquerypage[cursor]inquerypage[size]inqueryrevisioninheaderrequired
get_coupon_code_ids_for_coupon
- Operation ID:
get_coupon_code_ids_for_coupon - Route:
GET /api/coupons/{id}/relationships/coupon-codes - Mode: READ
- Summary: Get Coupon Code IDs for Coupon
- Parameters:
idinpathrequiredfilterinquerypage[cursor]inquerypage[size]inqueryrevisioninheaderrequired