Skip to main content
PUT
Set Scx Seller Shipping Rule Mappings

Authorizations

Authorization
string
header
required

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

Scopes

saleschannels.write
oauth2-authorization-code

Grants permission to create and modify sales channels.

saleschannels.write
oauth2-client-credentials

Grants permission to create and modify sales channels.

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 SCX seller/account whose shipping-rule mappings are replaced. Opaque, tenant-local composite identifier (not a UUID); use the value returned by a sales channel listing.

Body

application/json

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

mappings
object[]
required

The complete desired set of shipping-rule mappings for the seller. Any existing mapping of the seller's shop that is not contained in this list is removed.

Response

Successfully replaced the shipping-rule mappings. Returns the persisted mappings including their carrier id (server-resolved for a real shipping rule, or the stored custom carrier code for an own-carrier mapping).

Declaratively replaces the complete set of shipping-rule mappings of an SCX seller/account. The request describes the full desired state: provided mappings are upserted and every mapping not contained in the request is removed. - Response

mappings
object[]
required

The persisted shipping-rule mappings including their carrier id (server-resolved for a real shipping rule, or the stored custom carrier code for an own-carrier mapping).