Merchant

Create Merchant

Creates a new merchant under the authenticated account. Requires X-API-KEY header.

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
merchantNamestringRequired1-255 characters
Merchant business name
contactFirststringRequired
Primary contact first name
contactLaststringRequired
Primary contact last name
contactEmailstringRequired
Primary contact email
sendTaxcloudInvitebooleanOptional
Sends invite to set up and connect a TaxCloud account to a merchant who does not already use TaxCloud. To connect a TaxCloud account for a merchant who already uses TaxCloud, use the "Set Merchant Credentials" function.
referenceIdstringOptional<=255 characters
The ID you use in your own system to identify this merchant.

Response

Created
merchantIdstring
UUID of the created merchant
messagestring

Human-readable result message

statusstring
Operation status

Errors

400
Create Merchant Body Bad Request Error
401
Create Merchant Body Unauthorized Error
409
Create Merchant Body Conflict Error
422
Create Merchant Body Unprocessable Entity Error
500
Create Merchant Body Internal Server Error