Skip to main content
POST
Finalize Scx Sign Up

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://id.jtl-cloud.com/oauth/v2/authorize
Token URL
https://id.jtl-cloud.com/oauth/v2/token
Scopes1
saleschannels.write
Grants permission to create and modify sales channels.

Headers

Idempotency-Key
string

Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

signUpId
string
required

Id of the sign-up to finalize.

Response

Reports the current outcome of a sign-up. While the sign-up is still pending, IsCompleted is false and Sellers is empty. Once completed, IsCompleted is true and Sellers holds the newly connected seller(s) - more than one if the channel connects several marketplaces at once.

Checks whether a sign-up has completed and, if so, returns the newly connected seller(s). Call this repeatedly until the sign-up completes or expires. - Response

isCompleted
boolean
required

Whether the sign-up has completed and produced at least one new seller.

sellers
object[]
required

Newly connected seller(s) resulting from this sign-up. Empty while IsCompleted is false.