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)
  • Account
    • GETGet Account Metrics (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
    • POSTSearch TIC Codes
    • POSTRecommend TIC Codes
    • GETGet TIC Search JSON Schema
  • System
    • GETHealth Check
    • GETGet System Metadata
SupportLog InSign Up
Merchant

Get Merchant

Beta
POST
https://api.zip-tax.com/merchant/get
POST
/merchant/get
$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  "name": "name",
4  "id": "id",
5  "contact_first": "contact_first",
6  "contact_last": "contact_last",
7  "contact_email": "contact_email",
8  "is_txc": true,
9  "txc_connected": true
10}
> **Private Preview** — Access by request only. The API surface may change before general availability. Contact support@zip.tax for access. Returns the full record for a single merchant owned by the authenticated account. Cross-account reads are blocked: a merchant owned by a different account surfaces as 404 (the response body deliberately does not reveal that the merchant exists elsewhere).
Was this page helpful?
Previous

List Merchants

Next
Built with

Private Preview — Access by request only. The API surface may change before general availability. Contact support@zip.tax for access.

Returns the full record for a single merchant owned by the authenticated account. Cross-account reads are blocked: a merchant owned by a different account surfaces as 404 (the response body deliberately does not reveal that the merchant exists elsewhere).

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
merchantIdstringRequiredformat: "uuid"

Server-issued UUID of the merchant

Response

OK
merchantIdstringformat: "uuid"

Server-issued UUID of the merchant

namestring
Merchant display name
idstring
External identifier supplied by the integrator at create time
contact_firststring
Primary contact first name
contact_laststring
Primary contact last name
contact_emailstring
Primary contact email
is_txcboolean
Whether the merchant is configured to use TaxCloud
txc_connectedboolean
True if TaxCloud credentials are currently stored for the merchant

Errors

400
Get Merchant Request Bad Request Error
401
Get Merchant Request Unauthorized Error
404
Get Merchant Request Not Found Error
500
Get Merchant Request Internal Server Error