Skip to main content
GET
Get

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

The unique identifier of the merchant integration

Pattern: ^mint_[a-zA-Z0-9]+$

Response

Merchant integration

A merchant's tenant-level connection to an external provider via Ampersand.

id
string
required

Unique identifier for a merchant integration

Pattern: ^mint_[a-zA-Z0-9]+$
object
enum<string>
default:merchantIntegration
required
Available options:
merchantIntegration
merchantId
string
required

Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
provider
enum<string>
required

External provider a merchant can connect at the tenant level. netsuite and accountsiq are returned on reads wherever a connection exists, but connecting them is accepted only in local and development environments; elsewhere the connect request is refused with 404.

Available options:
salesforce,
netsuite,
accountsiq
capabilities
object
required

What this provider does with an item's external codes.

Two independent capabilities, not one direction: the behaviours are not alternatives. An integration can resolve an incoming item code and be sent a selected one on a different path, so a single inbound/outbound value would have to misdescribe it or forbid one of its operations.

A capability that is not declared is unavailable rather than inferred. Declaring one does not make a provider connectable — that still requires its credentials and connection lifecycle.

externalId
string | null
required

Ampersand installation id.

status
enum<string>
required

Connection lifecycle state. Live Ampersand health is separate and not stored here.

Available options:
active,
disconnected,
error
config
object
required
metadata
object
required
connectedAt
string<date-time>
required
disconnectedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required