Skip to main content

GET/fulfillment_policy/{fulfillmentPolicyId}

This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/fulfillment_policy/{fulfillmentPolicyId}

URI parameters

ParameterTypeDescription
fulfillmentPolicyIdstringThis path parameter specifies the ID of the fulfillment policy you want to retrieve.

Occurrence: Required

HTTP request headers

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

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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

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

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

{ /* FulfillmentPolicy */
"name" : "string",
}

Response fields

Output container/fieldTypeDescription
categoryTypesarray of CategoryType

This container indicates whether the fulfillment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.

Occurrence: Always

categoryTypes.defaultboolean

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.nameCategoryTypeEnum

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

descriptionstring

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

freightShippingboolean

If returned as true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs.

Occurrence: Always

fulfillmentPolicyIdstring

A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created.

Occurrence: Always

globalShippingboolean

If returned as true, eBay's Global Shipping Program will be used by the seller to ship items to international locations.

Occurrence: Always

handlingTimeTimeDuration

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.unitTimeDurationUnitEnum

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.valueinteger

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

Occurrence: Conditional

localPickupboolean

If returned as true, local pickup is available for this policy.

Occurrence: Always

marketplaceIdMarketplaceIdEnum

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

Occurrence: Always

namestring

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

Max length: 64

Occurrence: Always

pickupDropOffboolean

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

shippingOptionsarray 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.costTypeShippingCostTypeEnum

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.insuranceFeeAmount

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.currencyCurrencyCodeEnum

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.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

shippingOptions.insuranceOfferedboolean

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.optionTypeShippingOptionTypeEnum

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.packageHandlingCostAmount

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.currencyCurrencyCodeEnum

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.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

shippingOptions.rateTableIdstring

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.shippingServicesarray 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.additionalShippingCostAmount

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.currencyCurrencyCodeEnum

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.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

shippingOptions.shippingServices.buyerResponsibleForPickupboolean

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.buyerResponsibleForShippingboolean

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.cashOnDeliveryFeeAmount

This container is used if the seller charges a Cash on Delivery (COD) fee. This fee will only be applicable in the case of a 'local pickup', and if one of the specified offline payment methods is a 'cash on pickup' or 'cash on delivery' option. This fee is added to the total cost of the item, and the total cost is due from the buyer upon the delivery of the item.

This container is returned if set.

Occurrence: Conditional

shippingOptions.shippingServices.cashOnDeliveryFee.currencyCurrencyCodeEnum

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.cashOnDeliveryFee.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

shippingOptions.shippingServices.freeShippingboolean

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.shippingCarrierCodestring

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.shippingCostAmount

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.currencyCurrencyCodeEnum

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.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

shippingOptions.shippingServices.shippingServiceCodestring

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.shipToLocationsRegionSet

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.regionExcludedarray 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.

Occurrence: Always

shippingOptions.shippingServices.shipToLocations.regionExcluded.regionNamestring

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 GeteBayDetailswith the DetailName value set to ExcludeShippingLocationDetails.

Occurrence: Conditional

shippingOptions.shippingServices.shipToLocations.regionExcluded.regionTypeRegionTypeEnum

Reserved for future use.

Occurrence: Conditional

shippingOptions.shippingServices.shipToLocations.regionIncludedarray 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.

Occurrence: Always

shippingOptions.shippingServices.shipToLocations.regionIncluded.regionNamestring

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 GeteBayDetailswith the DetailName value set to ExcludeShippingLocationDetails.

Occurrence: Conditional

shippingOptions.shippingServices.shipToLocations.regionIncluded.regionTypeRegionTypeEnum

Reserved for future use.

Occurrence: Conditional

shippingOptions.shippingServices.sortOrderinteger

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.surchargeAmount

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.currencyCurrencyCodeEnum

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.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

shipToLocationsRegionSet

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: Conditional

shipToLocations.regionExcludedarray 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.

Occurrence: Always

shipToLocations.regionExcluded.regionNamestring

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 GeteBayDetailswith the DetailName value set to ExcludeShippingLocationDetails.

Occurrence: Conditional

shipToLocations.regionExcluded.regionTypeRegionTypeEnum

Reserved for future use.

Occurrence: Conditional

shipToLocations.regionIncludedarray 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.

Occurrence: Always

shipToLocations.regionIncluded.regionNamestring

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 GeteBayDetailswith the DetailName value set to ExcludeShippingLocationDetails.

Occurrence: Conditional

shipToLocations.regionIncluded.regionTypeRegionTypeEnum

Reserved for future use.

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.

StatusMeaning
200Success
400Bad Request
404Not Found
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
20403API_ACCOUNTREQUESTMissing field {fieldName}. {additionalInfo}
20403API_ACCOUNTREQUESTInvalid {fieldName}. {additionalInfo}
20404API_ACCOUNTREQUEST{fieldName} not found.
20500API_ACCOUNTAPPLICATIONSystem error.
20501API_ACCOUNTAPPLICATIONService unavailable. Please try again in next 24 hours.

Warnings

This call has no warnings.

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: Get a Fulfillment Policy by ID

This example retrieves a fulfillment policy by the policy's unique eBay-assigned ID.

Input

Specify the policy you want to get using the fulfillmentPolicyId path parameter. This call does not use a request payload.

GEThttps://api.sandbox.ebay.com/sell/account/v1/fulfillment_policy/5********0

Output

A successful call returns an HTTP status code of 200 OK and a response body containing the specified fulfillment policy.