createFulfillmentPolicy

This container is used to specify whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.

Occurrence: Required

Note: This field has been deprecated and is no longer used.

• Do not include this field in any create or update method.
• This field may be returned within the payload of a get method, but it can be ignored.

Occurrence: Optional

The category type to which the policy applies (motor vehicles or non-motor vehicles).

Note: The MOTORS_VEHICLES category type is not valid for return policies. eBay flows do not support the return of motor vehicles.

Occurrence: Required

A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250

Occurrence: Optional

This field is included and set to true if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.

Default: false

Occurrence: Optional

Note: This field is only applicable for the eBay United Kingdom marketplace (EBAY_GB).
This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.

A seller can use a combination of the Global Shipping Program and other international shipping services.

If set to false or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in Setting up worldwide shipping.

Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.

eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.

Default: false

Occurrence: Optional

This container is used to specify 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 with DetailName set to DispatchTimeMaxDetails, then inspect the DispatchTimeMaxDetails container in the response for the time values supported by the site (typical handling times are 0, 1, 2, 3, 4, 5, 10, 15, and 20, but these can vary by site and may change over time.)

This field is conditionally required when the seller is offering one or more domestic or international shipping options, but it is not applicable when the item is only available through local pickup ("localPickup": "true"), or if it will be shipped through a freight shipping service ("freightShipping": "true").

Occurrence: Conditional

These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.

See TimeDurationUnitEnum for a complete list of possible time-measurement units.

Occurrence: Conditional

An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.

Occurrence: Conditional

This field should be included and set to true if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer.

With local pickup, the buyer and seller make arrangements for pickup time and location.

Default: false

Occurrence: Optional

The ID of the eBay marketplace to which this fulfillment policy applies.

Occurrence: Required

A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

Occurrence: Required

This field should be included and set to true if the seller offers the "Click and Collect" feature for an item.

To enable "Click and Collect" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU, UK, DE, FR, and IT marketplaces.

In addition to setting this field to true, the merchant must also do the following 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.

  Sellers can use the createInventoryLocation method in the Inventory API to associate physical stores to their account and they can then add inventory to specific store locations.

• 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'.
  • Have a valid store location with a complete street address.

When a merchant successfully lists 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.

Occurrence: Optional

This array is used to provide detailed information on the domestic and international shipping options available for the policy.

A separate ShippingOption object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations).

• The optionType field is used to indicate whether the ShippingOption object applies to domestic or international shipping, and the costType field is used to indicate whether flat-rate shipping or calculated shipping will be used.
• The rateTableId field can be used to associate a defined shipping rate table to the policy, and the packageHandlingCost container can be used to set a handling charge for the policy.

A separate ShippingServices object will be used to specify cost and other details for every available domestic and international shipping service option.

Occurrence: Conditional

This field defines whether the shipping cost model is FLAT_RATE (the same rate for all buyers, or buyers within a region if shipping rate tables are used) or CALCULATED (the shipping rate varies by the ship-to location and size and weight of the package).

This field is conditionally required if any shipping service options are specified (domestic and/or international).

Occurrence: Conditional

This field has been deprecated.

Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies.

Occurrence: Optional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

The monetary amount in the specified currency.

Occurrence: Conditional

This field has been deprecated.

Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies.

Occurrence: Optional

This field is used to indicate if the corresponding shipping service options (under shippingServices array) are domestic or international shipping service options. This field is conditionally required if any shipping service options are specified (domestic and/or international).

Occurrence: Conditional

This container is used if the seller adds handling charges to domestic and/or international shipments.

Sellers can not specify any domestic handling charges if they offered 'free shipping' in the policy.

This container will only be returned if set for the policy.

Occurrence: Optional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

The monetary amount in the specified currency.

Occurrence: Conditional

This field is used if the seller wants to associate a domestic or international shipping rate table to the fulfillment business policy. The getRateTables method can be used to retrieve shipping rate table IDs.

With domestic and international shipping rate tables, the seller can set different shipping costs based on shipping regions and shipping speed/level of service (one-day, expedited, standard, economy). There are also options to add additional per-weight and handling charges.

Sellers need to be careful that shipping rate tables match the corresponding shipping service options. In other words, a domestic shipping rate table must not be specified in the same container where international shipping service options are being specified, and vice versa, and the shipping speed/level of service of the provided shipping service options should match the shipping speed/level of service options that are defined in the shipping rate tables.

For example, if the corresponding shipping rate table defines costs for one-day shipping services, there should be at least one one-day shipping service option specified under the shippingServices array.

This field is returned if set.

Occurrence: Optional

This field is the unique identifier of a seller's domestic or international shipping discount profile. If a buyer satisfies the requirements of the discount rule, this buyer will receive a shipping discount for the order.

The seller can create and manage shipping discount profiles using (Get/Set) ShippingDiscountProfiles calls in the Trading API or through the Shipping Preferences in My eBay.

Occurrence: Optional

This boolean indicates whether or not the seller has set up a promotional shipping discount that will be available to buyers who satisfy the requirements of the shipping discount rule.

The seller can create and manage shipping promotional discounts using (Get/Set) ShippingDiscountProfiles calls in the Trading API or through the Shipping Preferences in My eBay.

Occurrence: Optional

This array consists of the domestic or international shipping services options that are defined for the policy. The shipping service options defined under this array should match what is set in the corresponding shippingOptions.optionType field (which controls whether domestic or international shipping service options are being defined). If a shipping rate table is being used, the specified shipping service options should also match the shipping rate table settings (domestic or international, shipping speed/level of service, etc.)

Sellers can specify up to four domestic shipping services and up to five international shipping service options by using separate shippingService containers for each. If the seller is using the Global Shipping Program as an international option, only a total of four international shipping service options (including GSP) can be offered.

See How to set up shipping carrier and shipping service values.

To use the eBay standard envelope service (eSE), see Using eBay standard envelope (eSE) service.

This array is conditionally required if the seller is offering one or more domestic and/or international shipping service options.

Occurrence: Conditional

This container is used by the seller to cover the use case when a single buyer purchases multiple quantities of the same line item. This cost cannot exceed the corresponding shippingCost value. A seller will generally set this field when he/she wants to pass on a shipping discount to the buyer if that buyer purchases multiple quantities of a line item.

The seller can ship multiple quantities of the line item in the same package and pass on the shipping savings to the buyer.

If this field is not set, and a buyer purchases multiple quantities of an item, the seller can technically charge the same cost set in the shippingCost container for each individual item, but in general, it behooves both the seller and the buyer (and saves both parties money) if they discuss combined shipping.

This field is not applicable to auction listings or single-quantity, fixed-price listings.

This container is returned if set.

Occurrence: Optional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

The monetary amount in the specified currency.

Occurrence: Conditional

This field should be included and set to true for a motor vehicle listing if it will be the buyer's responsibility to pick up the purchased motor vehicle after full payment is made.

This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle.

This field is returned if set.

Default: false

Occurrence: Optional

This field should be included and set to true for a motor vehicle listing if it will be the buyer's responsibility to arrange for shipment of a motor vehicle.

This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle.

This field is returned if set.

Default: false

Occurrence: Optional

This field is included and set to true if the seller offers a free domestic shipping option to the buyer.

This field can only be included and set to true for the first domestic shipping service option specified in the shippingServices array (it is ignored if set for subsequent shipping services or for any international shipping service option).

The first specified shipping service option has a sortOrder value of 1 or if the sortOrderId field is not used, it is the shipping service option that's specified first in the shippingServices array.

This container is returned if set.

Occurrence: Optional

This field sets/indicates the shipping carrier, such as USPS, FedEx, or UPS. Although this field uses the string type, the seller must pass in a pre-defined enumeration value here.

For a full list of shipping carrier enum values for a specified eBay marketplace, the GeteBayDetails call of the Trading API can be used, and the DetailName field's value should be set to ShippingCarrierDetails. The enum values for each shipping carriers can be found in each ShippingCarrierDetails.ShippingCarrier field in the response payload.

This field is actually optional, as the shipping carrier is also tied into the shippingServiceCode enum value, and that field is required for every specified shipping service option.

This field is returned if set.

Occurrence: Optional

This container is used to set the shipping cost to ship one item using the corresponding shipping service option. This container is conditionally required if the seller is using flat-rate shipping and is not using a domestic or international shipping rate table.

This container is not necessary for calculated shipping, since eBay will calculate the shipping cost and display it in the View Item page based off of the potential buyer's ship-to location.

This value is automatically set to 0.0 for the first specified domestic shipping service option and if the corresponding freeShipping field is set to true.

This container is returned if set for the policy.

Occurrence: Conditional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

The monetary amount in the specified currency.

Occurrence: Conditional

This field sets/indicates the domestic or international shipping service option, such as USPSPriority, FedEx2Day, or UPS3rdDay. Although this field uses the string type, the seller must pass in a pre-defined enumeration value here.

For a full list of shipping service option enum values for a specified eBay marketplace, the GeteBayDetails call of the Trading API can be used, and the DetailName field's value should be set to ShippingServiceDetails.

The enum values for each shipping service option can be found in each ShippingServiceDetails.ShippingService field in the response payload. The seller must make sure that the shipping service option is still valid, which is indicated by a true value in the corresponding ValidForSellingFlow boolean field. International shipping service options are typically returned at the top of the response payload, and are indicated by an InternationalService boolean field that reads true.

The InternationalService boolean field is not returned at all for domestic shipping service options.

This field is required for every specified shipping service option.

Occurrence: Conditional

This container is used to set the ship-to locations applicable to the corresponding shipping service option. Although the regionExcluded container is defined for RegionSet type and could technically be used here, it is recommened that only the regionIncluded container be used at the shipping service level. The excluded shipping regions (if any) can instead be set up in the top-level regionExcluded container.

The regionIncluded and regionExcluded containers define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy.

To retrieve the valid geographical shipping region values, two-digit country values, or special domestic regions for an eBay marketplace, call GeteBayDetails with DetailName value set to ExcludeShippingLocationDetails, then review the ExcludeShippingLocationDetails containers in the response for the strings you use in the regionIncluded.regionName field.

• For valid geographical region names, look for the ExcludeShippingLocationDetails containers in the GeteBayDetails response where the Region value is Worldwide, and the valid values will be shown in the corresponding Location fields.
• For valid two-digit country codes, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is one of the defined geographical regions, and the valid values will be shown in the corresponding Location fields. Alternatively, you can find the two-digit country code values in the CountryCodeEnum type definition.
• For valid domestic region values, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is either Domestic Location or Additional Locations, and the valid values will be shown in the corresponding Location fields.

Occurrence: Optional

An array of one or more regionName values that specify the areas to where a seller does not ship. A regionExcluded list should only be set in the top-level shipToLocations container and not within the shippingServices.shipToLocations container used to specify which shipping regions are serviced by each available shipping service option.

Many sellers are willing to ship to many international locations, but they may want to exclude some world regions or some countries as places they are willing to ship to.

This array will be returned as empty if no shipping regions are excluded with the fulfillment business policy.

Note: The regionExcluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.

Occurrence: Optional

A string that indicates the name of a region, as defined by eBay. A "region" can be either a 'world region' (e.g., the "Middle East" or "Southeast Asia"), a country (represented with a two-letter country code), a state or province (represented with a two-letter code), or a special domestic region within a country.

The GeteBayDetails call in the Trading API can be used to retrieve the world regions and special domestic regions within a specific country. To get these enumeration values, call GeteBayDetails with the DetailName value set to ExcludeShippingLocationDetails.

Occurrence: Optional

Reserved for future use.

Occurrence: Optional

An array of one or more regionName fields that specify the areas to where a seller ships.
Each eBay marketplace supports its own set of allowable shipping locations.

Note: The regionIncluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.

Occurrence: Conditional

A string that indicates the name of a region, as defined by eBay. A "region" can be either a 'world region' (e.g., the "Middle East" or "Southeast Asia"), a country (represented with a two-letter country code), a state or province (represented with a two-letter code), or a special domestic region within a country.

The GeteBayDetails call in the Trading API can be used to retrieve the world regions and special domestic regions within a specific country. To get these enumeration values, call GeteBayDetails with the DetailName value set to ExcludeShippingLocationDetails.

Occurrence: Optional

Reserved for future use.

Occurrence: Optional

The integer value set in this field controls the order of the corresponding domestic or international shipping service option in the View Item and Checkout pages.

If the sortOrder field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call.

Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service).

Occurrence: Optional

Note: DO NOT USE THIS FIELD. Shipping surcharges for domestic shipping service options can no longer be set with fulfillment business policies, except through shipping rate tables.

To do this, a seller would set up a surcharge-based shipping rate table and specify the surcharge in that table. Then, the seller would need to associate this shipping rate table to the fulfillment business policy by specifying the unique ID of the shipping rate table through the shippingOptions.rateTableId field. Shipping surcharges cannot be applied at all to international shipping service options.

Occurrence: Optional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

The monetary amount in the specified currency.

Occurrence: Conditional

This container consists of the regionIncluded and regionExcluded arrays, which are used to define the geographical regions/countries/states or provinces/domestic regions that a seller does and does not ship to for the associated fulfillment policy. Note that this container can be considered the master list of where the seller ships and does not ship, but there is also a shipToLocations container that can be set at the shipping service option level.

Note: Any shipping exclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program.
To retrieve the valid geographical shipping region values, two-digit country values, or special domestic regions for an eBay marketplace, call GeteBayDetails with DetailName value set to ExcludeShippingLocationDetails, then review the ExcludeShippingLocationDetails containers in the response for the strings you use in both the regionIncluded.regionName and in the regionExcluded.regionName fields.

For valid geographical region names, look for the ExcludeShippingLocationDetails containers in the GeteBayDetails response where the Region value is Worldwide, and the valid values will be shown in the corresponding Location fields.

For valid two-digit country codes, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is one of the defined geographical regions, and the valid values will be shown in the corresponding Location fields. Alternatively, you can find the two-digit country code values in the CountryCodeEnum type definition. For valid domestic region values, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is either Domestic Location or Additional Locations, and the valid values will be shown in the corresponding Location fields.

The STATE_OR_PROVINCE region type is only applicable to the US and Canada, and valid values for US states are the same two-digit abbreviations used by the United States Postal Service, and valid values for Canadian provinces and territories are the same two-digit abbreviations used by the Canada Post.

Occurrence: Optional

An array of one or more regionName values that specify the areas to where a seller does not ship. A regionExcluded list should only be set in the top-level shipToLocations container and not within the shippingServices.shipToLocations container used to specify which shipping regions are serviced by each available shipping service option.

Many sellers are willing to ship to many international locations, but they may want to exclude some world regions or some countries as places they are willing to ship to.

This array will be returned as empty if no shipping regions are excluded with the fulfillment business policy.

Note: The regionExcluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.

Occurrence: Optional

A string that indicates the name of a region, as defined by eBay. A "region" can be either a 'world region' (e.g., the "Middle East" or "Southeast Asia"), a country (represented with a two-letter country code), a state or province (represented with a two-letter code), or a special domestic region within a country.

The GeteBayDetails call in the Trading API can be used to retrieve the world regions and special domestic regions within a specific country. To get these enumeration values, call GeteBayDetails with the DetailName value set to ExcludeShippingLocationDetails.

Occurrence: Optional

Reserved for future use.

Occurrence: Optional

An array of one or more regionName fields that specify the areas to where a seller ships.
Each eBay marketplace supports its own set of allowable shipping locations.

Note: The regionIncluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.

Occurrence: Conditional

A string that indicates the name of a region, as defined by eBay. A "region" can be either a 'world region' (e.g., the "Middle East" or "Southeast Asia"), a country (represented with a two-letter country code), a state or province (represented with a two-letter code), or a special domestic region within a country.

The GeteBayDetails call in the Trading API can be used to retrieve the world regions and special domestic regions within a specific country. To get these enumeration values, call GeteBayDetails with the DetailName value set to ExcludeShippingLocationDetails.

Occurrence: Optional

Reserved for future use.

Occurrence: Optional