Skip to main content

GET/shipping/marketplace/{marketplace_id}/get_exclude_shipping_locations

This method retrieves a list of locations that the seller can use as excluded shipping locations within their listings or in their fulfillment business policies for the specified marketplace. These are locations that a seller designates as areas where they will not ship items.

Excluded shipping locations and ship-to locations are used in tandem at the listing level and in fulfillment business policies. Excluded shipping locations and ship-to locations share a lot of the same values and they should not contradict each other.

Manage excluded shipping locations using business policies through the fulfillment_policy resource of the Account v1 API.

Input

Resource URI

GET https://api.ebay.com/sell/metadata/v1/shipping/marketplace/{marketplace_id}/get_exclude_shipping_locations

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

ParameterTypeDescription
marketplace_idstringThis path parameter specifies the eBay marketplace for which excluded shipping locations information is retrieved.

See MarketplaceIdEnum for supported eBay marketplace ID values.

Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.

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.

HeaderTypeDescription
Accept-LanguagestringThis header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.

Follow the instructions below to retrieve metadata for these three marketplaces:
  • French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
  • Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
  • French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA.
Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.

Occurrence: Conditional

OAuth scope

This request requires an access token created with the client credentials 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

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/fieldTypeDescription
excludeShippingLocationsarray of ShippingExcludeLocation

The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that the seller has designated as excluded shipping locations.

Occurrence: Always

excludeShippingLocations.descriptionstring

The localized location name.

Occurrence: Always

excludeShippingLocations.locationstring

The location or region to be excluded. Countries are returned through ISO 3166 codes. This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii). The values returned in this field are used in fulfillment business policies (such as in regionName) or through the ExcludeShipToLocation field in an AddItem call.

Occurrence: Always

excludeShippingLocations.regionstring

The region of the excluded shipping area specified, such as:

  • Africa
  • Americas
  • Asia
  • Central America and Caribbean
  • Europe
  • Middle East
  • North America
  • Oceania
  • South America
  • Southeast Asia

Occurrence: Always

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
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
46000API_METADATAAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
46001API_METADATAREQUESTThe specified marketplace ID was not found.

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: Retrieve the excluded shipping locations for the specified marketplace

This example retrieves a list of the excluded shipping locations for the EBAY_US marketplace.

This method returns an array with each node in the response containing the excluded shipping locations returned.

Input

This method does not use a request payload. The response returns a list for the marketplace specified through the path parameter.

GEThttps://api.ebay.com/sell/metadata/v1/shipping/marketplace/EBAY_US/get_exclude_shipping_locations

Output

If the call is successful, the response body contains the excluded shipping locations for the marketplace specified in the request.