63 lines
1.8 KiB
Markdown
63 lines
1.8 KiB
Markdown
---
|
|
name: promotion-codes-routes
|
|
description: 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:
|
|
- `active` in `query`
|
|
- `code` in `query`
|
|
- `coupon` in `query`
|
|
- `created` in `query`
|
|
- `customer` in `query`
|
|
- `customer_account` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- 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:
|
|
- `expand` in `query`
|
|
- `promotion_code` in `path` required
|
|
- 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_code` in `path` required
|
|
- Body: JSON request body accepted.
|