For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
SupportLog InSign Up
GuidesAPI Reference
GuidesAPI Reference
  • Tax Rates
    • GETGet Tax Rates (v6.0)
  • Merchant
    • POSTCreate Merchant
    • POSTUpdate Merchant
    • POSTDelete Merchant
    • POSTGet Merchant
    • GETList Merchants
    • POSTSet Merchant Credentials
    • POSTGet Merchant Credentials
    • POSTDelete Merchant Credentials
  • Data
    • GETGet TIC Codes
  • System
    • GETHealth Check
    • GETGet System Metadata
  • Ziptax API
SupportLog InSign Up
Merchant

Get Merchant

POST
https://api.ziptax.com/merchant/get
POST
/merchant/get
$curl -X POST https://api.ziptax.com/merchant/get \
>     -H "X-API-KEY: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "merchantId": "merchantId"
>}'
1{
2  "contact_email": "contact_email",
3  "contact_first": "contact_first",
4  "contact_last": "contact_last",
5  "merchantId": "merchantId",
6  "merchant_name": "merchant_name",
7  "reference_id": "reference_id",
8  "status": "taxcloud_invited"
9}

Returns a single merchant by UUID. The caller must own the merchant. Cross-account reads are blocked.

Was this page helpful?
Previous

List Merchants

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
merchantIdstringRequired
UUID of the merchant to retrieve

Response

OK
contact_emailstring
Primary contact email
contact_firststring
Primary contact first name
contact_laststring
Primary contact last name
merchantIdstring
UUID of the merchant
merchant_namestring
Merchant business name
reference_idstring
The ID you use in your own system to identify this merchant.
statusenum
Derived lifecycle status
Allowed values:

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