# PUT /api/merchants/{id}/shipping-bindings/{providerName}

Shipping: creates or replaces the merchant's binding for one provider.

Example body for a merchant on its own carrier account:
```
{
  "isEnabled": true,
  "credentialSource": "Merchant",
  "fieldValues": [
    { "key": "WinkPG.ShippingRates.Shippo.ApiToken", "value": "…" },
    { "key": "WinkPG.ShippingRates.Shippo.CarrierAccountFilter", "value": "ca_abc123" }
  ]
}
```
For a provider the gateway holds the account for, send `"credentialSource": "Gateway"` and no field
values at all: the gateway's own credentials are resolved at quote time and are never copied onto the
merchant. Omitting a secret keeps the value already stored, which is what a caller that read the binding
first will naturally send, because reads never return one. Optionally send
`If-Match: "<concurrencyStamp>"` for optimistic concurrency (409 on a stale stamp).

**Operation ID:** `merchantShippingBindingUpsertShippingBinding`

## Authorization

Requires: Merchants.Merchants.Update, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Merchants.Merchants.Update`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) | The merchant id. |
| providerName | path | yes | string | The provider to bind (authoritative; any provider on the body is ignored). |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The binding content. Omitted fields are cleared (PUT replace semantics).

**Content type:** `application/json`

Schema: [`MerchantShippingBinding`](https://devportal.demo.winkpg.io/docs/api/models/MerchantShippingBinding.md)

Properties:
- `providerName` (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. (nullable, max length 64)
- `isEnabled` (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)
- `credentialSource` ([ProviderCredentialSource](https://devportal.demo.winkpg.io/docs/api/models/ProviderCredentialSource.md)): Whose provider account the quotes are billed to. Null reads as  `Gateway`. (nullable)
  Values:
  - `Gateway`: The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credential source reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
  - `Merchant`: The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.
- `fieldValues` (array<[ShippingBindingFieldValue](https://devportal.demo.winkpg.io/docs/api/models/ShippingBindingFieldValue.md)>): 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)
  Fields of each item:
  - `key` (string): The provider setting name this value belongs to, matching a setting field definition the provider's  contributor declares. Compared case-insensitively. (nullable)
  - `value` (string): The configured value. Ciphertext at rest whenever `isSecret` is `true`, and  `null` on every read that leaves the server. (nullable)
  - `isSecret` (boolean): Whether `value` is credential material, and so held encrypted and stripped on read. (nullable)
  - `isConfigured` (boolean): Whether a secret value is stored, set on reads so an operator can tell a configured secret from an  empty one without the value ever being sent. (nullable)

**Content type:** `text/json`

Schema: [`MerchantShippingBinding`](https://devportal.demo.winkpg.io/docs/api/models/MerchantShippingBinding.md)

Properties:
- `providerName` (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. (nullable, max length 64)
- `isEnabled` (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)
- `credentialSource` ([ProviderCredentialSource](https://devportal.demo.winkpg.io/docs/api/models/ProviderCredentialSource.md)): Whose provider account the quotes are billed to. Null reads as  `Gateway`. (nullable)
  Values:
  - `Gateway`: The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credential source reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
  - `Merchant`: The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.
- `fieldValues` (array<[ShippingBindingFieldValue](https://devportal.demo.winkpg.io/docs/api/models/ShippingBindingFieldValue.md)>): 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)
  Fields of each item:
  - `key` (string): The provider setting name this value belongs to, matching a setting field definition the provider's  contributor declares. Compared case-insensitively. (nullable)
  - `value` (string): The configured value. Ciphertext at rest whenever `isSecret` is `true`, and  `null` on every read that leaves the server. (nullable)
  - `isSecret` (boolean): Whether `value` is credential material, and so held encrypted and stripped on read. (nullable)
  - `isConfigured` (boolean): Whether a secret value is stored, set on reads so an operator can tell a configured secret from an  empty one without the value ever being sent. (nullable)

**Content type:** `application/*+json`

Schema: [`MerchantShippingBinding`](https://devportal.demo.winkpg.io/docs/api/models/MerchantShippingBinding.md)

Properties:
- `providerName` (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. (nullable, max length 64)
- `isEnabled` (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)
- `credentialSource` ([ProviderCredentialSource](https://devportal.demo.winkpg.io/docs/api/models/ProviderCredentialSource.md)): Whose provider account the quotes are billed to. Null reads as  `Gateway`. (nullable)
  Values:
  - `Gateway`: The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credential source reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
  - `Merchant`: The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.
- `fieldValues` (array<[ShippingBindingFieldValue](https://devportal.demo.winkpg.io/docs/api/models/ShippingBindingFieldValue.md)>): 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)
  Fields of each item:
  - `key` (string): The provider setting name this value belongs to, matching a setting field definition the provider's  contributor declares. Compared case-insensitively. (nullable)
  - `value` (string): The configured value. Ciphertext at rest whenever `isSecret` is `true`, and  `null` on every read that leaves the server. (nullable)
  - `isSecret` (boolean): Whether `value` is credential material, and so held encrypted and stripped on read. (nullable)
  - `isConfigured` (boolean): Whether a secret value is stored, set on reads so an operator can tell a configured secret from an  empty one without the value ever being sent. (nullable)

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`MerchantShippingBinding`](https://devportal.demo.winkpg.io/docs/api/models/MerchantShippingBinding.md)

Properties:
- `providerName` (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. (nullable, max length 64)
- `isEnabled` (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)
- `credentialSource` ([ProviderCredentialSource](https://devportal.demo.winkpg.io/docs/api/models/ProviderCredentialSource.md)): Whose provider account the quotes are billed to. Null reads as  `Gateway`. (nullable)
  Values:
  - `Gateway`: The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credential source reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
  - `Merchant`: The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.
- `fieldValues` (array<[ShippingBindingFieldValue](https://devportal.demo.winkpg.io/docs/api/models/ShippingBindingFieldValue.md)>): 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)
  Fields of each item:
  - `key` (string): The provider setting name this value belongs to, matching a setting field definition the provider's  contributor declares. Compared case-insensitively. (nullable)
  - `value` (string): The configured value. Ciphertext at rest whenever `isSecret` is `true`, and  `null` on every read that leaves the server. (nullable)
  - `isSecret` (boolean): Whether `value` is credential material, and so held encrypted and stripped on read. (nullable)
  - `isConfigured` (boolean): Whether a secret value is stored, set on reads so an operator can tell a configured secret from an  empty one without the value ever being sent. (nullable)

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a MerchantShippingBinding. See the Request body section below for its fields.

### cURL

```bash
curl -X PUT "{{BASE_URL}}/api/merchants/{id}/shipping-bindings/{providerName}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ]
}'
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ]
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/merchants/{id}/shipping-bindings/{providerName}' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, MerchantShippingBindingApi } from '@winkpg/winkpg-api';

const api = new MerchantShippingBindingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.merchantShippingBindingUpsertShippingBinding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", {
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ]
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/merchants/{id}/shipping-bindings/{providerName}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "providerName": "",
    "isEnabled": false,
    "credentialSource": {},
    "fieldValues": [
      {
        "key": "",
        "value": "",
        "isSecret": false,
        "isConfigured": false
      }
    ]
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MerchantShippingBindingApi(config);
var body = JsonSerializer.Deserialize<MerchantShippingBinding>("""
    {
      "providerName": "",
      "isEnabled": false,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": false,
          "isConfigured": false
        }
      ]
    }
    """);

var result = await api.MerchantShippingBindingUpsertShippingBindingAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME", body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/merchants/{id}/shipping-bindings/{providerName}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "providerName": "",
      "isEnabled": false,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": false,
          "isConfigured": false
        }
      ]
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.MerchantShippingBindingApi(client)
    body = winkpg_api.MerchantShippingBinding.from_dict({
      "providerName": "",
      "isEnabled": False,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": False,
          "isConfigured": False
        }
      ]
    })
    result = api.merchant_shipping_binding_upsert_shipping_binding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "providerName": "",
  "isEnabled": False,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": False,
      "isConfigured": False
    }
  ]
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/merchants/{id}/shipping-bindings/{providerName}",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.