Endpoints Reference
Platform Connection
New Platform Connection
POST
/v1/{siteEnv}/{siteId}
PATH PARAMETERS
siteEnv
string
*Example: live
siteId
string
*Example: bobs-store
BODY PARAMETERS
body
object
store_id
string
*Example: 1234
The ID of the store on the 3rd party platform
spark_api_client_id
string
*Example: ca7cf4ac-51cb-4836-9a79-d425afc6e280
spark_api_client_secret
string
*Example: puwUwJZRfsnpB7nENulMW67prs94QYbu2DXHL3Sh
RESPONSES
201
Successful operation - App install pending
object
redirect_url
string
*Example: https://store-1234.example.io/install
Platform store app install URL to redirect the merchant to in order to complete the connection
204
Successful operation - App already installed - Platform connection is now active
401
Auth Failure
500
System Exception