Interface ShippingService

A shipping service offer made by a carrier.

Export

ShippingService

interface ShippingService {
    AvailableFormatOptionsForLabel?: LabelFormatOption[];
    AvailableLabelFormats?: LabelFormat[];
    AvailableShippingServiceOptions?: AvailableShippingServiceOptions;
    Benefits?: Benefits;
    CarrierName: string;
    EarliestEstimatedDeliveryDate?: string;
    LatestEstimatedDeliveryDate?: string;
    Rate: CurrencyAmount;
    RequiresAdditionalSellerInputs: boolean;
    ShipDate: string;
    ShippingServiceId: string;
    ShippingServiceName: string;
    ShippingServiceOfferId: string;
    ShippingServiceOptions: ShippingServiceOptions;
}

Properties

AvailableFormatOptionsForLabel? AvailableLabelFormats? AvailableShippingServiceOptions? Benefits? CarrierName EarliestEstimatedDeliveryDate? LatestEstimatedDeliveryDate? Rate RequiresAdditionalSellerInputs ShipDate ShippingServiceId ShippingServiceName ShippingServiceOfferId ShippingServiceOptions

Properties

OptionalAvailableFormatOptionsForLabel

AvailableFormatOptionsForLabel?: LabelFormatOption[]

The available label formats.

Memberof

ShippingService

OptionalAvailableLabelFormats

AvailableLabelFormats?: LabelFormat[]

List of label formats.

Memberof

ShippingService

OptionalAvailableShippingServiceOptions

AvailableShippingServiceOptions?: AvailableShippingServiceOptions

Memberof

ShippingService

OptionalBenefits

Benefits?: Benefits

Memberof

ShippingService

CarrierName

CarrierName: string

The name of the carrier.

Memberof

ShippingService

OptionalEarliestEstimatedDeliveryDate

EarliestEstimatedDeliveryDate?: string

Date-time formatted timestamp.

Memberof

ShippingService

OptionalLatestEstimatedDeliveryDate

LatestEstimatedDeliveryDate?: string

Date-time formatted timestamp.

Memberof

ShippingService

Rate

Rate: CurrencyAmount

Memberof

ShippingService

RequiresAdditionalSellerInputs

RequiresAdditionalSellerInputs: boolean

When true, additional seller inputs are required.

Memberof

ShippingService

ShipDate

ShipDate: string

Date-time formatted timestamp.

Memberof

ShippingService

ShippingServiceId

ShippingServiceId: string

An Amazon-defined shipping service identifier.

Memberof

ShippingService

ShippingServiceName

ShippingServiceName: string

A plain text representation of a carrier's shipping service. For example, "UPS Ground" or "FedEx Standard Overnight".

Memberof

ShippingService

ShippingServiceOfferId

ShippingServiceOfferId: string

An Amazon-defined shipping service offer identifier.

Memberof

ShippingService

ShippingServiceOptions

ShippingServiceOptions: ShippingServiceOptions

Memberof

ShippingService

Settings

Member Visibility

On This Page

Properties