Skip to main content
PUT
Update Retailer Merchant Setting

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the parent Retailer.

Required range: x >= 1
setting_id
integer<int32>
required

The id of the referenced RetailerMerchantSetting.

Required range: x >= 1

Body

application/json

An object conforming to the RetailerMerchantSetting schema to be merged.

A RetailerMerchantSetting holds per-merchant defaults for a Retailer. Third-party billing groups are merchant-scoped, so the retailer's TPB defaults live here — one row per (retailer, merchant).

merchant
Merchant · object

Merchant these settings apply to. Required on create; cannot be changed.

default_tpb_group_id
integer<int32> | null

Default shipping third-party billing group ID for order-integration defaults. Use 0 for None (no third-party billing); omit or null to fall back to the order default.

Required range: x >= 0
Example:

5

default_duties_tpb_group_id
integer<int32> | null

Default duties & taxes third-party billing group ID, applied when the retailer's default_duties_payor is third_party.

Required range: x >= 1
Example:

5

retailer
RetailerRef · object

Parent Retailer reference. Set from the path; cannot be changed.

Response

OK - The operation completed successfully and there is no response body.