Finalize Scx Sign Up

curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "isCompleted": true,
  "sellers": [
    {
      "salesChannelId": "<string>",
      "isActive": true,
      "sellerId": "<string>",
      "channel": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "channelDisplayName": "<string>",
      "channelCurrency": "<string>",
      "isDocumentStorageEnabled": true,
      "isStockUpdateEnabled": true,
      "isOfferAutomappingEnabled": true,
      "offerAutomappingType": 0,
      "isAttributeImportEnabled": true,
      "orderConfirmationType": 0,
      "pendingOfferDeletionIntervalDays": 123,
      "completedOfferDeletionIntervalDays": 123,
      "isDeleted": true,
      "isVariationsSupported": true,
      "isQuantityPriceSupported": true,
      "invoiceDocumentTransfer": 0,
      "isAllowCombineOrders": true,
      "name": "<string>",
      "isBlocked": 123,
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "returnWarehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "languageId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "updatedAt": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ]
}

POST

sales-channels

scx

signups

{signUpId}

finalize

Finalize Scx Sign Up

curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-channels/scx/signups/{signUpId}/finalize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "isCompleted": true,
  "sellers": [
    {
      "salesChannelId": "<string>",
      "isActive": true,
      "sellerId": "<string>",
      "channel": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "channelDisplayName": "<string>",
      "channelCurrency": "<string>",
      "isDocumentStorageEnabled": true,
      "isStockUpdateEnabled": true,
      "isOfferAutomappingEnabled": true,
      "offerAutomappingType": 0,
      "isAttributeImportEnabled": true,
      "orderConfirmationType": 0,
      "pendingOfferDeletionIntervalDays": 123,
      "completedOfferDeletionIntervalDays": 123,
      "isDeleted": true,
      "isVariationsSupported": true,
      "isQuantityPriceSupported": true,
      "invoiceDocumentTransfer": 0,
      "isAllowCombineOrders": true,
      "name": "<string>",
      "isBlocked": 123,
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "returnWarehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "languageId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "updatedAt": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

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

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.

Show child attributes

⌘I

Overview

GraphQL

REST API

Finalize Scx Sign Up

Authorizations

Headers

Path Parameters

Response