GET/fulfillment_policy/get_by_policy_name
This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters.
Input
Resource URI
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
| Parameter | Type | Description |
|---|---|---|
| marketplace_id | MarketplaceIdEnum | This query parameter specifies the eBay marketplace of the policy you want to retrieve. Occurrence: Required |
| name | string | This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve. This value can be retrieved for a fulfillment policy by using the getFulfillmentPolicies method. Occurrence: Required |
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-Language | string | Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers. Occurrence: Conditional |
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
Response fields
| Output container/field | Type | Description |
|---|---|---|
| categoryTypes | array 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.default | boolean | Note: This field has been deprecated and is no longer used. Occurrence: Conditional |
| categoryTypes.name | CategoryTypeEnum | The category type to which the policy applies (motor vehicles or non-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. Occurrence: Conditional |
| freightShipping | boolean | If returned as Occurrence: Always |
| fulfillmentPolicyId | string | A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created. Occurrence: Always |
| globalShipping | boolean | Note: This field is only applicable for the eBay United Kingdom marketplace ( 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 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 Occurrence: Always |
| marketplaceId | MarketplaceIdEnum | The ID of the eBay marketplace to which this fulfillment policy applies. Occurrence: Always |
| name | string | A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Occurrence: Always |
| pickupDropOff | boolean | If returned as 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). 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 Occurrence: Conditional |
| shippingOptions.insuranceFee | Amount | This field has been deprecated. Occurrence: Conditional |
| shippingOptions.insuranceFee.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| shippingOptions.insuranceFee.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| shippingOptions.insuranceOffered | boolean | This field has been deprecated. 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. Occurrence: Conditional |
| shippingOptions.packageHandlingCost.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. 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. 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. 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. 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.) 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. Occurrence: Conditional |
| shippingOptions.shippingServices.additionalShippingCost.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. 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 Occurrence: Conditional |
| shippingOptions.shippingServices.buyerResponsibleForShipping | boolean | This field should be included and set to Occurrence: Conditional |
| shippingOptions.shippingServices.freeShipping | boolean | This field is included and set to Occurrence: Conditional |
| shippingOptions.shippingServices.shippingCarrierCode | string | This field sets/indicates the shipping carrier, such as 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. Occurrence: Conditional |
| shippingOptions.shippingServices.shippingCost.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. 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 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.
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. 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. 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. 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. 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. 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. Occurrence: Conditional |
| shippingOptions.shippingServices.surcharge.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. 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: Conditional |
| 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. 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. 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. 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. Occurrence: Conditional |
| shipToLocations.regionIncluded.regionType | RegionTypeEnum | 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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 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 |
|---|---|---|---|
| 20401 | API_ACCOUNT | REQUEST | Missing field {fieldName}. {additionalInfo} |
| 20403 | API_ACCOUNT | REQUEST | Invalid {fieldName}. {additionalInfo} |
| 20404 | API_ACCOUNT | REQUEST | {fieldName} not found. |
| 20500 | API_ACCOUNT | APPLICATION | System error. |
| 20501 | API_ACCOUNT | APPLICATION | Service 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 Fulfillment Policy by Name
This call retrieves the fulfillment policy that matches the specified name.
Input
Specify the name of the policy you want to retrieve using the marketplace_id and name query parameters. The call does not use a request payload.
GEThttps://api.ebay.com/sell/account/v1/fulfillment_policy/get_by_policy_name?marketplace_id=EBAY_US&name=W********l
Output
A successful call returns an HTTP status code of 200 OK and a response body containing specified fulfillment policy.