Skip to main content

Usage and capabilities

Use capabilities for runtime discovery and usage reporting for operational visibility.

Discover capabilities

GET /v2/capabilities returns resources, paths, available actions, and the read/write scopes attached to those resources.
cURL
Response
string
Resource name, such as products, categories, vendors, or locations.
string
Base path for the resource.
string[]
Actions exposed for that resource in the current v2 API.
object
Read and write scopes used by the resource.

Read usage totals

GET /v2/usage returns API usage totals for the tenant. Pass endpoint when you want to filter by a specific operation label.
string
Optional endpoint label, for example GET /v2/products.

Operational checks

Call /v2/capabilities after creating a developer application. If a resource is missing or an action is unavailable, update the application scopes before continuing.
Use /v2/usage from an operations job to compare expected sync volume with observed API usage.
List locations or capabilities before running write workflows. These calls validate auth and tenant binding without changing records.

Get capabilities

Discover resources, actions, and scopes.

Read usage

Read tenant API usage totals.