# 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. An inline parcel whose weight is not above zero and at most 100,000, or whose length, width or height is not above zero and at most 10,000, is refused with HTTP 400: each failing measure is a `validationErrors` entry on `parcels[n].Weight`, `parcels[n].Length`, `parcels[n].Width` or `parcels[n].Height` carrying the code `Shipping:ParcelMeasureOutOfRange`. **Operation ID:** `shippingRateQuoteGetQuote` ## Authorization Requires: Shipping.RateQuotes, merchant scope. Requires API key scope: `transactions:read` 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`](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateQuoteRequestDto.md) 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. (nullable) - `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. (nullable) - `origin` ([Address](https://devportal.demo.winkpg.io/docs/api/models/Address.md)): 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. Fields: - `id` (string(uuid)): Gets the unique identifier for the address. (read only) - `address1` (string): Gets or sets the first line of the address (e.g., street address). (nullable, max length 100) - `address2` (string): Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). (nullable, max length 100) - `city` (string): Gets or sets the city of the address. (nullable, max length 100) - `state` (string): Gets or sets the state or region of the address. (nullable, max length 100) - `province` (string): Gets or sets the province of the address (if applicable). (nullable) - `zip` (string): Gets or sets the ZIP code of the address. Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. (nullable) - `postalCode` (string): Gets or sets the postal code of the address. (nullable, max length 20) - `country` (string): Gets or sets the country of the address. Defaults to "USA". (nullable, max length 100) - `isMailing` (boolean): Gets or sets a value indicating whether this address is a mailing address. - `isDefault` (boolean): Gets or sets a value indicating whether this address is the default address. - `destination` ([Address](https://devportal.demo.winkpg.io/docs/api/models/Address.md)) required: The address the parcels ship to. Fields: - `id` (string(uuid)): Gets the unique identifier for the address. (read only) - `address1` (string): Gets or sets the first line of the address (e.g., street address). (nullable, max length 100) - `address2` (string): Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). (nullable, max length 100) - `city` (string): Gets or sets the city of the address. (nullable, max length 100) - `state` (string): Gets or sets the state or region of the address. (nullable, max length 100) - `province` (string): Gets or sets the province of the address (if applicable). (nullable) - `zip` (string): Gets or sets the ZIP code of the address. Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. (nullable) - `postalCode` (string): Gets or sets the postal code of the address. (nullable, max length 20) - `country` (string): Gets or sets the country of the address. Defaults to "USA". (nullable, max length 100) - `isMailing` (boolean): Gets or sets a value indicating whether this address is a mailing address. - `isDefault` (boolean): Gets or sets a value indicating whether this address is the default address. - `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. (nullable) - `parcelPresetIds` (array): The ids of saved parcel presets belonging to the merchant, one per parcel in the shipment. Give this or `parcels`, not both. (nullable) - `parcels` (array<[ShippingRateQuoteParcelDto](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateQuoteParcelDto.md)>): The parcels supplied inline, one per parcel in the shipment. Give this or `parcelPresetIds`, not both. (nullable) Fields of each item: - `weight` (number(double)): The packed weight of the parcel, in `weightUnit`. (greater than 0, max 100000) - `weightUnit` ([ShippingWeightUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingWeightUnit.md)): The unit `weight` is given in. Defaults to pounds. Values: - `Gram`: Grams. - `Kilogram`: Kilograms. - `Ounce`: Ounces (avoirdupois). - `Pound`: Pounds (avoirdupois). - `length` (number(double)): The longest outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `width` (number(double)): The second outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `height` (number(double)): The third outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `dimensionUnit` ([ShippingDimensionUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingDimensionUnit.md)): The unit the three sides are given in. Defaults to inches. Values: - `Centimeter`: Centimetres. - `Inch`: Inches. - `carriers` (array): Optional provider-specific carrier account identifiers to restrict the quote to. When omitted the provider quotes every carrier the binding allows. (nullable) - `serviceLevels` (array): Optional provider-specific service level tokens to restrict the quote to. When omitted the provider returns every service level the binding allows. (nullable) - `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. (nullable) **Content type:** `text/json` Schema: [`ShippingRateQuoteRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateQuoteRequestDto.md) 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. (nullable) - `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. (nullable) - `origin` ([Address](https://devportal.demo.winkpg.io/docs/api/models/Address.md)): 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. Fields: - `id` (string(uuid)): Gets the unique identifier for the address. (read only) - `address1` (string): Gets or sets the first line of the address (e.g., street address). (nullable, max length 100) - `address2` (string): Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). (nullable, max length 100) - `city` (string): Gets or sets the city of the address. (nullable, max length 100) - `state` (string): Gets or sets the state or region of the address. (nullable, max length 100) - `province` (string): Gets or sets the province of the address (if applicable). (nullable) - `zip` (string): Gets or sets the ZIP code of the address. Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. (nullable) - `postalCode` (string): Gets or sets the postal code of the address. (nullable, max length 20) - `country` (string): Gets or sets the country of the address. Defaults to "USA". (nullable, max length 100) - `isMailing` (boolean): Gets or sets a value indicating whether this address is a mailing address. - `isDefault` (boolean): Gets or sets a value indicating whether this address is the default address. - `destination` ([Address](https://devportal.demo.winkpg.io/docs/api/models/Address.md)) required: The address the parcels ship to. Fields: - `id` (string(uuid)): Gets the unique identifier for the address. (read only) - `address1` (string): Gets or sets the first line of the address (e.g., street address). (nullable, max length 100) - `address2` (string): Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). (nullable, max length 100) - `city` (string): Gets or sets the city of the address. (nullable, max length 100) - `state` (string): Gets or sets the state or region of the address. (nullable, max length 100) - `province` (string): Gets or sets the province of the address (if applicable). (nullable) - `zip` (string): Gets or sets the ZIP code of the address. Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. (nullable) - `postalCode` (string): Gets or sets the postal code of the address. (nullable, max length 20) - `country` (string): Gets or sets the country of the address. Defaults to "USA". (nullable, max length 100) - `isMailing` (boolean): Gets or sets a value indicating whether this address is a mailing address. - `isDefault` (boolean): Gets or sets a value indicating whether this address is the default address. - `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. (nullable) - `parcelPresetIds` (array): The ids of saved parcel presets belonging to the merchant, one per parcel in the shipment. Give this or `parcels`, not both. (nullable) - `parcels` (array<[ShippingRateQuoteParcelDto](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateQuoteParcelDto.md)>): The parcels supplied inline, one per parcel in the shipment. Give this or `parcelPresetIds`, not both. (nullable) Fields of each item: - `weight` (number(double)): The packed weight of the parcel, in `weightUnit`. (greater than 0, max 100000) - `weightUnit` ([ShippingWeightUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingWeightUnit.md)): The unit `weight` is given in. Defaults to pounds. Values: - `Gram`: Grams. - `Kilogram`: Kilograms. - `Ounce`: Ounces (avoirdupois). - `Pound`: Pounds (avoirdupois). - `length` (number(double)): The longest outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `width` (number(double)): The second outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `height` (number(double)): The third outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `dimensionUnit` ([ShippingDimensionUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingDimensionUnit.md)): The unit the three sides are given in. Defaults to inches. Values: - `Centimeter`: Centimetres. - `Inch`: Inches. - `carriers` (array): Optional provider-specific carrier account identifiers to restrict the quote to. When omitted the provider quotes every carrier the binding allows. (nullable) - `serviceLevels` (array): Optional provider-specific service level tokens to restrict the quote to. When omitted the provider returns every service level the binding allows. (nullable) - `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. (nullable) **Content type:** `application/*+json` Schema: [`ShippingRateQuoteRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateQuoteRequestDto.md) 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. (nullable) - `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. (nullable) - `origin` ([Address](https://devportal.demo.winkpg.io/docs/api/models/Address.md)): 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. Fields: - `id` (string(uuid)): Gets the unique identifier for the address. (read only) - `address1` (string): Gets or sets the first line of the address (e.g., street address). (nullable, max length 100) - `address2` (string): Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). (nullable, max length 100) - `city` (string): Gets or sets the city of the address. (nullable, max length 100) - `state` (string): Gets or sets the state or region of the address. (nullable, max length 100) - `province` (string): Gets or sets the province of the address (if applicable). (nullable) - `zip` (string): Gets or sets the ZIP code of the address. Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. (nullable) - `postalCode` (string): Gets or sets the postal code of the address. (nullable, max length 20) - `country` (string): Gets or sets the country of the address. Defaults to "USA". (nullable, max length 100) - `isMailing` (boolean): Gets or sets a value indicating whether this address is a mailing address. - `isDefault` (boolean): Gets or sets a value indicating whether this address is the default address. - `destination` ([Address](https://devportal.demo.winkpg.io/docs/api/models/Address.md)) required: The address the parcels ship to. Fields: - `id` (string(uuid)): Gets the unique identifier for the address. (read only) - `address1` (string): Gets or sets the first line of the address (e.g., street address). (nullable, max length 100) - `address2` (string): Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). (nullable, max length 100) - `city` (string): Gets or sets the city of the address. (nullable, max length 100) - `state` (string): Gets or sets the state or region of the address. (nullable, max length 100) - `province` (string): Gets or sets the province of the address (if applicable). (nullable) - `zip` (string): Gets or sets the ZIP code of the address. Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. (nullable) - `postalCode` (string): Gets or sets the postal code of the address. (nullable, max length 20) - `country` (string): Gets or sets the country of the address. Defaults to "USA". (nullable, max length 100) - `isMailing` (boolean): Gets or sets a value indicating whether this address is a mailing address. - `isDefault` (boolean): Gets or sets a value indicating whether this address is the default address. - `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. (nullable) - `parcelPresetIds` (array): The ids of saved parcel presets belonging to the merchant, one per parcel in the shipment. Give this or `parcels`, not both. (nullable) - `parcels` (array<[ShippingRateQuoteParcelDto](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateQuoteParcelDto.md)>): The parcels supplied inline, one per parcel in the shipment. Give this or `parcelPresetIds`, not both. (nullable) Fields of each item: - `weight` (number(double)): The packed weight of the parcel, in `weightUnit`. (greater than 0, max 100000) - `weightUnit` ([ShippingWeightUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingWeightUnit.md)): The unit `weight` is given in. Defaults to pounds. Values: - `Gram`: Grams. - `Kilogram`: Kilograms. - `Ounce`: Ounces (avoirdupois). - `Pound`: Pounds (avoirdupois). - `length` (number(double)): The longest outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `width` (number(double)): The second outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `height` (number(double)): The third outer side of the parcel, in `dimensionUnit`. (greater than 0, max 10000) - `dimensionUnit` ([ShippingDimensionUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingDimensionUnit.md)): The unit the three sides are given in. Defaults to inches. Values: - `Centimeter`: Centimetres. - `Inch`: Inches. - `carriers` (array): Optional provider-specific carrier account identifiers to restrict the quote to. When omitted the provider quotes every carrier the binding allows. (nullable) - `serviceLevels` (array): Optional provider-specific service level tokens to restrict the quote to. When omitted the provider returns every service level the binding allows. (nullable) - `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. (nullable) ## Responses ### 200 OK **Content type:** `application/json` Schema: [`ShippingRateQuoteResultDto`](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateQuoteResultDto.md) Properties: - `outcome` ([ShippingRateOutcome](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateOutcome.md)): What happened. `quotes` carries options only when this is `Success`. Values: - `Success`: The provider answered with at least one quote. - `NoRatesForLane`: The provider answered, and no carrier it reaches serves this origin, destination and parcel combination. Not an error: the page shows no options and the merchant checks the lane. - `NotConfigured`: No provider is configured or enabled. The null provider's only answer. - `Misconfigured`: A provider is configured but its own settings are incomplete or invalid (a missing credential, an unusable carrier account filter). An administrator fixes this on the settings page. - `AuthenticationFailed`: The provider rejected the credential (HTTP 401 or 403). - `RateLimited`: The provider throttled the caller (HTTP 429). - `InvalidRequest`: The provider rejected the request as malformed or unsupported (any other 4xx). - `ProviderUnavailable`: The provider could not be reached or answered with a server-side fault: a transport failure, an open circuit, or a 5xx. - `Timeout`: The call did not complete within QuoteTimeoutSeconds. - `MalformedResponse`: The provider answered 2xx with a body the response mapper could not read. - `isSuccess` (boolean): Whether `outcome` is `Success`. (read only) - `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`. (nullable) - `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. (nullable) - `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. (nullable) - `quotes` (array<[ShippingRateQuoteDto](https://devportal.demo.winkpg.io/docs/api/models/ShippingRateQuoteDto.md)>): The rate options, ordered as the provider returned them. Empty unless the outcome is success. (nullable) Fields of each item: - `optionId` (string(uuid)): The platform's identifier for this option within the recorded quote, when the quote was recorded. What a selection sends back alongside the quote's identifier. (nullable) - `carrier` (string): The carrier's name as the provider reports it, for example UPS or USPS. (nullable) - `serviceLevelCode` (string): The provider's service level token, for example `usps_priority`. (nullable) - `serviceLevelName` (string): The service level's display name, for example Priority Mail. (nullable) - `amount` (number(double)): The quoted shipping amount, in `currency`. - `currency` (string): The ISO 4217 currency of `amount`. (nullable) - `estimatedTransitDays` (integer(int32)): The carrier's estimated transit time in days, when the provider reports one. (nullable) - `providerRateId` (string): The provider's own identifier for this rate. Opaque to the platform; a later label purchase through the same provider would refer to it. (nullable) - `messages` (array): Provider or platform messages explaining a non-success outcome. Never carries a credential, a URL or a raw exception. (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 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(""" { "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.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.