getHandlingTimes: eBay Metadata API | eBay Developers Program

GET/shipping/marketplace/{marketplace_id}/get_handling_times

This method retrieves a list of supported handling times for the specified marketplace. The handling time returned specifies the maximum number of business days the eBay site allows for shipping an item to domestic buyers after receiving a cleared payment. Handling times apply to both domestic and international orders. If the handling time is 1 day, the seller commits to dropping the item off for shipment one business day after payment clears.

Manage handing times 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_handling_times

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 handling times 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

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: 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

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:

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

Copy complete valid JSON to clipboard

{ /* ShippingHandlingTimeResponse */

"handlingTimes" : [

{ /* ShippingHandlingTime */

"description" : "string",

"extendedHandling" : "boolean",

"maxHandlingTime" : "integer"

}

]

}

Response fields

Output container/field	Type	Description
handlingTimes	array of ShippingHandlingTime	A list of supported handling times for the marketplace. Occurrence: Always
handlingTimes.description	string	The localized description of the maximum handling time. Occurrence: Always
handlingTimes.extendedHandling	boolean	This field is only returned if its value is `true`. If returned, it indicates that the corresponding handling time is considered extended handling for the marketplace. Extended handling times may be used for freight shipping, but should generally be avoided if possible, as they might adversely affect the buying decisions of potential customers. Occurrence: Conditional
handlingTimes.maxHandlingTime	integer	The integer value returned in this field indicates the maximum number of business days that the eBay site allows as a seller's handling time measured from when the buyer pays for the order. For example, if the maxHandlingTime value is set to 1 and a buyer pays for the order on a Wednesday, the seller would have to ship the item by the next day (Thursday). A maxHandlingTime value of `0` indicates same day handling for an item. In this case, the seller's handling time commitment depends on the order cut off time set in the seller's user preferences. This defaults to 2:00 PM local time on most eBay sites. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays). 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 supported handling times for the specified marketplace

This example retrieves a list of handling times supported on the EBAY_US marketplace.

This method returns an array with each node in the response containing available handling times 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_handling_times

Output

If the call is successful, the response body contains the handling times supported for the marketplace specified in the request.

{
    "handlingTimes": [
        {
            "maxHandlingTime": 0,
            "description": "Same business day"
        },
        {
            "maxHandlingTime": 1,
            "description": "1 business day"
        },
        {
            "maxHandlingTime": 2,
            "description": "2 business days"
        },
        {
            "maxHandlingTime": 3,
            "description": "3 business days"
        },
        {
            "maxHandlingTime": 4,
            "description": "4 business days"
        },
        {
            "maxHandlingTime": 5,
            "description": "5 business days"
        },
        {
            "maxHandlingTime": 6,
            "description": "6 business days"
        },
        {
            "maxHandlingTime": 7,
            "description": "7 business days"
        },
        {
            "maxHandlingTime": 10,
            "description": "10 business days"
        },
        {
            "maxHandlingTime": 15,
            "description": "15 business days"
        },
        {
            "maxHandlingTime": 20,
            "description": "20 business days"
        },
        {
            "maxHandlingTime": 30,
            "description": "30 business days"
        },
        {
            "maxHandlingTime": 40,
            "description": "40 business days"
        }
    ]
}