inventory API1.7.0

getInventoryLocation

GET
/location/{merchantLocationKey}
This call retrieves all defined details of the inventory location that is specified by the merchantLocationKey path parameter.

The authorization HTTP header is the only required request header for this call.

A successful call will return an HTTP status value of 200 OK.

Input

Resource URI (production)

GET https://api.ebay.com/sell/inventory/v1/location/{merchantLocationKey}

URI parameters

ParameterTypeDescription
merchantLocationKeystringA unique merchant-defined key (ID) for an inventory location. This value is passed in at the end of the call URI to specify the inventory location to retrieve.

Max length: 36

Occurrence: Required

HTTP request headers

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

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/api_scope/sell.inventory.readonly

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

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
locationLocationThis container provides location details of an inventory location. The address container will always be returned, but it will not always have a complete street address. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location. The geoCoordinates container will only be returned if the merchant provided geographical coordinates. The locationId field is always returned, but this value is only used internally by eBay.

Occurrence: Required

location.addressAddressThe address container is always returned in getInventoryLocation/getInventoryLocations calls. Except in the case of an inventory location that supports In-Store Pickup inventory, a full address is not a requirement when setting up an inventory location.

Occurrence: Required

location.address.addressLine1stringThe first line of a street address. This field is required for store inventory locations that will be holding In-Store Pickup inventory. A street address is not required if the inventory location is not holding In-Store Pickup Inventory. This field will be returned if defined for an inventory location.

Max length: 128

Occurrence: Conditional

location.address.addressLine2stringThe second line of a street address. This field can be used for additional address information, such as a suite or apartment number. A street address is not required if the inventory location is not holding In-Store Pickup Inventory. This field will be returned if defined for an inventory location.

Max length: 128

Occurrence: Conditional

location.address.citystringThe city in which the inventory location resides. This field is required for store inventory locations that will be holding In-Store Pickup inventory. For warehouse locations, this field is technically optional, as a postalCode can be used instead of city/stateOrProvince pair, and then the city is just derived from this postal/zip code. This field is returned if defined for an inventory location.

Max length: 128

Occurrence: Conditional

location.address.countryCountryCodeEnum"The country in which the address resides, represented as two-letter ISO 3166 country code. For example, US represents the United States, and DE represents Germany.

Max length: 2

Occurrence: Always

location.address.countystringThe county in which the address resides. This field is returned if defined for an inventory location.

Occurrence: Conditional

location.address.postalCodestringThe postal/zip code of the address. eBay uses postal codes to surface In-Store Pickup items within the vicinity of a buyer's location, and it also user postal codes (origin and destination) to estimate shipping costs when the seller uses calculated shipping. A city/stateOrProvince pair can be used instead of a postalCode value, and then the postal code is just derived from the city and state/province. This field is returned if defined for an inventory location.

Max length: 16

Occurrence: Conditional

location.address.stateOrProvincestringThe state/province in which the inventory location resides. This field is required for store inventory locations that will be holding In-Store Pickup inventory. For warehouse locations, this field is technically optional, as a postalCode can be used instead of city/stateOrProvince pair, and then the state or province is just derived from this postal/zip code.

Max length: 128

Occurrence: Always

location.geoCoordinatesGeoCoordinatesThis container displays the Global Positioning System (GPS) latitude and longitude coordinates for the inventory location. This container is only returned if the geo-coordinates are set for an inventory location.

Occurrence: Conditional

location.geoCoordinates.latitudenumberThe latitude (North-South) component of the geographic coordinate. This field is required if a geoCoordinates container is used.

This field is returned if geographical coordinates are set for the inventory location.

Occurrence: Conditional

location.geoCoordinates.longitudenumberThe longitude (East-West) component of the geographic coordinate. This field is required if a geoCoordinates container is used.

This field is returned if geographical coordinates are set for the inventory location.

Occurrence: Conditional

location.locationIdstringA unique eBay-assigned ID for the location.

Note: This field should not be confused with the seller-defined merchantLocationKey value. It is the merchantLocationKey value which is used to identify an inventory location when working with inventory location API calls. The locationId value is only used internally by eBay.

Occurrence: Always

locationAdditionalInformationstringThis text field provides additional information about an inventory location. This field is returned if it is set for the inventory location.

Max length: 256

Occurrence: Conditional

locationInstructionsstringThis text field is used by the merchant to provide special pickup instructions for the store location. This field can help create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field was not set up through a createInventoryLocation or a updateInventoryLocation call, eBay will use the default pickup instructions contained in the merchant's profile.

Max length: 1000

Occurrence: Conditional

locationTypesarray of StoreTypeEnumThis container defines the function of the inventory location. Typically, an inventory location will serve as a store or a warehouse, but in some cases, an inventory location may be both.

The location type of an inventory location defaults to WAREHOUSE if a location type is not specified when a merchant creates an inventory location.

Occurrence: Always

locationWebUrlstringThis text field shows the Website address (URL) associated with the inventory location. This field is returned if defined for the inventory location.

Max length: 512

Occurrence: Conditional

merchantLocationKeystringThe unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the createInventoryLocation call. Once this value is set for an inventory location, it cannot be modified.

Max length: 36

Occurrence: Always

merchantLocationStatusStatusEnumThis field indicates whether the inventory location is enabled (inventory can be loaded to location) or disabled (inventory can not be loaded to location). The merchant can use the enableInventoryLocation call to enable an inventory location in disabled status, or the disableInventoryLocation call to disable an inventory location in enabled status.

Occurrence: Always

namestringThe name of the inventory location. This name should be a human-friendly name as it will be displayed in In-Store Pickup and Click and Collect listings. For store inventory locations, this field is not required for the createInventoryLocation call, but a store inventory location must have a defined name value before an In-Store Pickup and Click and Collect enabled offer is published. So, if the seller omits this field in the createInventoryLocation call, it will have to be added later through a updateInventoryLocation call.

Max length: 1000

Occurrence: Conditional

operatingHoursarray of OperatingHoursThis container shows the regular operating hours for a store location during the days of the week. A dayOfWeekEnum field and an intervals container is shown for each day of the week that the store location is open.

Occurrence: Conditional

operatingHours.dayOfWeekEnumDayOfWeekEnumA dayOfWeekEnum value is required for each day of the week that the store location has regular operating hours.

This field is returned if operating hours are defined for the store location.

Occurrence: Conditional

operatingHours.intervalsarray of IntervalThis container is used to define the opening and closing times of a store's working day (defined in the dayOfWeekEnum field). An intervals container is needed for each day of the week that the store location is open. If a store location closes for lunch (or any other period during the day) and then reopens, multiple open and close pairs are needed

This container is returned if operating hours are defined for the store location.

Occurrence: Conditional

operatingHours.intervals.closestringThe close value is actually the time that the store closes. Local time (in Military format) is used. So, if a store closed at 8 PM local time, the close time would look like the following: 20:00:00. This field is conditionally required if the intervals container is used to specify working hours or special hours for a store.

This field is returned if set for the store location.

Occurrence: Conditional

operatingHours.intervals.openstringThe open value is actually the time that the store opens. Local time (in Military format) is used. So, if a store opens at 9 AM local time, the close time would look like the following: 09:00:00. This field is conditionally required if the intervals container is used to specify working hours or special hours for a store.

This field is returned if set for the store location.

Occurrence: Conditional

phonestringThe phone number for an inventory location. This field will typically only be set and returned for store locations.

Max length: 36

Occurrence: Conditional

specialHoursarray of SpecialHoursThis container shows the special operating hours for a store location on a specific date or dates.

Occurrence: Conditional

specialHours.datestringA date value is required for each specific date that the store location has special operating hours.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-04T07:09:00.000Z

This field is returned if set for the store location.

Occurrence: Conditional

specialHours.intervalsarray of IntervalThis container is used to define the opening and closing times of a store on a specific date (defined in the date field). An intervals container is needed for each specific date that the store has special operating hours. These special operating hours on the specific date override the normal operating hours for the specific day of the week. If a store location closes for lunch (or any other period during the day) and then reopens, multiple open and close pairs are needed.

This container is returned if set for the store location.

Occurrence: Required

specialHours.intervals.closestringThe close value is actually the time that the store closes. Local time (in Military format) is used. So, if a store closed at 8 PM local time, the close time would look like the following: 20:00:00. This field is conditionally required if the intervals container is used to specify working hours or special hours for a store.

This field is returned if set for the store location.

Occurrence: Conditional

specialHours.intervals.openstringThe open value is actually the time that the store opens. Local time (in Military format) is used. So, if a store opens at 9 AM local time, the close time would look like the following: 09:00:00. This field is conditionally required if the intervals container is used to specify working hours or special hours for a store.

This field is returned if set for the store location.

Occurrence: Conditional

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

Error codes

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

CodeDomainCategoryMeaning
25001API_INVENTORYAPPLICATIONSystem error. {additionalInfo}
25804API_INVENTORYREQUESTInput error. {additionalInfo}
25805API_INVENTORYREQUEST{fieldName} Not Found.

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: Get a Location by Key

This example retrieves a specific location.

Input

Specify the location you want to retrieve using the merchantLocationKey path parameter.
GET
https://api.ebay.com/sell/inventory/v1/location/store-1

Output

If the call is successful, it returns an HTTP status code of "200 OK", with a response body that contains the details of the specified location.