ShippingPolicyService
Type defining the domesticShippingPolicyInfoService and internationalShippingPolicyInfoService containers, which consists of detailed information on domestic and international shipping service options.
No calls use ShippingPolicyService.
Fields
fastShipping ( boolean )
freeShipping ( boolean )
shippingType ( token )
shipToLocation ( token )
sortOrderId ( int )
Not used by any call.
This field is only applicable to motor vehicle categories on eBay Motors (US and Canada).
If this field is included and set to 'true' (or omitted because the default value is 'true'), the buyer is responsible for the shipment/pickup of the motor vehicle. If this field is included and set to 'false', the seller should specify the vehicle shipping arrangements in the item description for the listing.
If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.
This field is only applicable to motor vehicle categories on eBay Motors (US and Canada).
If this field is included and set to 'true' (or omitted because the default value is 'true'), the buyer is responsible for the shipment/pickup of the motor vehicle. If this field is included and set to 'false', the seller should specify the vehicle shipping arrangements in the item description for the listing.
If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.
See the Field Index to learn which calls use buyerResponsibleForShipping.
Not used by any call.
This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the buyer selects the 'COD' payment method and if the selected shipping service option suppports the Cash-on-Delivery option.
To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service.
This value indicates the Cash-on-Delivery fee that is due from the buyer upon item delivery. This field is only applicable if the buyer selects the 'COD' payment method and if the selected shipping service option suppports the Cash-on-Delivery option.
To see if a domestic shipping service option supports the Cash-on-Delivery option, call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a CODService=true flag for the corresponding shipping service.
See the Field Index to learn which calls use codFee.
Not used by any call.
This flag indicates whether or not a 'Get It Fast' shipping service option is available for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option.
To enable 'Get It Fast' shippping for a listing, the seller must:
The fastShipping field should only be included and set to 'true' in domesticShippingPolicyInfoService containers where the shipping service option is a one-day shipping service. The fastShipping field is not applicable for internationalShippingPolicyInfoService containers.
This flag indicates whether or not a 'Get It Fast' shipping service option is available for the listing. 'Get It Fast' shipping is only available for fixed-price listings and auction listings with an active 'Buy It Now' option.
To enable 'Get It Fast' shippping for a listing, the seller must:
- offer at least one domestic one-day shipping service option, such as USPS Express Mail, UPS Next Day Air, or FedEx Overnight;
- set the shippingPolicyInfo.dispatchTimeMax value to '0' (same-day shipping) or '1', which means that the seller is committing to ship the item within one business day after receiving payment from the buyer.
The fastShipping field should only be included and set to 'true' in domesticShippingPolicyInfoService containers where the shipping service option is a one-day shipping service. The fastShipping field is not applicable for internationalShippingPolicyInfoService containers.
See the Field Index to learn which calls use fastShipping.
Not used by any call.
This flag is used by the seller to offer free shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a sortOrderId value of '1', or, if the sortOrderId field is not used, the shipping service option specified first in the API call. The freeShipping field is not applicable for internationalShippingPolicyInfoService containers.
This flag is used by the seller to offer free shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for any other shipping service option). The first specified shipping service option either has a sortOrderId value of '1', or, if the sortOrderId field is not used, the shipping service option specified first in the API call. The freeShipping field is not applicable for internationalShippingPolicyInfoService containers.
See the Field Index to learn which calls use freeShipping.
Not used by any call.
The dollar amount in this field represents the actual total price of shipping if the total shipping costs (shippingServiceCost + shippingServiceAdditionalCost + shippingSurcharge) set for the corresponding shipping service in the shipping policy are overridden through a ShippingServiceCostOverride container in an AddItem call (Trading).
The dollar amount in this field represents the actual total price of shipping if the total shipping costs (shippingServiceCost + shippingServiceAdditionalCost + shippingSurcharge) set for the corresponding shipping service in the shipping policy are overridden through a ShippingServiceCostOverride container in an AddItem call (Trading).
See the Field Index to learn which calls use shippingOverrideFee.
Not used by any call.
A domestic or international shipping service being offered by the seller to ship an item to a buyer.
For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing.
The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing.
If 'Get It Fast' shipping is being enabled for the shipping policy (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping.
A domestic or international shipping service being offered by the seller to ship an item to a buyer.
For a list of valid shippingService values, call GeteBayDetails, including ShippingServiceDetails as a DetailName value, and then look through the ShippingServiceDetails containers returned in the response. International shipping services are marked with an InternationalService flag. All shipping services without this flag are domestic shipping services. The ShippingServiceDetails.ValidForSellingFlow flag must be present for both domestic and international shipping services, otherwise, that specific shipping service option is no longer valid and cannot be offered to buyers through a listing.
The seller must specify one shipping service in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile or setSellerProfile request. Up to four domestic and five international shipping service may be offered to the buyer per listing.
If 'Get It Fast' shipping is being enabled for the shipping policy (fastShipping=true), the first specified domestic shipping service (specified in the first domesticShippingPolicyInfoService.shippingService field) must be a one-day shipping service. To verify that a domestic shipping service is a one-day shipping service (hence, it qualifies for 'Get It Fast' shipping), call GeteBayDetails, including 'ShippingServiceDetails' as a DetailName value, and then look for a ShippingCategory value of 'ONE_DAY' for the corresponding shipping service. 'Get It Fast' shipping is not available for international shipping.
See the Field Index to learn which calls use shippingService.
Not used by any call.
This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used.
This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer.
The total shipping costs for an order line item is calculated with the following formula:
Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased)
So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)).
This field is not applicable to calculated shipping.
This value sets the cost of shipping each additional item if the buyer purchases multiple identical items in a multi-quantity, fixed-price listing. This field is required for all multi-quantity, fixed-price listings where flat-rate shipping is used.
This value is at the seller's discretion. Generally, it should be the same price or lower than the shippingServiceCost value. The seller may consider specifying a lower price to ship additional items as an incentive to the buyer to purchase multiple items. The seller may also consider a lower price if he/she is able to ship multiple items in the same box. In this scenario, the seller is able to save on shipping costs and passes these savings down to the buyer.
The total shipping costs for an order line item is calculated with the following formula:
Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased)
So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)).
This field is not applicable to calculated shipping.
See the Field Index to learn which calls use shippingServiceAdditionalCost.
Not used by any call.
This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping.
This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to '0.0' if the freeShipping field is set to 'true'.
The total shipping costs for an order line item is calculated with the following formula:
Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased)
So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)).
This value sets the cost of shipping for the item if the buyer selects this shipping service option. This field is required in the input for all listings where flat-rate shipping is used, and is not applicable to calculated shipping.
This value is at the seller's discretion but should reflect the approximate cost of the shipping service option plus handling. This value defaults to '0.0' if the freeShipping field is set to 'true'.
The total shipping costs for an order line item is calculated with the following formula:
Total shipping costs = shippingServiceCost + (shippingServiceAdditionalCost * quantity purchased)
So, if a buyer purchases four identical items, and the seller has specified shippingServiceCost as $6.00 and shippingServiceAdditionalCost as $2.00, the total shipping cost for the order line item is $12.00 ($6.00 + ($2.00 * 3)).
See the Field Index to learn which calls use shippingServiceCost.
Not used by any call.
An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas.
In order for sellers to add a shipping surcharge at the shipping service level, the following must be true:
An additional charge that US sellers can add to the cost of an order line item if that order line item is an eBay Motors Parts and Accessories item that is being shipped to a buyer in Alaska, Hawaii, or Puerto Rico through a UPS or FedEx shipping service that charges a surcharge to ship to those areas.
In order for sellers to add a shipping surcharge at the shipping service level, the following must be true:
- a surcharge is applicable for the shipping service (call GeteBayDetails with DetailName set to ShippingServiceDetails, and then look for ShippingServiceDetails.SurchargeApplicable=true in the response;
- flat-rate shipping is used
See the Field Index to learn which calls use shippingSurcharge.
Not used by any call.
This value indicates the shipping cost model used by the shipping service option. The two applicable values are 'Flat' and 'Calculated'. To verify that the shipping service supports calculated shipping, call geteBayDetails, using ShipppingServiceDetails as a DetailName value in the request, and then look at the ShippingServiceDetails container that corresponds to the specified shipping service option (see ShippingServiceDetails.ShippingService). One of the ShippingServiceDetails.ServiceType values in that same container should be 'Flat'.
This field is optional in an addSellerProfile or setSellerProfile request, and defaults to 'Flat'.
This field is always returned in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile setSellerProfile, or getSellerProfiles response.
This value indicates the shipping cost model used by the shipping service option. The two applicable values are 'Flat' and 'Calculated'. To verify that the shipping service supports calculated shipping, call geteBayDetails, using ShipppingServiceDetails as a DetailName value in the request, and then look at the ShippingServiceDetails container that corresponds to the specified shipping service option (see ShippingServiceDetails.ShippingService). One of the ShippingServiceDetails.ServiceType values in that same container should be 'Flat'.
This field is optional in an addSellerProfile or setSellerProfile request, and defaults to 'Flat'.
This field is always returned in each domesticShippingPolicyInfoService and internationalShippingPolicyInfoService container in an addSellerProfile setSellerProfile, or getSellerProfiles response.
See the Field Index to learn which calls use shippingType.
Not used by any call.
An international region (such as Asia or Europe) or a country (represented by two-letter country code) to where the seller will ship an item. To obtain valid 'Ship-To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item.
If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'.
If the seller does want to offer international shipping as part of the shipping policy, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field.
All shipToLocation fields specified for the shipping policy are always returned in the getSellerProfiles call.
An international region (such as Asia or Europe) or a country (represented by two-letter country code) to where the seller will ship an item. To obtain valid 'Ship-To locations' for their site, the seller must call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response. The shipping regions and countries that may be specified as shipToLocation values will vary according to eBay site. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item.
If no shipToLocation field is included in the domesticShippingPolicyInfoService container when using the addSellerProfile or setSellerProfile calls, eBay will automatically add the seller's listing country as a 'Ship-To Location'.
If the seller does want to offer international shipping as part of the shipping policy, at least one shipToLocation field in the internationalShippingPolicyInfoService container is required when using the addSellerProfile and setSellerProfile calls. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'Worldwide' as a shipToLocation value. If the seller wants to ship to a specific region, but would like to exclude one or more countries in that region, the seller should include that region as a shipToLocation value, but then exclude one or more countries in that region by including one or more instances of the shippingPolicyInfo.excludeShipToLocation field.
All shipToLocation fields specified for the shipping policy are always returned in the getSellerProfiles call.
See the Field Index to learn which calls use shipToLocation.
Not used by any call.
This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages.
Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options.
Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages.
If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call.
This integer value controls the order (relative to other shipping service options) in which the corresponding shipping service option will appear in the View Item and Checkout pages.
Sellers can specify up to four domestic shipping services (in four separate domesticShippingPolicyInfoService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrderId value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrderId value of '4' appears at the bottom of a list of four shipping service options.
Sellers can specify up to five international shipping services (in five separate internationalShippingPolicyInfoService containers), so valid values are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrderId value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages.
If the sortOrderId field is not used, the order of domestic and international shipping service options will be determined by the order they are listed in the API call.
See the Field Index to learn which calls use sortOrderId.