shipstation-client/models/rate.ts

ShipStation V2 SDK

/* tslint:disable */
/* eslint-disable */
/**
 * ShipStation API v2
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 2.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


// May contain unused imports in some cases
// @ts-ignore
import type { MonetaryValue } from './monetary-value';
// May contain unused imports in some cases
// @ts-ignore
import type { RateType } from './rate-type';
// May contain unused imports in some cases
// @ts-ignore
import type { ValidationStatus } from './validation-status';

/**
 * A rate
 * @export
 * @interface Rate
 */
export interface Rate {
    /**
     * A string that uniquely identifies the rate
     * @type {string}
     * @memberof Rate
     */
    'rate_id': string;
    /**
     * 
     * @type {RateType}
     * @memberof Rate
     */
    'rate_type': RateType;
    /**
     * A string that uniquely identifies the carrier
     * @type {string}
     * @memberof Rate
     */
    'carrier_id': string;
    /**
     * The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.
     * @type {MonetaryValue}
     * @memberof Rate
     */
    'shipping_amount': MonetaryValue;
    /**
     * The insurance amount.  Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.
     * @type {MonetaryValue}
     * @memberof Rate
     */
    'insurance_amount': MonetaryValue;
    /**
     * The confirmation amount.  Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.
     * @type {MonetaryValue}
     * @memberof Rate
     */
    'confirmation_amount': MonetaryValue;
    /**
     * Any other charges associated with this rate.  Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.
     * @type {MonetaryValue}
     * @memberof Rate
     */
    'other_amount': MonetaryValue;
    /**
     * The total shipping cost for the specified comparison_rate_type.
     * @type {MonetaryValue}
     * @memberof Rate
     */
    'requested_comparison_amount'?: MonetaryValue;
    /**
     * Tariff and additional taxes associated with an international shipment.
     * @type {MonetaryValue}
     * @memberof Rate
     */
    'tax_amount'?: MonetaryValue;
    /**
     * 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 
     * @type {number}
     * @memberof Rate
     */
    'zone': number | null;
    /**
     * package type that this rate was estimated for
     * @type {string}
     * @memberof Rate
     */
    'package_type': string | null;
    /**
     * The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday 
     * @type {number}
     * @memberof Rate
     */
    'delivery_days'?: number;
    /**
     * Indicates if the rate is guaranteed.
     * @type {boolean}
     * @memberof Rate
     */
    'guaranteed_service': boolean;
    /**
     * 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 . 
     * @type {string}
     * @memberof Rate
     */
    'estimated_delivery_date'?: string;
    /**
     * The carrier delivery days
     * @type {string}
     * @memberof Rate
     */
    'carrier_delivery_days'?: string;
    /**
     * ship date
     * @type {string}
     * @memberof Rate
     */
    'ship_date'?: string;
    /**
     * Indicates if the rates been negotiated
     * @type {boolean}
     * @memberof Rate
     */
    'negotiated_rate': boolean;
    /**
     * service type
     * @type {string}
     * @memberof Rate
     */
    'service_type': string;
    /**
     * service code for the rate
     * @type {string}
     * @memberof Rate
     */
    'service_code': string;
    /**
     * Indicates if rate is trackable
     * @type {boolean}
     * @memberof Rate
     */
    'trackable': boolean;
    /**
     * carrier code
     * @type {string}
     * @memberof Rate
     */
    'carrier_code': string;
    /**
     * carrier nickname
     * @type {string}
     * @memberof Rate
     */
    'carrier_nickname': string;
    /**
     * carrier friendly name
     * @type {string}
     * @memberof Rate
     */
    'carrier_friendly_name': string;
    /**
     * 
     * @type {ValidationStatus}
     * @memberof Rate
     */
    'validation_status': ValidationStatus;
    /**
     * The warning messages
     * @type {Array<string>}
     * @memberof Rate
     */
    'warning_messages': Array<string>;
    /**
     * The error messages
     * @type {Array<string>}
     * @memberof Rate
     */
    'error_messages': Array<string>;
}