2.5 KiB
2.5 KiB
name, description
| name | description |
|---|---|
| coupon-codes-routes | Handle 7 OpenAPI operation(s) under /api/coupon-codes for the coupon codes route group. |
coupon codes API Routes
Handle 7 OpenAPI operation(s) under /api/coupon-codes for the coupon codes 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_coupon_codes
- Operation ID:
get_coupon_codes - Route:
GET /api/coupon-codes - Mode: READ
- Summary: Get Coupon Codes
- Parameters:
fields[coupon-code]inqueryfields[coupon]inqueryfilterinqueryrequiredincludeinquerypage[cursor]inquerypage[size]inqueryrevisioninheaderrequired
create_coupon_code
- Operation ID:
create_coupon_code - Route:
POST /api/coupon-codes - Mode: WRITE
- Summary: Create Coupon Code
- Parameters:
fields[coupon-code]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
get_coupon_code
- Operation ID:
get_coupon_code - Route:
GET /api/coupon-codes/{id} - Mode: READ
- Summary: Get Coupon Code
- Parameters:
idinpathrequiredfields[coupon-code]inqueryfields[coupon]inqueryincludeinqueryrevisioninheaderrequired
update_coupon_code
- Operation ID:
update_coupon_code - Route:
PATCH /api/coupon-codes/{id} - Mode: WRITE
- Summary: Update Coupon Code
- Parameters:
idinpathrequiredfields[coupon-code]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
delete_coupon_code
- Operation ID:
delete_coupon_code - Route:
DELETE /api/coupon-codes/{id} - Mode: WRITE
- Summary: Delete Coupon Code
- Parameters:
idinpathrequiredrevisioninheaderrequired
get_coupon_for_coupon_code
- Operation ID:
get_coupon_for_coupon_code - Route:
GET /api/coupon-codes/{id}/coupon - Mode: READ
- Summary: Get Coupon For Coupon Code
- Parameters:
idinpathrequiredfields[coupon]inqueryrevisioninheaderrequired
get_coupon_id_for_coupon_code
- Operation ID:
get_coupon_id_for_coupon_code - Route:
GET /api/coupon-codes/{id}/relationships/coupon - Mode: READ
- Summary: Get Coupon ID for Coupon Code
- Parameters:
idinpathrequiredrevisioninheaderrequired