1.8 KiB
1.8 KiB
name, description
| name | description |
|---|---|
| promotion-codes-routes | Handle 4 OpenAPI operation(s) under /v1/promotion_codes for the promotion codes route group. |
promotion codes API Routes
Handle 4 OpenAPI operation(s) under /v1/promotion_codes for the promotion 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_promotion_codes
- Operation ID:
get_promotion_codes - Route:
GET /v1/promotion_codes - Mode: READ
- Summary: List all promotion codes
- Parameters:
activeinquerycodeinquerycouponinquerycreatedinquerycustomerinquerycustomer_accountinqueryending_beforeinqueryexpandinquerylimitinquerystarting_afterinquery
- Body: JSON request body accepted.
post_promotion_codes
- Operation ID:
post_promotion_codes - Route:
POST /v1/promotion_codes - Mode: WRITE
- Summary: Create a promotion code
- Body: JSON request body accepted.
get_promotion_codes_promotion_code
- Operation ID:
get_promotion_codes_promotion_code - Route:
GET /v1/promotion_codes/{promotion_code} - Mode: READ
- Summary: Retrieve a promotion code
- Parameters:
expandinquerypromotion_codeinpathrequired
- Body: JSON request body accepted.
post_promotion_codes_promotion_code
- Operation ID:
post_promotion_codes_promotion_code - Route:
POST /v1/promotion_codes/{promotion_code} - Mode: WRITE
- Summary: Update a promotion code
- Parameters:
promotion_codeinpathrequired
- Body: JSON request body accepted.