Get Merchant | Ziptax

Available on Pro and Enterprise Plans

Returns a single merchant by ID. You can only read merchants that belong to your account. Requests for any other merchant, or for one that has been deleted, 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

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

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

$	curl -X POST https://api.zip-tax.com/merchant/get \
>	-H "X-API-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"merchantId": "merchantId"
>	}'

1	{
2	"merchantId": "merchantId",
3	"merchantName": "merchantName",
4	"status": "taxcloud_invited",
5	"contactEmail": "contactEmail",
6	"contactFirst": "contactFirst",
7	"contactLast": "contactLast",
8	"referenceId": "referenceId"
9	}