Merchant

Create Merchant

Available on Enterprise Plan

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

Legal or trading name of the merchant business. Required; must be 1–255 characters.

contactFirststringOptional
First name of the merchant's primary contact. Optional.
contactLaststringOptional
Last name of the merchant's primary contact. Optional.
contactEmailstringOptional

Email address of the merchant’s primary contact; used for TaxCloud invitations and notifications. Optional.

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 assigned to the newly created merchant; use it in subsequent merchant operations.

messagestring

Human-readable description of the result.

statusstring

Result status of the operation (e.g. ‘success’).

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