v1
latestOpenAPI 3.1.02026-08-0441813.4 KBMerchants
Batch merchant search
Search for merchants by name (fuzzy) or domain (exact match). Up to 20 queries per request. Each query carries its own query_id that is echoed back so callers can correlate responses. Each result contains an items array with matched merchants. Name queries return up to limit items per result (default 5, max 20). Misses return a single item with id: null — there are no 404s.
post/v1/merchants/search
Request body
Example request
{
"queries": [
{
"query_id": "q1",
"type": "name",
"value": "Acme",
"region": "US",
"limit": 5
}
]
}Response
Per-query results. Each result has an items array. A name query with limit > 1 may produce multiple items. Misses have id: null.
Example response
{
"results": [
{
"query_id": "q1",
"items": [
{
"id": "01hz4vdrcnxhfmfcvy3rfqk1fp",
"name": "Acme Corp",
"domains": [
"acme.com",
"acme.co.uk"
],
"estimated_shipping": {
"unit": "days",
"median": 6,
"q1": 3,
"q3": 10
}
}
]
}
]
}