List Nexus Locations

Available on Pro and Enterprise Plans

Returns a merchant’s recorded nexus locations. Deleted locations are not included.

Available to self-managed merchants only; a TaxCloud-connected merchant returns 403, and their nexus is read through the Management API instead.

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
merchantIdstringRequired

UUID of the merchant whose locations to list. Must be owned by the calling account and must be self-managed.

nexusTypeenumOptional

Restricts the response to one kind of nexus. Omit it to return every kind. Only ‘physical’ is supported; ‘economic’ is rejected with 400, because those rows carry a registration id instead of an address and do not fit this response shape (ZIP-1214).

Allowed values:

Response

OK
merchantIdstring
UUID of the merchant the locations belong to.
locationslist of objectsOptional
The merchant's recorded locations. An empty array when the merchant has none, which means no physical nexus is being tracked for them.

Errors

400
Merchant Nexus List Body Bad Request Error
401
Merchant Nexus List Body Unauthorized Error
403
Merchant Nexus List Body Forbidden Error
404
Merchant Nexus List Body Not Found Error
422
Merchant Nexus List Body Unprocessable Entity Error
429
Merchant Nexus List Body Too Many Requests Error
500
Merchant Nexus List Body Internal Server Error
503
Merchant Nexus List Body Service Unavailable Error