Merchant

List Merchants

Available on Enterprise Plan

Returns every active merchant owned by the calling account. A merchant is considered active when its deleted_at is NULL or set to a future date. Soft-deleted merchants (deleted_at <= now) are excluded from results.

Authentication

X-API-KEYstring
API Key authentication via header

Response

OK
merchantIdstring
UUID of the merchant.
merchantNamestring
Legal or trading name of the merchant business.
statusenum

Derived TaxCloud lifecycle status: ‘taxcloud_invited’ (invite sent, not yet accepted), ‘taxcloud_connected’ (TaxCloud credentials set and active), ‘taxcloud_disconnected’ (previously connected, now disconnected), or ‘external_compliance’ (managed outside TaxCloud).

contactEmailstring
Email address of the merchant's primary contact.
contactFirststring
First name of the merchant's primary contact.
contactLaststring
Last name of the merchant's primary contact.
referenceIdstring
The ID you use in your own system to identify this merchant.

Errors

401
List Merchants Request Unauthorized Error
500
List Merchants Request Internal Server Error