Merchant

List Merchants

Available on Pro and Enterprise Plans

Returns every active merchant on your account. Deleted merchants are not included.

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).

contactEmailstringOptional
Email address of the merchant's primary contact.
contactFirststringOptional
First name of the merchant's primary contact.
contactLaststringOptional
Last name of the merchant's primary contact.
referenceIdstringOptional
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