WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.

`ShippingRateQuoteResultDto`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The answer to a rate quote request: the outcome, the provider that produced it, and the rate options when the outcome is success.

Values

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

Field Type Description

outcome required

ShippingRateOutcome ShippingRateOutcome

What happened. `quotes` carries options only when this is `Success`.

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.

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

boolean

Whether `outcome` is `Success`. read only

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.

providerName required

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

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.

quoteId required

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

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.

expiresAt required

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

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.

quotes required

array of ShippingRateQuoteDto array of ShippingRateQuoteDto

The rate options, ordered as the provider returned them. Empty unless the outcome is success. 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 ShippingRateQuoteDto:

Field Type Description

optionId required

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

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.

carrier required

string

The carrier's name as the provider reports it, for example UPS or USPS. 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.

serviceLevelCode required

string

The provider's service level token, for example `usps_priority`. 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.

serviceLevelName required

string

The service level's display name, for example Priority Mail. 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.

amount required

number (double)

The quoted shipping amount, in `currency`.

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.

currency required

string

The ISO 4217 currency of `amount`. 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.

estimatedTransitDays required

integer (int32)

The carrier's estimated transit time in days, when the provider reports one. 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.

providerRateId required

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

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.

This body has no documented fields.

messages required

array of string array of

Provider or platform messages explaining a non-success outcome. Never carries a credential, a URL or a raw exception. 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.

This model has no documented fields.