Skip to main content

This type provides applicable shipping service metadata.

Type that uses ShippingService

ShippingServiceResponse

Call that uses ShippingService

Fields

Field
Type
Description
description
This field returns the localized name of the shipping service.
internationalService
A value of true indicates that the shipping service is international. An international shipping service option is required if an item is being shipped from one country (origin) to another (destination).
maxShippingTime
This value indicates the maximum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService.
minShippingTime
This value indicates the minimum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService.
packageLimits
This container provides name-value pairs that specify physical constraints and measurement units of packages for the shippingCarrier and the corresponding shippingService. An empty container is returned if the shipping service does not have any package limits defined.
shippingCarrier
The code for the shipping carrier returned, for example, UPS, FedEx, and USPS.
shippingCategory
The shipping category of the shipping service including: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, and other similar categories.
shippingCostTypes
array of string
A list of shipping cost types that this shipping service option supports. For example, FLAT_RATE, CALCULATED, and FREIGHT.
shippingService
The name of the shipping service. The shipping service named here can only be used in listings or in business policies if validForSellingFlow is true. The value returned in this field is used in listing APIs and business policies to set the shipping service.
validForSellingFlow
A value of true indicates that the shippingService can be set as an available shipping service in the listing or through the fulfillment business policy.