83 lines
1.9 KiB
Markdown
83 lines
1.9 KiB
Markdown
---
|
|
name: buckslips-routes
|
|
description: Handle 7 OpenAPI operation(s) under /buckslips for the buckslips route group.
|
|
---
|
|
|
|
# buckslips API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /buckslips for the buckslips 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
|
|
|
|
### buckslips_list
|
|
|
|
- Operation ID: `buckslips_list`
|
|
- Route: `GET /buckslips`
|
|
- Mode: READ
|
|
- Summary: List
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `before/after` in `query`
|
|
- `include` in `query`
|
|
|
|
### buckslip_create
|
|
|
|
- Operation ID: `buckslip_create`
|
|
- Route: `POST /buckslips`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Body: JSON request body accepted.
|
|
|
|
### buckslip_retrieve
|
|
|
|
- Operation ID: `buckslip_retrieve`
|
|
- Route: `GET /buckslips/{buckslip_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `buckslip_id` in `path` required
|
|
|
|
### buckslip_update
|
|
|
|
- Operation ID: `buckslip_update`
|
|
- Route: `PATCH /buckslips/{buckslip_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update
|
|
- Parameters:
|
|
- `buckslip_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### buckslip_delete
|
|
|
|
- Operation ID: `buckslip_delete`
|
|
- Route: `DELETE /buckslips/{buckslip_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete
|
|
- Parameters:
|
|
- `buckslip_id` in `path` required
|
|
|
|
### buckslip_orders_retrieve
|
|
|
|
- Operation ID: `buckslip_orders_retrieve`
|
|
- Route: `GET /buckslips/{buckslip_id}/orders`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `buckslip_id` in `path` required
|
|
- `limit` in `query`
|
|
- `offset` in `query`
|
|
|
|
### buckslip_order_create
|
|
|
|
- Operation ID: `buckslip_order_create`
|
|
- Route: `POST /buckslips/{buckslip_id}/orders`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Parameters:
|
|
- `buckslip_id` in `path` required
|
|
- Body: JSON request body accepted.
|