This doc page has moved! You should be automatically redirected to the resources page for the eBay Account API. If you are not redirected automatically, follow this link to the Account API.

eBay Account APIVersion 1.2.0

FulfillmentPolicyRequest

Request container for the fulfillment policy payload.

Calls that use FulfillmentPolicyRequest:

Fields



categoryTypes ( array of CategoryType ) [0..?]
The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. (Currently, each policy can be set to only one categoryTypes value at a time.)
See the Field Index to learn which calls use categoryTypes.

description ( string ) [0..?]
An optional seller-defined description of the fulfillment policy.

Max length: 250
See the Field Index to learn which calls use description.

freightShipping ( boolean ) [0..?]
Set this value to true to indicate the seller offers freight shipping.
Default: false
See the Field Index to learn which calls use freightShipping.

globalShipping ( boolean ) [0..?]
If this value is set to true, it indicates the seller has opted-in to the Global Shipping Program, which automatically sets the international shipping service to International Priority Shipping.

If this value is set to false, the seller is responsible for manually specifying the international shipping services if they indicate they ship internationally.

Opt-in to the Global Shipping Program, log in to eBay and navigate to My Account > Site Preferences > Shipping preferences.

Default: false
See the Field Index to learn which calls use globalShipping.

handlingTime ( TimeDuration ) [0..?]
Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order.

Valid values can vary by site and by category. To obtain the supported values for a site, call GeteBayDetails in the Trading API; set DetailName to 'DispatchTimeMaxDetails' in the request, and inspect the DispatchTimeMaxDetails container in the response for the time values supported by 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 pages. To offer zero-day or one-day handling, set field to '0' or '1', respectively. If you don't want to specify a handling time in the fulfillment policy, omit the handlingTimeMax field or set it to null.

Min: 0 Max: 30
See the Field Index to learn which calls use handlingTime.

localPickup ( boolean ) [0..?]
Set this value to true to indicate the seller offers local pickup of their items.
Default: false
See the Field Index to learn which calls use localPickup.

marketplaceId ( MarketplaceIdEnum ) [0..?]
The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller's eBay registration site.
See the Field Index to learn which calls use marketplaceId.

name ( string ) [0..?]
A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64
See the Field Index to learn which calls use name.

pickupDropOff ( boolean ) [0..?]
Set this value to true to indicate the seller offers the "Click and Collect" feature to be used with Add/Revise/Relist calls.

To enable "Click and Collect", a seller must (1) be eligible for the "Click and Collect" feature, and (2) set this boolean field to 'true'. Currently, the "Click and Collect" feature is available only to large retail merchants on the eBay AU and UK marketplaces.

In addition to setting this field, 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:
    • Set the immediatePay flag in the payment policy to 'true'.
    • Include only one paymentMethods field in the payment policy, and set its value to PAYPAL.
    • Include a valid PayPal contact in the recipientAccountReference.referenceId field of the payment policy.
When a UK merchant is successful at listing an item with "Click and Collect", 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.
Default: false
See the Field Index to learn which calls use pickupDropOff.

shippingOptions ( array of ShippingOption ) [0..?]
A list of default shipping options supported by the seller. Shipping options can include the type of shipping, the shipping and handling costs, and any applicable insurance information. Use the optionType field to set up either domestic or international shipping options.
See the Field Index to learn which calls use shippingOptions.

shipToLocations ( RegionSet ) [0..?]
The geographical region(s) to which the seller ships.
It is not necessary to include the shipToLocations field; eBay automatically adds the seller's listing country as a 'Ship-To Location', and the field is always returned in the shipping policy response.
If the seller wants to offer international shipping as part of the shipping policy, you must supply at least one region in shipToLocation field that is outside the seller's listing country. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'WORLDWIDE' as a shipToLocation value.
See the Field Index to learn which calls use shipToLocations.