Skip to main content
POST
Disconnect a POS connection

Authorizations

X-API-Key
string
header
required

Path Parameters

connection_id
string<shortuuid>
required

ID of the POS connection. Returned as the id field on every POS connection response.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A POS or e-commerce connection. Credentials are never part of the response.

id
string<shortuuid>
required

ID of the POS connection. Returned as the id field on every POS connection response.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
provider
enum<string>
required

The POS or e-commerce platform.

Available options:
shopify,
square,
clover,
lightspeed
external_id
string
required

The platform's own identifier for the connected store, such as a Shopify shop domain.

is_active
boolean
required

true while the connection syncs. false once it has been disconnected.

last_synced
string<date-time> | null

When inventory was last fully synced, or null if it never has been.