Shipping: probes the merchant's bound provider and reports whether it answered.

POST /api/merchants/{id}/shipping-bindings/{providerName}/test-connection deprecated

Requires: Merchants.Merchants.Update, merchant scope.

The probe never requests a rate: it runs the provider's connectivity tester, which is credential-scoped and takes no lane or parcel. It carries back no vendor response body and no credential material. A candidate body is used for the probe and nothing else: it is never persisted, never logged, and never echoed in the response.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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 PowerShell TypeScript C# Python

cURL

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

PowerShell

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

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

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

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

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/shipping-bindings/{providerName}/test-connection', {
  method: 'POST',
  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();

dotnet add package WinkPg.Api.Client

C# (SDK)

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.MerchantShippingBindingTestShippingBindingConnectionAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME", body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/merchants/{id}/shipping-bindings/{providerName}/test-connection");
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();

pip install winkpg-api

Python (SDK)

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_test_shipping_binding_connection("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", body)

pip install requests

Python (raw HTTP)

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(
    "POST",
    "{{BASE_URL}}/api/merchants/{id}/shipping-bindings/{providerName}/test-connection",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The merchant id.
`providerName` required	path	string	The provider to probe.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

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
`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
`credentialSource` required	all of ProviderCredentialSource	Whose provider account the quotes are billed to. Null reads as `Gateway`. nullable
`fieldValues` required	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

This request body has no documented fields.