MerchantShippingBinding
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Per-merchant shipping rate provider binding. Persisted as an element of `Merchant.ShippingBindings`. The binding belongs to the merchant, so a shipping quote reaches the same answer wherever it is computed: on the hosted payment page, in a background job, or while an operator watches. Collection membership decides whether the merchant is boarded with that provider at all, and `isEnabled` decides whether it is currently switched on: the same two-level shape the tax, 3-D Secure and wallet bindings use, so a merchant can be switched off without losing credentials.
Values
Fields
| Field | Type | Description | ||||
|---|---|---|---|---|---|---|
providerName
required |
string | Which shipping provider this entry binds the merchant to, by the provider's registered name. Compared
case-insensitively. A null or blank provider is treated as no binding at all, so an incompletely
boarded row cannot silently become a live selection.
Required: When IsEnabled is true.
nullablemax length 64
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
isEnabled
required |
boolean | Master enable flag for this provider on this merchant. When `false` or null, the selector must
not return this binding even though the row exists.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
credentialSource
required |
ProviderCredentialSource ProviderCredentialSource | Whose provider account the quotes are billed to. Null reads as
`Gateway`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
fieldValues
required |
array of ShippingBindingFieldValue array of ShippingBindingFieldValue | The provider-declared configuration values for this merchant, keyed by the setting names the provider
declares. For a provider whose gateway credentials are platform-wide settings, the keys are those same
setting names, so one name identifies a credential whoever holds it.
<b>Secret values are stored encrypted</b> and are stripped, not decrypted, on every read that leaves the
server: the admin UI and the API both see null and re-send a secret only when the operator changes it.
Only the server-side call to the provider ever uses the plaintext.
Empty for a `Gateway` binding, whose values are filled in at read
time from the host-scoped provider settings instead. A gateway-sourced row that carried values would be
a copy of the gateway's token living on a merchant document.
Conditional: When FieldValues is not null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
Fields of each ShippingBindingFieldValue: This body has no documented fields. | ||||||
This model has no documented fields.