API reference overview

Every Build tool is one POST with a JSON body, the same fields on every platform, and an X-API-Key header.

On this page

How a call works
Tools
Common to every tool

How a call works

Each tool is one POST to {tool name} under the base URL, with one key in the X-API-Key header and a JSON body.

POST https://build-api.sellermate.ai/v1/tools/{name}
X-API-Key: $BUILD_API_KEY
Content-Type: application/json

Rows come back in the same fields on every platform. Every answer carries data_as_of. There is one live version, with /v1 in the path, and breaking changes are announced in the changelog.

Tools

get_campaign_performance

Reads. Amazon and Google Ads. Spend, clicks, orders, sales and ACoS for each campaign over a date range, in the same fields on Amazon and Google Ads.

get_search_term_performance

Reads. Amazon and Google Ads. Search terms with their clicks, spend and orders over a date range, on Amazon and Google Ads.

get_orders_report

Reads. Amazon. Orders and units for an Amazon Seller account over a date range.

get_inventory

Reads. Amazon. Stock and inbound units for an Amazon account.

update_target

Writes on Amazon only. Amazon. Change a target on an Amazon Ads account, behind caps, a dry run and undo.

Common to every tool

Authentication: the X-API-Key header, a key scoped per account. See Keys and scopes.
Limits: requests per minute by plan. See Plans and limits.
Writes: Amazon only. See Writes and guardrails.

Placeholder Fails a strict build (DOCS_STRICT=1).

To write: the full tool list: this page lists the five tools in the API reference so far. Add the rest, and link the OpenAPI file and Postman collection once they exist

← PreviousWebhooks Next →get_campaign_performance

Last updated 30 Oct 2026