Initiate marketplace connection

POST

/api/merchants/platforms/{platformId}/connect

Starts the OAuth authorization flow to connect the merchant to the specified marketplace.

OAuth Flow:

Call this endpoint to initiate connection

Receive an authorizationUrl in the response

Redirect the user to the authorization URL

User grants consent on the marketplace's OAuth page

User is redirected back to your callbackUrl with authorization code

Call the callback endpoint to complete the connection

Data Consent:
By connecting, the merchant consents to share their sales data with OpenSylo for credit scoring purposes.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Connection initiated successfully. Redirect user to authorizationUrl.

Body

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

cURL

Basic connectionWith custom callback URLWith metadata

curl --location --request POST 'https://api.dev.opensylo.com/api/merchants/platforms//connect' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Response Example

{
    "success": true,
    "platformId": "chowdeck",
    "authorizationUrl": "https://api.opensylo.com/oauth/authorize?client_id=xxx&redirect_uri=xxx&scope=sales.read",
    "connectionId": "conn_xyz789",
    "message": "Redirecting to Chowdeck for authorization",
    "expiresIn": 300
}

Modified at 2025-12-30 08:04:15

Get marketplace details

Disconnect from marketplace