Skip to main content
PATCH
Save Shop Credentials

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

salesChannelId
string
required

Sales channel id of the shop whose credentials are updated. This is a tenant-local, composite identifier and not a UUID (ADR-69) - it is opaque to the caller and must be taken verbatim from a sales channel listing; the internal shop key (kShop) is never accepted here.

Body

application/json

Request model for SaveShopCredentials command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

apiKey
string

API key to store for this shop. Omit to leave unchanged; set to null to clear it - clearing it hides this shop's licensed modules until the key is set again, but does not delete the license rows themselves. At most 64 characters (stored plain, dbo.tShop.cAPIKey nvarchar(64)); a blank (empty/whitespace-only) value is rejected, since that would be meaningless input rather than a deliberate clear.

password
string

Password to store for this shop. Omit to leave unchanged; set to null to clear it. At most 111 bytes in UTF-8 - the stored form is larger than the value itself (obfuscated in dbo.tShop.cPasswortWeb), so the limit is counted in bytes and a multi-byte character consumes more than one of them.

Response

The shop credentials were updated.