getServices: eBay Edelivery_international_shipping API

GET/services

Important! This method is only available for Greater-China based sellers with an active eDIS account.

This method can be used to retrieve metadata on available shipping services, such as the name, description, and directions.

Input

Resource URI

GET https://api.ebay.com/sell/edelivery_international_shipping/v1/services?

offset=integer&

limit=integer

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
offset	integer	This query parameter specifies the number of shipping services to skip in the result set before returning the first shipping service in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of `0` and a limit of `10`, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. Default: `0` Occurrence: Optional
limit	integer	This query parameter sets the maximum number of shipping services to return on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to `10` and limit is set to `10`, the call retrieves orders 11 through 20 from the result set. Max: `200` Default: `50` Occurrence: Optional

HTTP request headers

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

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

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/scope/sell.edelivery

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

Copy complete valid JSON to clipboard

{ /* GetServiceListResponses */

"serviceList" :

{ /* GetServiceListResponsesData */

"href" : "string",

"limit" : "integer",

"next" : "string",

"offset" : "integer",

"prev" : "string",

"services" : [

{ /* ServiceInfoResponses */

"descriptionEn" : "string",

"descriptionHk" : "string",

"descriptionJp" : "string",

"descriptionZh" : "string",

"directions" : [

{ /* DirectionsResponses */

"batteryType" : "string",

"from" : "string",

"to" : "string"

}

"incoterm" : "IncotermEnum : [DDP,DDU]",

"maxLength" : "number",

"maxTotalLength" : "number",

"maxWeight" : "number",

"nameEn" : "string",

"nameHk" : "string",

"nameJp" : "string",

"nameZh" : "string",

"shippingServiceId" : "string"

}

"total" : "integer"

}

Response fields

Output container/field	Type	Description
serviceList	GetServiceListResponsesData	This container returns shipping service metadata associated with a seller's eDIS account. Occurrence: Always
serviceList.href	string	The URL to the current page of the result set. Occurrence: Always
serviceList.limit	integer	The value of the limit parameter submitted in the request. Occurrence: Always
serviceList.next	string	The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. Occurrence: Conditional
serviceList.offset	integer	The value of the offset parameter submitted in the request. Occurrence: Always
serviceList.prev	string	The URI for the previous page of results. This is returned if there is a previous page of results from the result set. Occurrence: Conditional
serviceList.services	array of ServiceInfoResponses	This array returns a list of available shipping services, as well as the descriptions, directions, and identifiers of each service. Occurrence: Always
serviceList.services.descriptionEn	string	Basic shipping service information in English. Occurrence: Conditional
serviceList.services.descriptionHk	string	Basic shipping service information in traditional Chinese. Occurrence: Conditional
serviceList.services.descriptionJp	string	Basic shipping service information in Japanese. Occurrence: Conditional
serviceList.services.descriptionZh	string	Basic shipping service information in simplified Chinese. Occurrence: Conditional
serviceList.services.directions	array of DirectionsResponses	This array lists includes all Ship From/Ship To combinations that the service supports. It also includes the type of batteries that may be shipping using the shipping service. Occurrence: Conditional
serviceList.services.directions.batteryType	string	The supported battery type for the shipping service. Occurrence: Conditional
serviceList.services.directions.from	string	The two-letter ISO 3166 ship-from country code. Occurrence: Conditional
serviceList.services.directions.to	string	The two-letter ISO 3166 destination country code. Occurrence: Conditional
serviceList.services.incoterm	IncotermEnum	The incoterm information associated with the the shipping service. Supported values: `DDP` `DDU` Occurrence: Conditional
serviceList.services.maxLength	number	This value indicates the maximum length (in centimeters) of the shipping package that the shipping service allows. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable. Occurrence: Always
serviceList.services.maxTotalLength	number	This value indicates the total maximum value of the length, width, and height of the package. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable. Occurrence: Always
serviceList.services.maxWeight	number	This value indicates the maximum weight (in grams) of the shipping package that the shipping service allows. Note: This field is always returned, but will show as null or have an empty value if not defined/applicable. Occurrence: Always
serviceList.services.nameEn	string	The shipping service name in English Occurrence: Conditional
serviceList.services.nameHk	string	The shipping service name in traditional Chinese Occurrence: Conditional
serviceList.services.nameJp	string	The shipping service name in Japanese. Occurrence: Conditional
serviceList.services.nameZh	string	The shipping service name in simplified Chinese Occurrence: Conditional
serviceList.services.shippingServiceId	string	The unique identifier of the shipping service being retrieved. This value can be input in the shippingServiceId field when creating a package through the the createPackage method. Occurrence: Always
serviceList.total	integer	The total number of shipping services being displayed on the current results page. 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	OK
400	Bad Request
401	Unauthorized
404	Not found
500	Internal Server Error

Error codes

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

Code	Domain	Category	Meaning
355000	API_EDIS	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
355076	API_EDIS	REQUEST	Invalid input value of pagination parameters. Please revise them.
355400	API_EDIS	REQUEST	The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list.

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 shipping service metadata

This method can be used to retrieve the metadata on the shipping services associated with a seller's eDIS account.

Input

The limit and offset query parameters can be used with this method. There are no other request payload required.

GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/services?offset=0&limit=10

Output

If the call is successful, information about each service associated with a seller's eDIS account is returned, such the name, description, and directions of the service.

{
    "serviceList": {
        "href": "https://edis-api.ebay.com/sell/edelivery_international_shipping/v1/services?offset=0&limit=10",
        "next": "https://edis-api.ebay.com/sell/edelivery_international_shipping/v1/services?offset=1&limit=10",
	"limit": 10,
        "offset": 0,
        "total": 2,
        "services": [
            {
                "descriptionEn": "product description",
                "directions": [
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "US"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "GB"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "PR"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "GU"
                    }
                ],
                "incoterm": "DDU",
                "maxLength": null,
                "maxTotalLength": null,
                "maxWeight": null,
                "nameEn": "Standard",
                "nameHk": "標準",
                "nameZh": "标准",
                "shippingServiceId": "ES"
            },
            {
                "descriptionEn": "product description",
                "directions": [
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "DE"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "GB"
                    },
                    {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "ES"
                    },
                                        {
                        "batteryType": "0,1,2,3,4,5",
                        "from": "CN",
                        "to": "SK"
                    },
                    {
                        "batteryType": "0",
                        "from": "CN",
                        "to": "SM"
                    }                ],
                "incoterm": "DDU",
                "maxLength": null,
                "maxTotalLength": null,
                "maxWeight": null,
                "nameEn": "Economy",
                "nameHk": "經濟",
                "nameZh": "经济",
                "shippingServiceId": "EE"
            }
        ]
    }
}