eBay Business Policies Management APIVersion 1.1.0

ShippingPolicyInfo

Type defining the shippingPolicyInfo container, which consists of detailed information for a seller's shipping policy.

Type that uses ShippingPolicyInfo:

Calls that use ShippingPolicyInfo:

Fields



dispatchTimeMax ( int ) [0..1]
Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment for an order. This time does not include the shipping time (the carrier's transit time). Valid values can vary by site and by category. To obtain supported values for a site, call GeteBayDetails, using DispatchTimeMaxDetails as a DetailName value in the request, and then look at the DispatchTimeMaxDetails container in the response for supported values for the site.

Note that Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results. To offer zero-day or one-day handling, the seller should include the dispatchTimeMax field in the shipping business policy and set the value of this field to '0' or '1', respectively.

The dispatchTimeMax field must be included in the shipping policy and set to '0' or '1' if the fastShipping flag is included and set to 'true' in the shipping policy.

Note: Traditionally in the Trading API, sellers using an Add/Revise/Relist API call were allowed to pass in a DispatchTimeMax value of '0' to indicate that no handling time is specified for the listing. However, with the onboarding of same-day shipping, a DispatchTimeMax value of '0' will indicate that the seller is offering same-day shipping. Now, sellers that do not want to specify a handling time for their shipping policy, should omit the < b>dispatchTimeMax field, or they can include it but set it to null.
This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use dispatchTimeMax.

dispatchTimeReason ( string ) [0..1]
This free-form string field is used by the seller to provide more details to the buyer about handling time.

If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use dispatchTimeReason.

domesticRateTable ( token ) [0..1]
This value indicates that the seller's domestic shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for domesticRateTable is 'Default', which means that the default domestic shipping rate table set up by the seller in My eBay is referenced.

Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if a domestic shipping rate table is set up for the seller's account in My eBay, and it will only affect those domestic regions for which flat shipping rates are defined.

If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use domesticRateTable.

domesticShippingPolicyInfoService ( ShippingPolicyInfoService ) [0..*]
Container that consists of detailed information for a domestic shipping service, including shipping costs, ship-to locations, and flags to indicate Fast and/or Free shipping. Up to four domestic shipping service options can be specified in one shipping business policy.

Each specified domestic shipping service is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use domesticShippingPolicyInfoService.

domesticShippingType ( token ) [0..1]
The domestic shipping cost model used by the seller. The only three valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping.

If 'FreightFlat' is specified as the domestic shipping type, the freightShipping container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API.

This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use domesticShippingType.

EligibleForPickupDropOff ( boolean ) [0..1]
This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large retail merchants on the eBay UK site (site ID 3).

In addition to setting the EligibleForPickupDropOff boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
  • Have inventory for the product at one or more physical stores tied to the merchant's account.
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the paymentInfo.immediatePay flag in the payment business policy and set its value to 'true';
    • Include only one paymentInfo.acceptedPaymentMethod field in the payment business policy and set its value to 'PayPal';
    • Include a valid PayPal payment address in the paymentInfo.paypalEmailAddress field.
When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.
See the Field Index to learn which calls use EligibleForPickupDropOff.

excludeShipToLocation ( token ) [0..*]
Sellers can use this field to exclude one or more international regions, countries, or special domestic locations (such as 'PO Box' in US or 'Packstation' in Germany) as possible shipping locations. To obtain valid 'exclude Ship-To locations', the seller must call GeteBayDetails, using ExcludeShipppingLocationDetails as a DetailName value in the request, and then scan the ExcludeShippingLocationDetails.Location values that are returned in the response. The seller may include as many valid excludeShipToLocation values as necessary based on where they are not willing to ship an item.

If a buyer's primary ship-to location is a location that the seller has listed as an excluded ship-to location, that buyer will receive an error message if they attempt to buy or place a bid on your item.

This field works in conjunction with the shipToLocation values to create a set of international regions, countries, and domestic locations to where the seller will (and will not) ship. You can list a region in the shipToLocation field, then exclude specific countries within that region with this field. For example, you can specify 'Africa' as a shipToLocation value, yet exclude Egypt by including an excludeShipToLocation field with its value set to 'EG', which is Egypt's two-digit country code. In addition, if a seller used only one shipToLocation value and set it to 'Worldwide', that seller can use one or more excludeShipToLocation fields to exclude one or more international regions, countries, or special domestic locations as possible shipping destinations.

Each excluded ship-to location is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use excludeShipToLocation.

freightShipping ( FreightShipping ) [0..1]
This container consists of details related to freight shipping. This container and its values are required to be set in a shipping policy if the seller offers freight shipping (domesticShippingType and/or intlShippingType is set to 'FreightFlat').

If freight shipping is specified for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use freightShipping.

GlobalShipping ( boolean ) [0..1]
This flag should be included and set to 'true' if the seller wants to enable the Global Shipping Program feature in the shipping policy. If the value of globalShipping is 'true', the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is 'false', the seller is responsible for specifying one or more international shipping services for the listing (if the seller wishes to ship internationally).

To make use of this field and the Global Shipping Program, the seller and the item being listed must be eligible for the Global Shipping Program.
See the Field Index to learn which calls use GlobalShipping.

insurance ( Insurance ) [0..1]
This container consists of the type and cost of domestic and international shipping insurance. The insurance container is required in the shipping policy if the seller offers shipping insurance to domestic and/or international buyers. Only sellers listing on the AU, FR, and IT sites can offer shipping insurance directly to the buyer.

If shipping insurance options are specified for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use insurance.

internationalPackagingHandlingCosts ( Amount (double) ) [0..1]
This field allows the seller to add package handling costs for shipping an item to an international location.

If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use internationalPackagingHandlingCosts.

intlRateTable ( token ) [0..1]
Note: International shipping rate tables are only available to sellers listing on the Germany and UK eBay sites.
This value indicates that the seller's international shipping rate table should be referenced to determine flat-rate shipping costs based on shipping service level and delivery location. Currently, the only valid value for intlRateTable is 'Default', which means that the default international shipping rate table set up by the seller in My eBay is referenced.

Including this field in an addSellerProfile or setSellerProfile call will only have an effect on flat shipping rates if an international shipping rate table is set up for the seller's account in My eBay, and it will only affect those international regions and countries for which flat shipping rates are defined.

If set for the shipping policy (Germany and UK only), this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use intlRateTable.

intlShippingPolicyInfoService ( ShippingPolicyInfoService ) [0..*]
Container that consists of detailed information for an international shipping service, including shipping costs and ship-to locations. Up to five international shipping service options can be specified in one shipping policy.

Each specified international shipping service is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use intlShippingPolicyInfoService.

intlShippingType ( token ) [0..1]
The international shipping cost model used by the seller. Valid values are 'Calculated', 'Flat', or 'FreightFlat'. If this field is not included and specified in an addSellerProfile or setSellerProfile call, it defaults to 'Flat' shipping.

If 'FreightFlat' is specified as the international shipping type, the freightShipping container and its values must be set in the shipping policy. If 'Calculated' is used as the shipping type, the CalculatedShippingRate container must be used when listing, revising, or relisting an item through the Trading API.

This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use intlShippingType.

packagingHandlingCosts ( Amount (double) ) [0..1]
This field allows the seller to add package handling costs for shipping an item to a domestic location.

If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use packagingHandlingCosts.

shippingOption ( token ) [0..1]
This optional field helps summarize the locations/regions that the seller will ship an item to. The integer value that is used in this field for an addSellerProfile or setSellerProfile call should be in synch with the values that are specified in the shipToLocation and excludeShipToLocation fields used in the same call.

The possible values are listed below:
  • 0 ('SiteOnly'): this value indicates that the seller only ships to domestic locations (relative to the listing site).
  • 1 ('SitePlusRegions'): this value indicates that the seller ships to domestic locations plus any international regions or countries specified as ship-to locations through the shipToLocation field.
  • 2 ('WorldWide'): this value indicates that the seller will ship to anywhere in the world except for any international regions or countries excluded with an excludeShipToLocation field.
  • 3 ('WillNotShip'): this value indicates that the seller does not offer shipping. This value is only applicable if 'Local Pickup' is being used, which might be the case if the item is a motor vehicle.
  • 4 ('TermsAndConditionsOnly'): this value is for future use.
If set for the shipping policy, this field is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use shippingOption.

shippingPolicyCurrency ( IsoCurrencyCode ) [1]
Three-digit code that indicates the currency used by the listing site. To obtain valid currency codes, the seller can call GeteBayDetails, using CurrencyDetails as a DetailName value in the request, and then scanning the CurrencyDetails.Currency values that are returned in the response.

If this field is not included in an addSellerProfile or setSellerProfile call, the currency code will default to the standard currency used by the listing site.

This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use shippingPolicyCurrency.

shippingPolicyIdentity ( ShippingPolicyIdentity ) [1]
Not used by any call.

This container is for future use.
See the Field Index to learn which calls use shippingPolicyIdentity.

shippingPolicyName ( string ) [1]
This string value indicates the name of the shipping policy. This business policy name must be unique among all of seller's shipping policies. A shippingPolicyName value is required when using the addSellerProfile and setSellerProfile calls to create or update a shipping policy.

This field is always returned with all shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use shippingPolicyName.

shippingProfileDiscountInfo ( ShippingProfileDiscountInfo ) [0..1]
Container consisting of flat-rate or calculated shipping discount profile IDs (that identify the shipping discount rules to apply when domestic and/or international buyers purchase multiple items), as well as flags indicating if promotional shipping discounts are offered to domestic and/or international buyers.

Shipping discounts can be created by the seller through My eBay, or by using the SetShippingDiscountProfiles call of the Trading API.

If shipping discounts are used for a shipping policy, this container is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use shippingProfileDiscountInfo.

shipToLocations ( token ) [0..*]
An international region (such as Asia, Europe, or Latin America) or country (represented by two-letter country code) to where the seller will ship an item.

It is not necessary to include the shipToLocation field in the domesticShippingPolicyInfoService container when using the addSellerProfile and setSellerProfile calls. However, eBay automatically adds the seller's listing county as a 'Ship-To Location', and the shipToLocation field is always returned for each shipping policy in the addSellerProfile, setSellerProfile, and getSellerProfiles calls.

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 offer shipping to one or more specific shipping regions, the seller must include that shipping region in a shipToLocation field. 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 use one or more instances of the shippingPolicyInfo.excludeShipToLocation field.

Applicable shipping region values are defined in ShippingRegionCodeType and applicable country codes are defined in CountryCodeType. However, it is best practice for sellers to call GeteBayDetails, using ShipppingLocationDetails as a DetailName value in the request, and then scanning the ShippingLocationDetails.ShippingLocation values that are returned in the response.

Each specified ship-to location is returned with shipping policies returned in the getSellerProfiles, addSellerProfile, or setSellerProfile calls.
See the Field Index to learn which calls use shipToLocations.