Mutation
mutation CreateScxSignUp($request: CreateScxSignUpCommandRequestInput!) {
CreateScxSignUp(request: $request) {
signUpId
signUpUrl
expiresAt
}
}Variables
{
"request": {
"companyId": "id",
"channel": "string"
}
}Response
{
"data": {
"CreateScxSignUp": {
"signUpId": "string",
"signUpUrl": "string",
"expiresAt": "value"
}
}
}Mutations
CreateScxSignUp
Creates an onboarding sign-up for a new SCX seller on the given channel. Returns a sign-up id that must be passed to “POST /v2/sales-channels/scx/signups//finalize” or “FinalizeScxSignUp” once the seller has completed onboarding.
If a request with this mutation’s Idempotency-Key was already completed, the response’s extensions contains an idempotency.{responseName} entry with wasReplayed: true.
MUTATION
CreateScxSignUp(request: CreateScxSignUpCommandRequestInput!): CreateScxSignUpCommandResponse!Arguments
request
required
Returns
signUpId
String!
Server-generated id of the sign-up. Pass this to "POST /v2/sales-channels/scx/signups/{signUpId}/finalize" or "FinalizeScxSignUp" to complete it.
signUpUrl
String!
Onboarding URL the user shall open to complete the sign-up.
expiresAt
DateTime!
Point in time after which the sign-up and its SignUpUrl are no longer valid.
Mutation
mutation CreateScxSignUp($request: CreateScxSignUpCommandRequestInput!) {
CreateScxSignUp(request: $request) {
signUpId
signUpUrl
expiresAt
}
}Variables
{
"request": {
"companyId": "id",
"channel": "string"
}
}Response
{
"data": {
"CreateScxSignUp": {
"signUpId": "string",
"signUpUrl": "string",
"expiresAt": "value"
}
}
}Was this page helpful?