get_endpoint_detail
Retrieve detailed documentation for any BigCommerce API endpoint, including schema, parameters, example response, OAuth scope, and usage notes.
Instructions
Get comprehensive detail for a specific BigCommerce API endpoint — request body schema, path parameters, query params, example response, OAuth scope, and usage notes.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"path_contains": "<path_contains>"
},
"name": "get_endpoint_detail"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method | No | HTTP method: GET, POST, PUT, DELETE | |
| category | No | API category (e.g. catalog, orders, customers, cart) | |
| path_contains | Yes | Part of the endpoint path to search for, e.g. '/products', '/orders/{order_id}/shipments', 'variants' |