Merchant

Get Merchant

Available on Enterprise Plan

Returns a single merchant by UUID. The caller must own the merchant. Cross-account reads are blocked. Soft-deleted merchants (deleted_at <= now) are treated as non-existent and return 404.

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
merchantIdstringRequired
UUID of the merchant to retrieve. The merchant must be owned by the calling account.

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

400
Get Merchant Body Bad Request Error
401
Get Merchant Body Unauthorized Error
404
Get Merchant Body Not Found Error
422
Get Merchant Body Unprocessable Entity Error
500
Get Merchant Body Internal Server Error