createFulfillmentPolicy: eBay Account API

POST/fulfillment_policy/

This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers.

Each policy targets a specific eBay marketplace and a category group type, and you can create multiple policies for each combination.

A successful request returns the getFulfillmentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.

Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.

Using the eBay standard envelope service (eSE)

The eBay standard envelope service (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards, and to coins & paper money, postcards, stamps, patches, and similar eligible categories, and is only available on the US marketplace. To use this service, send envelopes using the USPS mail and set the shippingServiceCode field to US_eBayStandardEnvelope. See Using eBay standard envelope (eSE) service for details. See eBay standard envelope for additional details, restrictions, and an envelope size template.

Input

Resource URI

POST https://api.ebay.com/sell/account/v1/fulfillment_policy/

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header	Type	Description
Content-Type	string	This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required

Header

Type

Description

Content-Type

string

This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.account

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

{ /* FulfillmentPolicyRequest */

"categoryTypes" : [

{ /* CategoryType */

"default" : "boolean",

"name" : "CategoryTypeEnum : [MOTORS_VEHICLES,ALL_EXCLUDING_MOTORS_VEHICLES]"

}

"description" : "string",

"freightShipping" : "boolean",

"globalShipping" : "boolean",

"handlingTime" :

{ /* TimeDuration */

"unit" : "TimeDurationUnitEnum : [YEAR,MONTH,DAY...]",

"value" : "integer"

"localPickup" : "boolean",

"marketplaceId" : "MarketplaceIdEnum : [EBAY_AT,EBAY_AU,EBAY_BE...]",

"name" : "string",

"pickupDropOff" : "boolean",

"shippingOptions" : [

{ /* ShippingOption */

"costType" : "ShippingCostTypeEnum : [CALCULATED,FLAT_RATE,NOT_SPECIFIED]",

"insuranceFee" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"insuranceOffered" : "boolean",

"optionType" : "ShippingOptionTypeEnum : [DOMESTIC,INTERNATIONAL]",

"packageHandlingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"rateTableId" : "string",

"shippingDiscountProfileId" : "string",

"shippingPromotionOffered" : "boolean",

"shippingServices" : [

{ /* ShippingService */

"additionalShippingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"buyerResponsibleForPickup" : "boolean",

"buyerResponsibleForShipping" : "boolean",

"freeShipping" : "boolean",

"shippingCarrierCode" : "string",

"shippingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"shippingServiceCode" : "string",

"shipToLocations" :

{ /* RegionSet */

"regionExcluded" : [

{ /* Region */

"regionName" : "string",

"regionType" : "RegionTypeEnum : [COUNTRY,COUNTRY_REGION,STATE_OR_PROVINCE...]"

}

"regionIncluded" : [

{ /* Region */

"regionName" : "string",

"regionType" : "RegionTypeEnum : [COUNTRY,COUNTRY_REGION,STATE_OR_PROVINCE...]"

}

]

"sortOrder" : "integer",

"surcharge" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

}

]

}

"shipToLocations" :

{ /* RegionSet */

"regionExcluded" : [

{ /* Region */

"regionName" : "string",

"regionType" : "RegionTypeEnum : [COUNTRY,COUNTRY_REGION,STATE_OR_PROVINCE...]"

}

"regionIncluded" : [

{ /* Region */

"regionName" : "string",

"regionType" : "RegionTypeEnum : [COUNTRY,COUNTRY_REGION,STATE_OR_PROVINCE...]"

}

]

}

Request fields

Input container/field	Type	Description
categoryTypes	array of CategoryType	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
categoryTypes.default	boolean	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
categoryTypes.name	CategoryTypeEnum	The category type to which the policy applies (motor vehicles or non-motor vehicles). The `MOTORS_VEHICLES` category type is not valid for return policies. eBay flows do not support the return of motor vehicles. Occurrence: Required
description	string	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
freightShipping	boolean	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
globalShipping	boolean	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. It is possible for a seller to use a combination of the Global Shipping Program and other international shipping services. If this value is set to `false` or if the field is omitted, the seller is responsible for manually specifying individual international shipping services (if the seller ships internationally)., as described in Setting up worldwide shipping. Sellers can opt in or out of the Global Shipping Program through the Shipping preferences in My eBay. Note: On the US marketplace, the Global Shipping Program is scheduled to be replaced by a new intermediated international shipping program called eBay International Shipping. US sellers who are opted in to the Global Shipping Program will be automatically opted in to eBay International Shipping when it becomes available to them. All US sellers will be migrated by March 31, 2023. eBay International Shipping is an account level setting, and no field needs to be set in a Fulfillment business policy to enable it. As long as the 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
handlingTime	TimeDuration	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"`). Note: 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. Occurrence: Conditional
handlingTime.unit	TimeDurationUnitEnum	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
handlingTime.value	integer	An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field. Occurrence: Conditional
localPickup	boolean	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
marketplaceId	MarketplaceIdEnum	The ID of the eBay marketplace to which this fulfillment policy applies. Occurrence: Required
name	string	A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64 Occurrence: Required
pickupDropOff	boolean	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 and UK 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 can 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. Default: false Occurrence: Optional
shippingOptions	array of ShippingOption	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
shippingOptions.costType	ShippingCostTypeEnum	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
shippingOptions.insuranceFee	Amount	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
shippingOptions.insuranceFee.currency	CurrencyCodeEnum	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
shippingOptions.insuranceFee.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shippingOptions.insuranceOffered	boolean	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
shippingOptions.optionType	ShippingOptionTypeEnum	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
shippingOptions.packageHandlingCost	Amount	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
shippingOptions.packageHandlingCost.currency	CurrencyCodeEnum	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
shippingOptions.packageHandlingCost.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shippingOptions.rateTableId	string	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 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
shippingOptions.shippingDiscountProfileId	string	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
shippingOptions.shippingPromotionOffered	boolean	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
shippingOptions.shippingServices	array of ShippingService	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
shippingOptions.shippingServices.additionalShippingCost	Amount	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
shippingOptions.shippingServices.additionalShippingCost.currency	CurrencyCodeEnum	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
shippingOptions.shippingServices.additionalShippingCost.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shippingOptions.shippingServices.buyerResponsibleForPickup	boolean	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
shippingOptions.shippingServices.buyerResponsibleForShipping	boolean	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 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
shippingOptions.shippingServices.freeShipping	boolean	This field is included and set to `true` if the seller offers a free 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 container (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 container. This container is returned if set. Occurrence: Optional
shippingOptions.shippingServices.shippingCarrierCode	string	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
shippingOptions.shippingServices.shippingCost	Amount	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
shippingOptions.shippingServices.shippingCost.currency	CurrencyCodeEnum	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
shippingOptions.shippingServices.shippingCost.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shippingOptions.shippingServices.shippingServiceCode	string	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. This field is returned if set. Occurrence: Conditional
shippingOptions.shippingServices.shipToLocations	RegionSet	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. 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
shippingOptions.shippingServices.shipToLocations.regionExcluded	array of Region	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
shippingOptions.shippingServices.shipToLocations.regionExcluded.regionName	string	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
shippingOptions.shippingServices.shipToLocations.regionExcluded.regionType	RegionTypeEnum	Reserved for future use. Occurrence: Optional
shippingOptions.shippingServices.shipToLocations.regionIncluded	array of Region	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
shippingOptions.shippingServices.shipToLocations.regionIncluded.regionName	string	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
shippingOptions.shippingServices.shipToLocations.regionIncluded.regionType	RegionTypeEnum	Reserved for future use. Occurrence: Optional
shippingOptions.shippingServices.sortOrder	integer	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. Sellers can specify up to four domestic shipping services (in four separate shippingService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrder value of `1` appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrder value of `1` appears at the bottom of the list. Sellers can specify up to five international shipping services (in five separate shippingService containers), so valid values for international shipping services are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrder value of a international shipping service option controls the placement of that 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
shippingOptions.shippingServices.surcharge	Amount	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
shippingOptions.shippingServices.surcharge.currency	CurrencyCodeEnum	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
shippingOptions.shippingServices.surcharge.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shipToLocations	RegionSet	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
shipToLocations.regionExcluded	array of Region	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
shipToLocations.regionExcluded.regionName	string	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
shipToLocations.regionExcluded.regionType	RegionTypeEnum	Reserved for future use. Occurrence: Optional
shipToLocations.regionIncluded	array of Region	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
shipToLocations.regionIncluded.regionName	string	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
shipToLocations.regionIncluded.regionType	RegionTypeEnum	Reserved for future use. Occurrence: Optional

Output

HTTP response headers

See HTTP response headers for details.

Header	Meaning
Location	The location response header contains the URL to the newly created fulfillment policy. The URL includes the eBay-assigned `fulfillmentPolicyId`, which you can use to reference the policy.

Response payload

Copy complete valid JSON to clipboard

{ /* SetFulfillmentPolicyResponse */

"categoryTypes" : [

{ /* CategoryType */

"default" : "boolean",

"name" : "CategoryTypeEnum : [MOTORS_VEHICLES,ALL_EXCLUDING_MOTORS_VEHICLES]"

}

"description" : "string",

"freightShipping" : "boolean",

"fulfillmentPolicyId" : "string",

"globalShipping" : "boolean",

"handlingTime" :

{ /* TimeDuration */

"unit" : "TimeDurationUnitEnum : [YEAR,MONTH,DAY...]",

"value" : "integer"

"localPickup" : "boolean",

"marketplaceId" : "MarketplaceIdEnum : [EBAY_AT,EBAY_AU,EBAY_BE...]",

"name" : "string",

"pickupDropOff" : "boolean",

"shippingOptions" : [

{ /* ShippingOption */

"costType" : "ShippingCostTypeEnum : [CALCULATED,FLAT_RATE,NOT_SPECIFIED]",

"insuranceFee" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"insuranceOffered" : "boolean",

"optionType" : "ShippingOptionTypeEnum : [DOMESTIC,INTERNATIONAL]",

"packageHandlingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"rateTableId" : "string",

"shippingDiscountProfileId" : "string",

"shippingPromotionOffered" : "boolean",

"shippingServices" : [

{ /* ShippingService */

"additionalShippingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"buyerResponsibleForPickup" : "boolean",

"buyerResponsibleForShipping" : "boolean",

"freeShipping" : "boolean",

"shippingCarrierCode" : "string",

"shippingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"shippingServiceCode" : "string",

"shipToLocations" :

{ /* RegionSet */

"regionExcluded" : [

{ /* Region */

"regionName" : "string",

"regionType" : "RegionTypeEnum : [COUNTRY,COUNTRY_REGION,STATE_OR_PROVINCE...]"

}

"regionIncluded" : [

{ /* Region */

"regionName" : "string",

"regionType" : "RegionTypeEnum : [COUNTRY,COUNTRY_REGION,STATE_OR_PROVINCE...]"

}

]

"sortOrder" : "integer",

"surcharge" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

}

]

}

"shipToLocations" :

{ /* RegionSet */

"regionExcluded" : [

{ /* Region */

"regionName" : "string",

"regionType" : "RegionTypeEnum : [COUNTRY,COUNTRY_REGION,STATE_OR_PROVINCE...]"

}

"regionIncluded" : [

{ /* Region */

"regionName" : "string",

"regionType" : "RegionTypeEnum : [COUNTRY,COUNTRY_REGION,STATE_OR_PROVINCE...]"

}

]

"warnings" : [

{ /* ErrorDetailV3 */

"category" : "string",

"domain" : "string",

"errorId" : "integer",

"inputRefIds" : [

"string"

"longMessage" : "string",

"message" : "string",

"outputRefIds" : [

"string"

"parameters" : [

{ /* ErrorParameterV3 */

"name" : "string",

"value" : "string"

}

"subdomain" : "string"

}

]

}

Response fields

Output container/field	Type	Description
categoryTypes	array of CategoryType	This container indicates whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. Occurrence: Always
categoryTypes.default	boolean	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: Conditional
categoryTypes.name	CategoryTypeEnum	The category type to which the policy applies (motor vehicles or non-motor vehicles). The `MOTORS_VEHICLES` category type is not valid for return policies. eBay flows do not support the return of motor vehicles. Occurrence: Always
description	string	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. This field is returned if set for the policy. Max length: 250 Occurrence: Conditional
freightShipping	boolean	If returned as `true`, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. Occurrence: Always
fulfillmentPolicyId	string	A unique eBay-assigned ID for a fulfillment business policy. This ID is generated when the policy is created. Occurrence: Always
globalShipping	boolean	If returned as `true`, the eBay Global Shipping Program will be used by the seller to ship items to international locations. Note: On the US marketplace, the Global Shipping Program is scheduled to be replaced by a new intermediated international shipping program called eBay International Shipping. US sellers who are opted in to the Global Shipping Program will be automatically opted in to eBay International Shipping when it becomes available to them. All US sellers will be migrated by March 31, 2023. eBay International Shipping is an account level setting, and no field needs to be set in a Fulfillment business policy to enable it. As long as the 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. Occurrence: Always
handlingTime	TimeDuration	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. If only local pickup or freight shipping is available for the item, this container may not get returned. Occurrence: Conditional
handlingTime.unit	TimeDurationUnitEnum	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
handlingTime.value	integer	An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field. Occurrence: Conditional
localPickup	boolean	If returned as `true`, local pickup is available for this policy. Occurrence: Always
marketplaceId	MarketplaceIdEnum	The ID of the eBay marketplace to which this fulfillment business policy applies. Occurrence: Always
name	string	A seller-defined name for this fulfillment business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64 Occurrence: Always
pickupDropOff	boolean	If returned as `true`, the seller offers the "Click and Collect" option. Currently, "Click and Collect" is available only to large retail merchants the eBay AU and UK marketplaces. Occurrence: Always
shippingOptions	array of ShippingOption	This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations). The optionType field indicates whether the ShippingOption object applies to domestic or international shipping, and the costType field indicates whether flat-rate shipping or calculated shipping will be used. A separate ShippingServices object is used to specify cost and other details for every available domestic and international shipping service option. Occurrence: Conditional
shippingOptions.costType	ShippingCostTypeEnum	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
shippingOptions.insuranceFee	Amount	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: Conditional
shippingOptions.insuranceFee.currency	CurrencyCodeEnum	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
shippingOptions.insuranceFee.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shippingOptions.insuranceOffered	boolean	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: Conditional
shippingOptions.optionType	ShippingOptionTypeEnum	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
shippingOptions.packageHandlingCost	Amount	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: Conditional
shippingOptions.packageHandlingCost.currency	CurrencyCodeEnum	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
shippingOptions.packageHandlingCost.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shippingOptions.rateTableId	string	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 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: Conditional
shippingOptions.shippingDiscountProfileId	string	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: Conditional
shippingOptions.shippingPromotionOffered	boolean	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: Conditional
shippingOptions.shippingServices	array of ShippingService	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
shippingOptions.shippingServices.additionalShippingCost	Amount	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: Conditional
shippingOptions.shippingServices.additionalShippingCost.currency	CurrencyCodeEnum	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
shippingOptions.shippingServices.additionalShippingCost.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shippingOptions.shippingServices.buyerResponsibleForPickup	boolean	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: Conditional
shippingOptions.shippingServices.buyerResponsibleForShipping	boolean	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 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: Conditional
shippingOptions.shippingServices.freeShipping	boolean	This field is included and set to `true` if the seller offers a free 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 container (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 container. This container is returned if set. Occurrence: Conditional
shippingOptions.shippingServices.shippingCarrierCode	string	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: Conditional
shippingOptions.shippingServices.shippingCost	Amount	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
shippingOptions.shippingServices.shippingCost.currency	CurrencyCodeEnum	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
shippingOptions.shippingServices.shippingCost.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shippingOptions.shippingServices.shippingServiceCode	string	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. This field is returned if set. Occurrence: Conditional
shippingOptions.shippingServices.shipToLocations	RegionSet	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. 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: Conditional
shippingOptions.shippingServices.shipToLocations.regionExcluded	array of Region	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: Always
shippingOptions.shippingServices.shipToLocations.regionExcluded.regionName	string	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: Conditional
shippingOptions.shippingServices.shipToLocations.regionExcluded.regionType	RegionTypeEnum	Reserved for future use. Occurrence: Conditional
shippingOptions.shippingServices.shipToLocations.regionIncluded	array of Region	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: Always
shippingOptions.shippingServices.shipToLocations.regionIncluded.regionName	string	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: Conditional
shippingOptions.shippingServices.shipToLocations.regionIncluded.regionType	RegionTypeEnum	Reserved for future use. Occurrence: Conditional
shippingOptions.shippingServices.sortOrder	integer	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. Sellers can specify up to four domestic shipping services (in four separate shippingService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrder value of `1` appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrder value of `1` appears at the bottom of the list. Sellers can specify up to five international shipping services (in five separate shippingService containers), so valid values for international shipping services are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrder value of a international shipping service option controls the placement of that 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: Conditional
shippingOptions.shippingServices.surcharge	Amount	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: Conditional
shippingOptions.shippingServices.surcharge.currency	CurrencyCodeEnum	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
shippingOptions.shippingServices.surcharge.value	string	The monetary amount in the specified currency. Occurrence: Conditional
shipToLocations	RegionSet	This container consists of the regionIncluded and regionExcluded containers, which define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy. Occurrence: Always
shipToLocations.regionExcluded	array of Region	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: Always
shipToLocations.regionExcluded.regionName	string	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: Conditional
shipToLocations.regionExcluded.regionType	RegionTypeEnum	Reserved for future use. Occurrence: Conditional
shipToLocations.regionIncluded	array of Region	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: Always
shipToLocations.regionIncluded.regionName	string	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: Conditional
shipToLocations.regionIncluded.regionType	RegionTypeEnum	Reserved for future use. Occurrence: Conditional
warnings	array of ErrorDetailV3	An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty. Occurrence: Always
warnings.category	string	The category type for this error or warning. It is a string that can have one of three values: `Application`: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency. `Business`: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors. `Request`: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on. Occurrence: Conditional
warnings.domain	string	Name of the domain ,or primary system, of the service or application where the error occurred. Occurrence: Conditional
warnings.errorId	integer	A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Occurrence: Conditional
warnings.inputRefIds	array of string	Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation. Occurrence: Conditional
warnings.longMessage	string	A more detailed explanation of the error than given in the `message` error field. Occurrence: Conditional
warnings.message	string	Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale. Occurrence: Conditional
warnings.outputRefIds	array of string	Identifies specific response elements associated with the error, if any. Path format is the same as `inputRefId`. Occurrence: Conditional
warnings.parameters	array of ErrorParameterV3	This optional list of name/value pairs that contain context-specific `ErrorParameter` objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each `ErrorParameter` object consists of two fields, a `name` and a `value`. Occurrence: Conditional
warnings.parameters.name	string	Name of the parameter that caused the error. Occurrence: Conditional
warnings.parameters.value	string	The value of the parameter that caused the error. Occurrence: Conditional
warnings.subdomain	string	If present, indicates the subsystem in which the error occurred. Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
201	Created
400	Bad Request
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
20400	API_ACCOUNT	REQUEST	Invalid request. {additionalInfo}
20401	API_ACCOUNT	REQUEST	Missing field {fieldName}. {additionalInfo}
20402	API_ACCOUNT	REQUEST	Invalid input. {additionalInfo}
20403	API_ACCOUNT	REQUEST	Invalid {fieldName}. {additionalInfo}
20500	API_ACCOUNT	APPLICATION	System error.
20501	API_ACCOUNT	APPLICATION	Service unavailable. Please try again in next 24 hours.

Warnings

For more on warnings, plus the codes of other common warnings, see Handling errors.

Code	Domain	Category	Meaning
20200	API_ACCOUNT	BUSINESS	Warning. {additionalInfo}
20201	API_ACCOUNT	BUSINESS	{fieldName} (Click and Collect Program) can not be enabled for this seller or marketplace.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: A fulfillment policy with free domestic shipping

Sample 2: A fulfillment policy for Worldwide shipping

Sample 3: A detailed fulfillment policy

Sample 1: A fulfillment policy with free domestic shipping

Sellers can create one or more fulfillment policies where each fulfillment policy is specific to a marketplace and categoryType.name. You can set categoryType.name to one either ALL_EXCLUDING_MOTORS_VEHICLES or MOTORS_VEHICLES.

You can create multiple policies for each marketplace and categoryType.name combination, with each having a different set of shipping options. You can then select the fulfillment policy that is appropriate for each item in your inventory.

Input

The following fulfillment policy provides all the required fields and sets up a streamlined "free shipping" policy for domestic-only shipments. The policy uses a flat-rate service that is supplied by the United States Post Office. For more details on this example, see How to set up seller-pays free shipping.

POSThttps://api.sandbox.ebay.com/sell/account/v1/fulfillment_policy

Output

If the call is successful, eBay returns an HTTP status code of 201 Created and an ID for the created resource in the fulfillmentPolicyId field. In addition, the full URL to the newly created resource is returned in the Location HTTP response header.

{
    "name": "D********g",
    "marketplaceId": "EBAY_US",
    "categoryTypes": [
        {
            "name": "ALL_EXCLUDING_MOTORS_VEHICLES",
            "default": false
        }
    ],
    "handlingTime": {
        "value": 1,
        "unit": "DAY"
    },
    "shippingOptions": [
        {
            "optionType": "DOMESTIC",
            "costType": "FLAT_RATE",
            "shippingServices": [
                {
                    "sortOrder": 1,
                    "shippingCarrierCode": "USPS",
                    "shippingServiceCode": "USPSPriorityFlatRateBox",
                    "shippingCost": {
                        "value": "0.0",
                        "currency": "USD"
                    },
                    "additionalShippingCost": {
                        "value": "0.0",
                        "currency": "USD"
                    },
                    "freeShipping": true,
                    "buyerResponsibleForShipping": false,
                    "buyerResponsibleForPickup": false
                }
            ],
            "insuranceOffered": false,
            "insuranceFee": {
                "value": "0.0",
                "currency": "USD"
            }
        }
    ],
    "globalShipping": false,
    "pickupDropOff": false,
    "freightShipping": false,
    "fulfillmentPolicyId": "5********0",
    "warnings": []
}

Sample 2: A fulfillment policy for Worldwide shipping

This sample creates a basic fulfillment policy that includes both DOMESTIC and INTERNATIONAL (Worldwide) shipping options.

Input

This sample sets up a fulfillment policy that requires the buyer to pay for the shipping. The buyer pays a flat rate for domestic orders and calculated shipping for international orders (the cost of the international shipping can be determined at checkout when the buyer indicates the destination to where the order is to be shipped). For more details on this example, see How to set up worldwide shipping.

POSThttps://api.sandbox.ebay.com/sell/account/v1/fulfillment_policy

{
  "categoryTypes": [
    {
      "name": "ALL_EXCLUDING_MOTORS_VEHICLES"
    }
  ],
  "marketplaceId": "EBAY_US",
  "name": "W********l",
  "globalShipping": "false",
  "handlingTime": { 
    "unit" : "DAY",
    "value" : "1"
  },
  "shippingOptions": [
    {
      "costType": "FLAT_RATE",
      "optionType": "DOMESTIC",
      "shippingServices": [
        {
          "buyerResponsibleForShipping": "false",
          "freeShipping": "true",
          "shippingCarrierCode": "USPS",
          "shippingServiceCode": "USPSPriorityFlatRateBox",
          "shippingCost": {
            "currency": "USD",
            "value": "0.0"
          }
        }
      ]
    },
    {
      "costType": "CALCULATED",
      "optionType": "INTERNATIONAL",
      "shippingServices": [
        {
          "buyerResponsibleForShipping": "true",
          "freeShipping": "false",
          "shippingCarrierCode": "USPS",
          "shippingServiceCode": "USPSPriorityMailInternational",
          "shipToLocations": { 
            "regionIncluded": [
              {
                "regionName": "Worldwide"
              }
            ]
          }
        }
      ]
    }
  ]
}

Output

{
    "name": "W********l",
    "marketplaceId": "EBAY_US",
    "categoryTypes": [
        {
            "name": "ALL_EXCLUDING_MOTORS_VEHICLES",
            "default": false
        }
    ],
    "handlingTime": {
        "value": 1,
        "unit": "DAY"
    },
    "shipToLocations": {
        "regionIncluded": [
            {
                "regionName": "Worldwide"
            }
        ],
        "regionExcluded": []
    },
    "shippingOptions": [
        {
            "optionType": "DOMESTIC",
            "costType": "FLAT_RATE",
            "shippingServices": [
                {
                    "sortOrder": 1,
                    "shippingCarrierCode": "USPS",
                    "shippingServiceCode": "USPSPriorityFlatRateBox",
                    "shippingCost": {
                        "value": "0.0",
                        "currency": "USD"
                    },
                    "additionalShippingCost": {
                        "value": "0.0",
                        "currency": "USD"
                    },
                    "freeShipping": true,
                    "buyerResponsibleForShipping": false,
                    "buyerResponsibleForPickup": false
                }
            ],
            "insuranceOffered": false,
            "insuranceFee": {
                "value": "0.0",
                "currency": "USD"
            }
        },
        {
            "optionType": "INTERNATIONAL",
            "costType": "CALCULATED",
            "shippingServices": [
                {
                    "sortOrder": 1,
                    "shippingCarrierCode": "USPS",
                    "shippingServiceCode": "USPSPriorityMailInternational",
                    "freeShipping": false,
                    "shipToLocations": {
                        "regionIncluded": [
                            {
                                "regionName": "Worldwide"
                            }
                        ]
                    },
                    "buyerResponsibleForShipping": true,
                    "buyerResponsibleForPickup": false
                }
            ],
            "insuranceOffered": false,
            "insuranceFee": {
                "value": "0.0",
                "currency": "USD"
            }
        }
    ],
    "globalShipping": false,
    "pickupDropOff": false,
    "freightShipping": false,
      "fulfillmentPolicyId": "5********0",
    "warnings": []
}

Sample 3: A detailed fulfillment policy

This sample creates a fulfillment policy that includes both DOMESTIC and INTERNATIONAL shipping options, but it excludes certain regions to where the seller does not ship.

Input

This sample sets up free shipping for domestic orders and calculated shipping for international orders. The input shows how to set up multiple shipping services where each provides service to a different region. The example also shows how to exclude specific regions for the areas that would otherwise be included by a configured shipping service. It also sets up an "additional cost" amount, which is the price the seller pays for adding additional items to the order. For more details on this example, see How to exclude specific regions from included shipping areas.

POSThttps://api.sandbox.ebay.com/sell/account/v1/fulfillment_policy

{
  "categoryTypes": [
    {
      "name": "ALL_EXCLUDING_MOTORS_VEHICLES"
    }
  ],
  "marketplaceId": "EBAY_US",
  "name": "D********l",
  "globalShipping": "false",
  "handlingTime": { 
    "unit" : "DAY",
    "value" : "1"
  },
  "shippingOptions": [
    {
      "costType": "FLAT_RATE",
      "optionType": "DOMESTIC",
      "shippingServices": [
        {
          "additionalShippingCost": {
            "currency": "USD",
            "value": "5.00"
          },
          "buyerResponsibleForShipping": "true",
          "freeShipping": "false",
          "shippingCarrierCode": "USPS",
          "shippingServiceCode": "USPSPriorityFlatRateBox",
          "shippingCost": {
            "currency": "USD",
            "value": "7.15"
          }
        }
      ]
    },
    {
      "costType": "CALCULATED",
      "optionType": "INTERNATIONAL",
      "insuranceOffered": "true",
      "insuranceFee" : {
        "currency" : "USD",
        "value" : "10.00"
      },
      "shippingServices": [
        {
          "buyerResponsibleForShipping": "true",
          "freeShipping": "false",
          "shippingCarrierCode": "USPS",
          "shippingServiceCode": "USPSPriorityMailInternational",
          "shipToLocations": { 
            "regionIncluded": [
              {
                "regionName": "Europe"
              },
              {
                "regionName": "AU"
              },
              {
                "regionName": "JP"
              }
            ]
          }
        },
        {
          "buyerResponsibleForShipping": "true",
          "freeShipping": "false",
          "shippingCarrierCode": "USPS",
          "shippingServiceCode": "USPSPriorityMailInternationalSmallFlatRateBox",
          "shipToLocations": { 
            "regionIncluded": [
              {
                "regionName": "Worldwide"
              }
            ]
          }
        }
      ]
    }
  ],
  "shipToLocations": { 
    "regionExcluded": [ 
      {
        "regionName": "Middle East"
      },
      {
        "regionName": "GG"
      },
      {
        "regionName": "JE"
      }
    ]
  }
}

Output

{
    "name": "D********l",
    "marketplaceId": "EBAY_US",
    "categoryTypes": [
        {
            "name": "ALL_EXCLUDING_MOTORS_VEHICLES",
            "default": false
        }
    ],
    "handlingTime": {
        "value": 1,
        "unit": "DAY"
    },
    "shipToLocations": {
        "regionIncluded": [
            {
                "regionName": "Worldwide"
            }
        ],
        "regionExcluded": [
            {
                "regionName": "GG"
            },
            {
                "regionName": "JE"
            },
            {
                "regionName": "Middle East"
            }
        ]
    },
    "shippingOptions": [
        {
            "optionType": "DOMESTIC",
            "costType": "FLAT_RATE",
            "shippingServices": [
                {
                    "sortOrder": 1,
                    "shippingCarrierCode": "USPS",
                    "shippingServiceCode": "USPSPriorityFlatRateBox",
                    "shippingCost": {
                        "value": "7.15",
                        "currency": "USD"
                    },
                    "additionalShippingCost": {
                        "value": "5.0",
                        "currency": "USD"
                    },
                    "freeShipping": false,
                    "buyerResponsibleForShipping": true,
                    "buyerResponsibleForPickup": false
                }
            ],
            "insuranceOffered": false,
            "insuranceFee": {
                "value": "0.0",
                "currency": "USD"
            }
        },
        {
            "optionType": "INTERNATIONAL",
            "costType": "CALCULATED",
            "shippingServices": [
                {
                    "sortOrder": 1,
                    "shippingCarrierCode": "USPS",
                    "shippingServiceCode": "USPSPriorityMailInternational",
                    "freeShipping": false,
                    "shipToLocations": {
                        "regionIncluded": [
                            {
                                "regionName": "AU"
                            },
                            {
                                "regionName": "Europe"
                            },
                            {
                                "regionName": "JP"
                            }
                        ]
                    },
                    "buyerResponsibleForShipping": true,
                    "buyerResponsibleForPickup": false
                },
                {
                    "sortOrder": 2,
                    "shippingCarrierCode": "USPS",
                    "shippingServiceCode": "USPSPriorityMailInternationalSmallFlatRateBox",
                    "freeShipping": false,
                    "shipToLocations": {
                        "regionIncluded": [
                            {
                                "regionName": "Worldwide"
                            }
                        ]
                    },
                    "buyerResponsibleForShipping": true,
                    "buyerResponsibleForPickup": false
                }
            ],
            "insuranceOffered": true,
            "insuranceFee": {
                "value": "10.0",
                "currency": "USD"
            }
        }
    ],
    "globalShipping": false,
    "pickupDropOff": false,
    "freightShipping": false,
    "fulfillmentPolicyId": "5********0",
    "warnings": []
}