shipstation-client
Version:
ShipStation V2 SDK
68 lines (60 loc) • 4 kB
Markdown
A rate estimate
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rate_type** | [**RateType**](RateType.md) | | [readonly] [default to undefined]
**carrier_id** | **string** | A string that uniquely identifies the carrier | [readonly] [default to undefined]
**shipping_amount** | [**MonetaryValue**](MonetaryValue.md) | The shipping amount | [readonly] [default to undefined]
**insurance_amount** | [**MonetaryValue**](MonetaryValue.md) | The insurance amount | [readonly] [default to undefined]
**confirmation_amount** | [**MonetaryValue**](MonetaryValue.md) | The confirmation amount | [readonly] [default to undefined]
**other_amount** | [**MonetaryValue**](MonetaryValue.md) | Any other charges associated with this rate | [readonly] [default to undefined]
**tax_amount** | [**MonetaryValue**](MonetaryValue.md) | Tariff and additional taxes associated with an international shipment. | [optional] [readonly] [default to undefined]
**zone** | **number** | Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location | [readonly] [default to undefined]
**package_type** | **string** | package type that this rate was estimated for | [readonly] [default to undefined]
**delivery_days** | **number** | The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday | [optional] [readonly] [default to undefined]
**guaranteed_service** | **boolean** | Indicates if the rate is guaranteed. | [readonly] [default to undefined]
**estimated_delivery_date** | **string** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipStation . | [optional] [readonly] [default to undefined]
**carrier_delivery_days** | **string** | The carrier delivery days | [optional] [readonly] [default to undefined]
**ship_date** | **string** | ship date | [optional] [readonly] [default to undefined]
**negotiated_rate** | **boolean** | Indicates if the rates been negotiated | [readonly] [default to undefined]
**service_type** | **string** | service type | [readonly] [default to undefined]
**service_code** | **string** | service code for the rate | [readonly] [default to undefined]
**trackable** | **boolean** | Indicates if rate is trackable | [readonly] [default to undefined]
**carrier_code** | **string** | A [shipping carrier] , such as &
**carrier_nickname** | **string** | carrier nickname | [readonly] [default to undefined]
**carrier_friendly_name** | **string** | carrier friendly name | [readonly] [default to undefined]
**validation_status** | [**ValidationStatus**](ValidationStatus.md) | | [readonly] [default to undefined]
**warning_messages** | **Array<string>** | The warning messages | [default to undefined]
**error_messages** | **Array<string>** | The error messages | [default to undefined]
```typescript
import { RateEstimate } from 'shipstation-client';
const instance: RateEstimate = {
rate_type,
carrier_id,
shipping_amount,
insurance_amount,
confirmation_amount,
other_amount,
tax_amount,
zone,
package_type,
delivery_days,
guaranteed_service,
estimated_delivery_date,
carrier_delivery_days,
ship_date,
negotiated_rate,
service_type,
service_code,
trackable,
carrier_code,
carrier_nickname,
carrier_friendly_name,
validation_status,
warning_messages,
error_messages,
};
```
[[Back to Model list]](../README.md