GET/shipping/marketplace/{marketplace_id}/get_shipping_services
This method retrieves a list of shipping services supported for the specified marketplace, including valid shipping services, shipping times, and package constraints such as size and weight.
Manage shipping services using business policies through the fulfillment_policy resource of the Account v1 API.
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 | string | This path parameter specifies the eBay marketplace for which shipping services 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.
| Header | Type | Description |
|---|---|---|
| Accept-Language | string | This 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:
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/field | Type | Description |
|---|---|---|
| shippingServices | array of ShippingService | A complete list of shipping service options that can be used on the marketplace for shipping items. Occurrence: Always |
| shippingServices.description | string | This field returns the localized name of the shipping service. Occurrence: Always |
| shippingServices.internationalService | boolean | A value of Occurrence: Always |
| shippingServices.maxShippingTime | integer | This value indicates the maximum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService. Occurrence: Conditional |
| shippingServices.minShippingTime | integer | This value indicates the minimum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService. Occurrence: Conditional |
| shippingServices.packageLimits | PackageLimits | This container provides name-value pairs that specify physical constraints and measurement units of packages for the shippingCarrier and the corresponding shippingService. An empty container is returned if the shipping service does not have any package limits defined. Occurrence: Always |
| shippingServices.packageLimits.dimensionUnit | string | Unit of dimensional measurement, for example Occurrence: Conditional |
| shippingServices.packageLimits.maxGirth | number | The maximum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit. Occurrence: Conditional |
| shippingServices.packageLimits.maxHeight | number | The maximum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit. Occurrence: Conditional |
| shippingServices.packageLimits.maxLength | number | The maximum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit. Occurrence: Conditional |
| shippingServices.packageLimits.maxWeight | number | The maximum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit. Occurrence: Conditional |
| shippingServices.packageLimits.maxWidth | number | The maximum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit. Occurrence: Conditional |
| shippingServices.packageLimits.minGirth | number | The minimum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit. Occurrence: Conditional |
| shippingServices.packageLimits.minHeight | number | The minimum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit. Occurrence: Conditional |
| shippingServices.packageLimits.minLength | number | The minimum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit. Occurrence: Conditional |
| shippingServices.packageLimits.minWeight | number | The minimum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit. Occurrence: Conditional |
| shippingServices.packageLimits.minWidth | number | The minimum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit. Occurrence: Conditional |
| shippingServices.packageLimits.weightUnit | string | Unit of weight measurement, for example Occurrence: Conditional |
| shippingServices.shippingCarrier | string | The code for the shipping carrier returned, for example, Occurrence: Conditional |
| shippingServices.shippingCategory | string | The shipping category of the shipping service including: Occurrence: Always |
| shippingServices.shippingCostTypes | array of string | A list of shipping cost types that this shipping service option supports. For example, Occurrence: Always |
| shippingServices.shippingService | string | The name of the shipping service. The shipping service named here can only be used in listings or in business policies if validForSellingFlow is Occurrence: Always |
| shippingServices.validForSellingFlow | boolean | A value of 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.
| 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 |
|---|---|---|---|
| 46000 | API_METADATA | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 46001 | API_METADATA | REQUEST | The 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 eBay shipping services metadata for the specified marketplace
This example retrieves the eBay shipping services for the EBAY_US marketplace.
This method returns an array with each node in the response containing metadata for the shipping services 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_shipping_services
Output
If the call is successful, the response body contains the eBay shipping service metadata for the marketplace specified in the request.