# POST /api/shipping/rate-quotes

Shipping rate quotes: quotes carrier rates for one lane.

The quote runs through the merchant's own shipping provider binding. The request names a saved ship-from origin or supplies one inline, names saved parcel presets or
supplies parcels inline, and gives the destination. The response carries the outcome and, on
success, the rate options. A merchant with no enabled shipping provider receives the
`NotConfigured` outcome rather than an error. Quotes are rate limited per merchant; a caller
over the ceiling receives `Shipping:QuoteRateLimitExceeded` with HTTP 429.

**Operation ID:** `shippingRateQuoteGetQuote`

## Authorization

Requires: Shipping.RateQuotes, merchant scope.

Required permissions:
- `Shipping.RateQuotes`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

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

Schema: `ShippingRateQuoteRequestDto`

Properties:
- `merchantId` (string(uuid)) required: The merchant the quote is for. The caller must be authorized over this merchant; an API key  quotes only for the merchant it belongs to.
- `originId` (string(uuid)): The id of a saved ship-from origin belonging to the merchant. Give this or `origin`,  not both. Conditional: When OriginId is not null.
- `origin` (object): A ship-from address supplied inline, for a quote from a location the merchant has not saved.  Give this or `originId`, not both. Conditional: When Origin is not null.
- `destination` (object) required: The address the parcels ship to.
- `destinationIsResidential` (boolean): Whether the destination is a residence. Some carriers price residential delivery differently;  leave unset when unknown and the provider applies its own default.
- `parcelPresetIds` (array<string(uuid)>): The ids of saved parcel presets belonging to the merchant, one per parcel in the shipment. Give  this or `parcels`, not both.
- `parcels` (array<ShippingRateQuoteParcelDto>): The parcels supplied inline, one per parcel in the shipment. Give this or  `parcelPresetIds`, not both.
- `carriers` (array<string>): Optional provider-specific carrier account identifiers to restrict the quote to. When omitted the  provider quotes every carrier the binding allows.
- `serviceLevels` (array<string>): Optional provider-specific service level tokens to restrict the quote to. When omitted the provider  returns every service level the binding allows.
- `currency` (string): The ISO 4217 currency the quotes should be expressed in. When omitted the platform's configured  default currency is requested. Conditional: When Currency is not empty.

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

Schema: `ShippingRateQuoteRequestDto`

Properties:
- `merchantId` (string(uuid)) required: The merchant the quote is for. The caller must be authorized over this merchant; an API key  quotes only for the merchant it belongs to.
- `originId` (string(uuid)): The id of a saved ship-from origin belonging to the merchant. Give this or `origin`,  not both. Conditional: When OriginId is not null.
- `origin` (object): A ship-from address supplied inline, for a quote from a location the merchant has not saved.  Give this or `originId`, not both. Conditional: When Origin is not null.
- `destination` (object) required: The address the parcels ship to.
- `destinationIsResidential` (boolean): Whether the destination is a residence. Some carriers price residential delivery differently;  leave unset when unknown and the provider applies its own default.
- `parcelPresetIds` (array<string(uuid)>): The ids of saved parcel presets belonging to the merchant, one per parcel in the shipment. Give  this or `parcels`, not both.
- `parcels` (array<ShippingRateQuoteParcelDto>): The parcels supplied inline, one per parcel in the shipment. Give this or  `parcelPresetIds`, not both.
- `carriers` (array<string>): Optional provider-specific carrier account identifiers to restrict the quote to. When omitted the  provider quotes every carrier the binding allows.
- `serviceLevels` (array<string>): Optional provider-specific service level tokens to restrict the quote to. When omitted the provider  returns every service level the binding allows.
- `currency` (string): The ISO 4217 currency the quotes should be expressed in. When omitted the platform's configured  default currency is requested. Conditional: When Currency is not empty.

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

Schema: `ShippingRateQuoteRequestDto`

Properties:
- `merchantId` (string(uuid)) required: The merchant the quote is for. The caller must be authorized over this merchant; an API key  quotes only for the merchant it belongs to.
- `originId` (string(uuid)): The id of a saved ship-from origin belonging to the merchant. Give this or `origin`,  not both. Conditional: When OriginId is not null.
- `origin` (object): A ship-from address supplied inline, for a quote from a location the merchant has not saved.  Give this or `originId`, not both. Conditional: When Origin is not null.
- `destination` (object) required: The address the parcels ship to.
- `destinationIsResidential` (boolean): Whether the destination is a residence. Some carriers price residential delivery differently;  leave unset when unknown and the provider applies its own default.
- `parcelPresetIds` (array<string(uuid)>): The ids of saved parcel presets belonging to the merchant, one per parcel in the shipment. Give  this or `parcels`, not both.
- `parcels` (array<ShippingRateQuoteParcelDto>): The parcels supplied inline, one per parcel in the shipment. Give this or  `parcelPresetIds`, not both.
- `carriers` (array<string>): Optional provider-specific carrier account identifiers to restrict the quote to. When omitted the  provider quotes every carrier the binding allows.
- `serviceLevels` (array<string>): Optional provider-specific service level tokens to restrict the quote to. When omitted the provider  returns every service level the binding allows.
- `currency` (string): The ISO 4217 currency the quotes should be expressed in. When omitted the platform's configured  default currency is requested. Conditional: When Currency is not empty.

## Responses

### 200

OK

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

Schema: `ShippingRateQuoteResultDto`

Properties:
- `outcome` (object): What happened. `quotes` carries options only when this is `Success`.
- `isSuccess` (boolean): Whether `outcome` is `Success`.
- `providerName` (string): The name of the provider that answered. The platform's fallback provider answers when the  merchant has no enabled binding, with the outcome `NotConfigured`.
- `quoteId` (string(uuid)): The identifier the platform recorded this quote under, when the outcome is success. A checkout  that lets a shopper choose a service sends this identifier and the chosen option's  `optionId` back, never an amount: the server re-reads the  recorded quote and charges the amount it stored. Absent for a non-success outcome.
- `expiresAt` (string(date-time)): When the recorded quote stops being honored, in UTC. A selection submitted after this instant  is refused and the lane has to be quoted again. Absent when `quoteId` is absent.
- `quotes` (array<ShippingRateQuoteDto>): The rate options, ordered as the provider returned them. Empty unless the outcome is success.
- `messages` (array<string>): Provider or platform messages explaining a non-success outcome. Never carries a credential, a  URL or a raw exception.

### 403

Forbidden

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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. See the error-code reference in this document's description for the values `error.code` can take.

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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`

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.
- `title` (string) required: A short, human-readable summary of the problem type.
- `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.
- `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`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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 ShippingRateQuoteRequestDto. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/shipping/rate-quotes" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "destination": {}
}'
```

### PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "destination": {}
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/shipping/rate-quotes' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

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

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

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

const { data } = await api.shippingRateQuoteGetQuote({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "destination": {}
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/shipping/rate-quotes', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "destination": {}
  }),
});

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 ShippingApi(config);
var body = JsonSerializer.Deserialize<ShippingRateQuoteRequestDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "destination": {}
    }
    """);

var result = await api.ShippingRateQuoteGetQuoteAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/shipping/rate-quotes");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "destination": {}
    }
    """, 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.ShippingApi(client)
    body = winkpg_api.ShippingRateQuoteRequestDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "destination": {}
    })
    result = api.shipping_rate_quote_get_quote(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "destination": {}
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/shipping/rate-quotes",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

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