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

eBay Account APIVersion 1.2.0

Get Fulfillment Policies by Marketplace

GET /fulfillment_policy

Use this call to retrieve all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/fulfillment_policy?
  marketplace_id=MarketplaceIdEnum

URI parameters

Parameter Type Required? Meaning
marketplace_id string Required A unique identifier for an eBay marketplace.

Applicable values are from MarketplaceIdEnum.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



OAuth request scope

This request requires a user access token with the following scope:

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

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

See Getting Access Tokens for more information.



Payload model

This call has no request payload.


Output

See also Samples.

HTTP status codes

This call can return one of the following HTTP status codes. See the HTTP Status Code Registry for a complete overview of HTTP status codes.

Status Meaning
200 Success
400 Bad Request
500 Internal Server Error

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

{ /* FulfillmentPolicyResponse */
"fulfillmentPolicies": [
    { /* FulfillmentPolicy */
    "categoryTypes": [
        { /* CategoryType */
        "default": boolean,
        "name": string
        }
        /* More CategoryType nodes here */
      ],
    "description": string,
    "freightShipping": boolean,
    "fulfillmentPolicyId": string,
    "globalShipping": boolean,
    "handlingTime":
        { /* TimeDuration */
        "unit": string,
        "value": integer
        },
    "localPickup": boolean,
    "marketplaceId": string,
    "name": string,
    "pickupDropOff": boolean,
    "shippingOptions": [
        { /* ShippingOption */
        "costType": string,
        "insuranceFee":
            { /* Amount */
            "currency": string,
            "value": string
            },
        "insuranceOffered": boolean,
        "optionType": string,
        "packageHandlingCost":
            { /* Amount */
            "currency": string,
            "value": string
            },
        "rateTableId": string,
        "shippingServices": [
            { /* ShippingService */
            "additionalShippingCost":
                { /* Amount */
                "currency": string,
                "value": string
                },
            "buyerResponsibleForPickup": boolean,
            "buyerResponsibleForShipping": boolean,
            "cashOnDeliveryFee":
                { /* Amount */
                "currency": string,
                "value": string
                },
            "freeShipping": boolean,
            "shippingCarrierCode": string,
            "shippingCost":
                { /* Amount */
                "currency": string,
                "value": string
                },
            "shippingServiceCode": string,
            "shipToLocations":
                { /* RegionSet */
                "regionExcluded": [
                    { /* Region */
                    "regionName": string,
                    "regionType": string
                    }
                    /* More Region nodes here */
                  ],
                "regionIncluded": [
                    { /* Region */
                    "regionName": string,
                    "regionType": string
                    }
                    /* More Region nodes here */
                  ]
                },
            "sortOrder": integer,
            "surcharge":
                { /* Amount */
                "currency": string,
                "value": string
                }
            }
            /* More ShippingService nodes here */
          ]
        }
        /* More ShippingOption nodes here */
      ],
    "shipToLocations":
        { /* RegionSet */
        "regionExcluded": [
            { /* Region */
            "regionName": string,
            "regionType": string
            }
            /* More Region nodes here */
          ],
        "regionIncluded": [
            { /* Region */
            "regionName": string,
            "regionType": string
            }
            /* More Region nodes here */
          ]
        }
    }
    /* More FulfillmentPolicy nodes here */
  ],
"href": string,
"limit": integer,
"next": string,
"offset": integer,
"prev": string,
"total": integer
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
fulfillmentPolicies array of FulfillmentPolicy Conditionally A list of the seller's fulfillment policies.
fulfillmentPolicies
  .categoryTypes
array of CategoryType Always The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. (Currently, each policy can be set to only one categoryTypes value at a time.)
fulfillmentPolicies
  .categoryTypes.default
boolean Always Sellers can create multiple policies for any categoryTypes.name and marketplaceId combination. For example, you can create multiple fulfillment policies for one marketplace, where they all target the same category type; however, only one can be default at a time.

If this value is set to true, it indicates that this policy is the default policy for the associated categoryTypes.name and marketplaceId pair.

Note: eBay considers the status of this field only when you create listings through the Web flow. If you create listings using the APIs, you must specifically set the policies you want applied to a listing in the payload of the call you use to create the listing. If you use the Web flow to create item listings, eBay uses the default policy for the marketplace and category type specified, unless you override the default.

For more on default policies, see Changing the default policy for a category type.
fulfillmentPolicies
  .categoryTypes.name
string Always The category type to which the policy applies (motor vehicles or non-motor vehicles).
Note: The 'MOTORS_VEHICLES' category type is not valid for return policies because motor vehicle listings are non-returnable via eBay processes.

Applicable values are from CategoryTypeEnum:

ALL_EXCLUDING_MOTORS_VEHICLES
Category type name for all non-motor vehicle listings.
MOTORS_VEHICLES
Category type name for motor vehicle listings.

Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .description
string Conditionally An optional seller-defined description of the fulfillment policy.

Max length: 250
Max: 250.
fulfillmentPolicies
  .freightShipping
boolean Always If this value is set to true, it indicates the seller offers freight shipping.
Default: false
fulfillmentPolicies
  .fulfillmentPolicyId
string Always A unique eBay-assigned ID for this policy.
fulfillmentPolicies
  .globalShipping
boolean Always If this value is set to true, it indicates the seller has opted-in to the Global Shipping Program, which automatically sets the international shipping service to International Priority Shipping.

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

Opt-in to the Global Shipping Program, log in to eBay and navigate to My Account > Site Preferences > Shipping preferences.
fulfillmentPolicies
  .handlingTime
TimeDuration Always Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order.

Valid values can vary by site and by category. To obtain the supported values for a site, call GeteBayDetails in the Trading API; set DetailName to 'DispatchTimeMaxDetails' in the request, and inspect the DispatchTimeMaxDetails container in the response for the time values supported by the site.

Note that Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results pages. To offer zero-day or one-day handling, set field to '0' or '1', respectively. If you don't want to specify a handling time in the fulfillment policy, omit the handlingTimeMax field or set it to null.

Min: 0 Max: 30
fulfillmentPolicies
  .handlingTime.unit
string Conditionally Required if a time duration is required by the call.

Specifies a period of time as a unit that is used to define a duration.

Time-measurement units can be years, months, days, hours, and minutes (see TimeDurationUnitEnum for a complete list of units). The unit is applied to the number in the value field to define a span of time.

Note that supported values for this field vary according to the object using the time duration. See the containing object for details, and call GeteBayDetails in the Trading API to get the allowable values for the specific object your are using.

Applicable values are from TimeDurationUnitEnum:See unit.
Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .handlingTime.value
integer Conditionally Required if a time duration is required by the call.

An amount of time, as measured by the units specified in the unit field.

Note that supported values for this field vary according to the object using the time duration. See the containing object for details, and call GeteBayDetails in the Trading API to get the allowable values for the specific object your are instantiating.
fulfillmentPolicies
  .localPickup
boolean Always If this value is set to true, it indicates the seller offers local pickup of their items.
fulfillmentPolicies
  .marketplaceId
string Always The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller's eBay registration site.

Applicable values are from MarketplaceIdEnum:See marketplaceId.
Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies.name string Always A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64
Max: 64.
fulfillmentPolicies
  .pickupDropOff
boolean Always If this value is set to true, it indicates the seller offers the "Click and Collect" feature to be used with Add/Revise/Relist calls.

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

In addition to setting this field, the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
  • Have inventory for the product at one or more physical stores tied to the merchant's account.
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Set the immediatePay flag in the payment policy to 'true'.
    • Include only one paymentMethods field in the payment policy, and set its value to PAYPAL.
    • Include a valid PayPal contact in the recipientAccountReference.referenceId field of the payment policy.
When a UK merchant is successful at listing an item with "Click and Collect", prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.
Default: false
fulfillmentPolicies
  .shippingOptions
array of ShippingOption Conditionally A list of default shipping options supported by the seller. Shipping options can include the type of shipping, the shipping and handling costs, and any applicable insurance information. Use the optionType field to set up either domestic or international shipping options.
fulfillmentPolicies
  .shippingOptions.costType
string Conditionally Required if the request payload contains a shippingOptions container (costType is required within the shippingOptions container).

Defines whether the shipping cost is a flat rate or calculated cost.

Applicable values are from ShippingCostTypeEnum:

CALCULATED
Shipping cost type CALCULATED.
FLAT_RATE
Shipping cost type FLAT_RATE.
NOT_SPECIFIED
Shipping cost type NOT_SPECIFIED.

Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions.insuranceFee
Amount Conditionally Required if shippingOptions.insuranceOffered is set to true.

Sellers can offer international shipping insurance only when they ship to AU, FR, or IT. This value indicates the cost the buyer must pay to purchase shipping insurance for the item.
fulfillmentPolicies
  .shippingOptions.insuranceFee
  .currency
string Conditionally The currency in which the amount value is expressed. The currency is represented as a 3-letter ISO4217 currency code.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions.insuranceFee
  .value
string Conditionally The value of the amount in the specified currency.
fulfillmentPolicies
  .shippingOptions
  .insuranceOffered
boolean Conditionally When set to true, it indicates the seller offers shipping insurance. The optionType shows whether this is for either a domestic or international shipment.

Shipping insurance is currently supported in only Austrailia (AU), France (FR), and Italy (IT). Internaltional shipping is supported only if the seller has opted-in to the Global Shipping Program, which can be set by navigating to Account Settings > Site Preferences > Shipping preferences on the eBay site.
fulfillmentPolicies
  .shippingOptions.optionType
string Conditionally Required if the request payload contains a shippingOptions container (optionType is required within the shippingOptions container).

Defines whether the shipping option covers domestic or international shipping.

Applicable values are from ShippingOptionTypeEnum:

DOMESTIC
DOMESTIC indicates a region that is within the source country.
INTERNATIONAL
INTERNATIONAL indicates a region that is external to the source country.

Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions
  .packageHandlingCost
Amount Conditionally The amount the buyer must pay for shipping and handling.
fulfillmentPolicies
  .shippingOptions
  .packageHandlingCost.currency
string Conditionally The currency in which the amount value is expressed. The currency is represented as a 3-letter ISO4217 currency code.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions
  .packageHandlingCost.value
string Conditionally The value of the amount in the specified currency.
fulfillmentPolicies
  .shippingOptions.rateTableId
string Conditionally Note: This field is for future use; it is not yet live on the Production or Sandbox servers.

A unique eBay-assigned ID for the shipping rate table. This ID is associated with a user-created shipping rate table. For information on creating rate tables, see Using shipping rate tables. Use the getRateTables call to retrieve information on a seller's rate tables (including the rateTableId).
fulfillmentPolicies
  .shippingOptions
  .shippingServices
array of ShippingService Conditionally Required if the request payload contains a shippingOptions container (shippingServices is required within the shippingOptions container).

List of shipping services offered by the seller.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .additionalShippingCost
Amount Conditionally Additional shipping cost, such as handling costs. This cost cannot be greater than the base shipping cost.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .additionalShippingCost
  .currency
string Conditionally The currency in which the amount value is expressed. The currency is represented as a 3-letter ISO4217 currency code.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .additionalShippingCost.value
string Conditionally The value of the amount in the specified currency.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .buyerResponsibleForPickup
boolean Conditionally This field is only applicable to vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for picking up the vehicle. Otherwise, the seller should specify the vehicle pickup arrangements in the item description.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.

Default: false
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .buyerResponsibleForShipping
boolean Conditionally This field is applicable for only items listed in vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for the shipment of the vehicle. Otherwise, the seller should specify the vehicle shipping arrangements in the item description.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.

Default: false
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .cashOnDeliveryFee
Amount Conditionally The value indicates the Cash on Delivery (COD) fee that the seller charges if the buyer uses the CASH_ON_DELIVERY payment method. 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 field is applicable only if the buyer-selected payment method is 'COD' and the selected shipping service option supports a Cash on Delivery option.

To see if a domestic shipping service supports the Cash on Delivery option, call GeteBayDetails and set DetailName to 'ShippingServiceDetails'. In the response, see if CODService is set to 'true' for the targeted shipping service.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .cashOnDeliveryFee.currency
string Conditionally The currency in which the amount value is expressed. The currency is represented as a 3-letter ISO4217 currency code.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .cashOnDeliveryFee.value
string Conditionally The value of the amount in the specified currency.
fulfillmentPolicies
  .shippingOptions
  .shippingServices.freeShipping
boolean Conditionally The seller can set this flag to true if they want to offer free shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for subsequent shipping service options). 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 specified first in the API call.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shippingCarrierCode
string Conditionally The shipping carrier, such as 'USPS,' 'FedEx' and so on.
fulfillmentPolicies
  .shippingOptions
  .shippingServices.shippingCost
Amount Conditionally The estimated total cost of shipping based for the selected shipping carrier and service. This field is required in the input for all listings where flat-rate shipping is used, and it is not applicable to calculated shipping.

The seller can set this value at their discretion, however, the value should reflect the approximate total cost of the selected shipping service plus any additional charges (such as the seller's handling charges).

This value is set to '0.0' if freeShipping is set to 'true'.

fulfillmentPolicies
  .shippingOptions
  .shippingServices.shippingCost
  .currency
string Conditionally The currency in which the amount value is expressed. The currency is represented as a 3-letter ISO4217 currency code.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions
  .shippingServices.shippingCost
  .value
string Conditionally The value of the amount in the specified currency.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shippingServiceCode
string Conditionally The shipping service that the shipping carrier uses to ship an item. For example, an overnight, two-day delivery, or other type of service. For a list of valid shippingServiceCode values, call GeteBayDetails with ShippingServiceDetails set to DetailName. In the response, review the ShippingServiceDetails containers for the supported values.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shipToLocations
RegionSet Conditionally An international region (such as Asia, Europe, or Latin America) or country to where the seller will ship an item.

Each eBay marketplace supports its own set of allowable shipping locations, specified as regions and countries. Obtain the valid 'Ship-To locations' for a marketplace by calling GeteBayDetails in the Trading API, and set DetailName to ShipppingLocationDetails in the request; in the response, review the ShippingLocationDetails.ShippingLocation values for the shipping locations supported by the marketplace. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item.

If this value is not set, eBay automatically uses the seller's listing country as the default Ship-To Location.

To offer shipping to every region and country supported by the eBay shipping services, pass 'WORLDWIDE' as a shipToLocation value. To exclude one or more countries from a region you want to ship to, use the excludeShipToLocation field. Also, if the seller wants to offer international shipping as part of their shipping policy, they must set at least one international location in shipToLocation.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shipToLocations
  .regionExcluded
array of Region Conditionally A list of regions that are specifically excluded from a region set. You can use this to exclude a specific regionName from a regionType that you specifically include.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shipToLocations
  .regionExcluded.regionName
string Conditionally A free-form text string that indicates the name of the region. This value can be the name of a world region (such as the "Middle East" or "Southeast Asia"), a country, or a domestic region within a country (such as "Alaska/Hawaii" or "US Protectorates") depending on the value of regionType. This value should be WORLDWIDE if the regionType value is WORLDWIDE.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shipToLocations
  .regionExcluded.regionType
string Conditionally Retrieves the region's type. This value can be 'WORLDWIDE', 'WORLD_REGION', 'COUNTRY', or 'COUNTRY_REGION'.

Applicable values are from RegionTypeEnum:

COUNTRY
A single country.
COUNTRY_REGION
A country, or a domestic region within a country.
STATE_OR_PROVINCE
A state or province, such as Alaska or Hawaii, or the US Protectorates.
WORLD_REGION
A world region, such as the Middle East or Southeast Asia.
WORLDWIDE
The entire world as we know it.

Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shipToLocations
  .regionIncluded
array of Region Conditionally A list of regions that are specifically included in a region set. Use this field to include a specific regionName from a regionType that you've excluded.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shipToLocations
  .regionIncluded.regionName
string Conditionally A free-form text string that indicates the name of the region. This value can be the name of a world region (such as the "Middle East" or "Southeast Asia"), a country, or a domestic region within a country (such as "Alaska/Hawaii" or "US Protectorates") depending on the value of regionType. This value should be WORLDWIDE if the regionType value is WORLDWIDE.
fulfillmentPolicies
  .shippingOptions
  .shippingServices
  .shipToLocations
  .regionIncluded.regionType
string Conditionally Retrieves the region's type. This value can be 'WORLDWIDE', 'WORLD_REGION', 'COUNTRY', or 'COUNTRY_REGION'.

Applicable values are from RegionTypeEnum:

COUNTRY
A single country.
COUNTRY_REGION
A country, or a domestic region within a country.
STATE_OR_PROVINCE
A state or province, such as Alaska or Hawaii, or the US Protectorates.
WORLD_REGION
A world region, such as the Middle East or Southeast Asia.
WORLDWIDE
The entire world as we know it.

Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions
  .shippingServices.sortOrder
integer Conditionally This integer value controls the order that this shipping service option appears in the View Item and Checkout pages, as related to the other specified shipping service options.

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 '4' 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. Set up different domestic and international services by configuring two shippingOptions containers, where you set shippingOptions.optionType to either DOMESTIC or INTERNATIONAL to indicate the area supported by the listed shipping services.

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).
fulfillmentPolicies
  .shippingOptions
  .shippingServices.surcharge
Amount Conditionally The surcharge amount that they buyer must pay.
fulfillmentPolicies
  .shippingOptions
  .shippingServices.surcharge
  .currency
string Conditionally The currency in which the amount value is expressed. The currency is represented as a 3-letter ISO4217 currency code.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shippingOptions
  .shippingServices.surcharge
  .value
string Conditionally The value of the amount in the specified currency.
fulfillmentPolicies
  .shipToLocations
RegionSet Conditionally The geographical region(s) to which the seller ships.
It is not necessary to include the shipToLocations field; eBay automatically adds the seller's listing country as a 'Ship-To Location', and the field is always returned in the shipping policy response.
If the seller wants to offer international shipping as part of the shipping policy, you must supply at least one region in shipToLocation field that is outside the seller's listing country. To offer shipping to every region and country (supported by eBay shipping services), the seller can pass in 'WORLDWIDE' as a shipToLocation value.
fulfillmentPolicies
  .shipToLocations
  .regionExcluded
array of Region Conditionally A list of regions that are specifically excluded from a region set. You can use this to exclude a specific regionName from a regionType that you specifically include.
fulfillmentPolicies
  .shipToLocations
  .regionExcluded.regionName
string Conditionally A free-form text string that indicates the name of the region. This value can be the name of a world region (such as the "Middle East" or "Southeast Asia"), a country, or a domestic region within a country (such as "Alaska/Hawaii" or "US Protectorates") depending on the value of regionType. This value should be WORLDWIDE if the regionType value is WORLDWIDE.
fulfillmentPolicies
  .shipToLocations
  .regionExcluded.regionType
string Conditionally Retrieves the region's type. This value can be 'WORLDWIDE', 'WORLD_REGION', 'COUNTRY', or 'COUNTRY_REGION'.

Applicable values are from RegionTypeEnum:

COUNTRY
A single country.
COUNTRY_REGION
A country, or a domestic region within a country.
STATE_OR_PROVINCE
A state or province, such as Alaska or Hawaii, or the US Protectorates.
WORLD_REGION
A world region, such as the Middle East or Southeast Asia.
WORLDWIDE
The entire world as we know it.

Code so that your app gracefully handles any future changes to this list.
fulfillmentPolicies
  .shipToLocations
  .regionIncluded
array of Region Conditionally A list of regions that are specifically included in a region set. Use this field to include a specific regionName from a regionType that you've excluded.
fulfillmentPolicies
  .shipToLocations
  .regionIncluded.regionName
string Conditionally A free-form text string that indicates the name of the region. This value can be the name of a world region (such as the "Middle East" or "Southeast Asia"), a country, or a domestic region within a country (such as "Alaska/Hawaii" or "US Protectorates") depending on the value of regionType. This value should be WORLDWIDE if the regionType value is WORLDWIDE.
fulfillmentPolicies
  .shipToLocations
  .regionIncluded.regionType
string Conditionally Retrieves the region's type. This value can be 'WORLDWIDE', 'WORLD_REGION', 'COUNTRY', or 'COUNTRY_REGION'.

Applicable values are from RegionTypeEnum:

COUNTRY
A single country.
COUNTRY_REGION
A country, or a domestic region within a country.
STATE_OR_PROVINCE
A state or province, such as Alaska or Hawaii, or the US Protectorates.
WORLD_REGION
A world region, such as the Middle East or Southeast Asia.
WORLDWIDE
The entire world as we know it.

Code so that your app gracefully handles any future changes to this list.
href string Conditionally Returns a URL link to the result set.
limit integer Conditionally Returns the maximum number of results that can be returned in result set.
next string Conditionally Returns a URL link to the next set of results.
offset integer Conditionally Returns how many result sets were skipped before the currently returned result set.
prev string Conditionally Returns a URL link to the previous set of results.
total integer Conditionally Returns the total number of result sets in the paginated collection.



Error Codes

Code Domain Category Nature Meaning
20401 API_ACCOUNT REQUEST ERROR Missing field {fieldName}. {additionalInfo}
20403 API_ACCOUNT REQUEST ERROR Invalid {fieldName}. {additionalInfo}
20404 API_ACCOUNT REQUEST ERROR {fieldName} not found.
20500 API_ACCOUNT APPLICATION ERROR System error.
20501 API_ACCOUNT APPLICATION ERROR Service unavailable. Please try again in next 24 hours.



Samples

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Get all Fulfillment Policies

This call retrieves all fulfillment policies for the specified marketplace.

Description

Sellers can create one or more fulfillment policies for a particular marketplace. This call returns all the current policies for the specified marketplace.

Input

This call requires you specify the eBay marketplace ID using the query parameter. It does not use a request payload.

URL format. See also the non-wrapped version of this URL.

GET https://api.sandbox.ebay.com/sell/account/v1/fulfillment_policy?
   marketplace_id=EBAY_US

Output

If the call is successful, eBay returns an HTTP status code of 200 OK and a list of the associated fulfillment policies.

JSON format.
{
  "total": 2,
  "fulfillmentPolicies": [
    {
      "name": "minimal fulfillment policy",
      "marketplaceId": "EBAY_US",
      "categoryTypes": [
        {
          "name": "ALL_EXCLUDING_MOTORS_VEHICLES",
          "default": true
        }
      ],
      "handlingTime": {
        "value": 1,
        "unit": "DAY"
      },
      "globalShipping": false,
      "pickupDropOff": false,
      "localPickup": true,
      "freightShipping": false,
      "fulfillmentPolicyId": "5488091000"
    },
    {
      "name": "detailed US fulfillment policy",
      "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,
              "shippingServiceCode": "FedExHomeDelivery",
              "shippingCost": {
                "value": "5.5",
                "currency": "USD"
              },
              "additionalShippingCost": {
                "value": "1.2",
                "currency": "USD"
              },
              "freeShipping": false,
              "buyerResponsibleForShipping": false,
              "buyerResponsibleForPickup": false
            }
          ],
          "insuranceOffered": false,
          "insuranceFee": {
            "value": "0.0",
            "currency": "USD"
          }
        }
      ],
      "globalShipping": false,
      "pickupDropOff": false,
      "freightShipping": false,
      "fulfillmentPolicyId": "5522807000"
    }
  ]
}



Change History

Change Date Description
1.0.0
2016-10-19
  • Call (added): New call.