Skip to main content
GET
Get Shop Account By Id

Authorizations

Authorization
string
header
required

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

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

salesChannelId
string
required

Sales channel id of the JTL-Wawi-managed online shop to retrieve. Opaque, tenant-local composite identifier (not a UUID); use the value returned by a sales channel listing.

Response

Success.

An online shop whose synchronization is handled directly by JTL-Wawi. Secrets (API key, password) and the sync user's login name are never returned.

salesChannelId
string
required

Sales channel id of this shop. Opaque, tenant-local composite identifier (not a UUID); use this value to address the shop in follow-up calls.

isActive
boolean
required

Shop is active.

isLocked
boolean
required

Shop is locked.

orderAsOffer
boolean
required

Orders imported from this shop are created as offers rather than as sales orders.

useShopOrderNumber
boolean
required

The shop's own order number is used instead of a JTL-Wawi-generated one.

name
string

Name of the shop.

url
string

URL of the shop.

companyId
string<uuid>

ID of the company the shop belongs to.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

rootCategoryId
string<uuid>

ID of the shop's root category.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"