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
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 |
---|---|---|
merchantLocationKey | string | This path parameter specifies the unique merchant-defined key (ID) for an inventory location that is being retrieved. Use the getInventoryLocations method to retrieve merchant location keys. 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.
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/api_scope/sell.inventory.readonly
https://api.ebay.com/oauth/api_scope/sell.inventory
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 |
---|---|---|
location | Location | This 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: Always |
location.address | Address | The 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: Always |
location.address.addressLine1 | string | The 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. Occurrence: Conditional |
location.address.addressLine2 | string | The 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. Occurrence: Conditional |
location.address.city | string | The 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 conditionally required as part of a city and stateOrProvince pair if a postalCode is not provided. If a postalCode is provided, the city is derived from the provided zip code and this field is technically optional. Occurrence: Conditional |
location.address.country | CountryCodeEnum | The country in which the address resides, represented as two-letter ISO 3166 country code. For example, Occurrence: Always |
location.address.county | string | The county in which the address resides. Occurrence: Conditional |
location.address.postalCode | string | The 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 uses postal codes (origin and destination) to estimate shipping costs when the seller uses calculated shipping. Occurrence: Conditional |
location.address.stateOrProvince | string | The 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 conditionally required as part of a city and stateOrProvince pair if a postalCode is not provided. If a postalCode is provided, the state or province is derived from the provided zip code and this field is technically optional. Occurrence: Always |
location.geoCoordinates | GeoCoordinates | This 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.latitude | number | The latitude (North-South) component of the geographic coordinate. This field is required if a geoCoordinates container is used. Occurrence: Conditional |
location.geoCoordinates.longitude | number | The longitude (East-West) component of the geographic coordinate. This field is required if a geoCoordinates container is used. Occurrence: Conditional |
location.locationId | string | A unique eBay-assigned ID for the location. Occurrence: Always |
locationAdditionalInformation | string | This text field provides additional information about an inventory location. This field is returned if it is set for the inventory location. Occurrence: Conditional |
locationInstructions | string | This 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. Occurrence: Conditional |
locationTypes | array of StoreTypeEnum | This 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. Occurrence: Always |
locationWebUrl | string | This text field shows the Website address (URL) associated with the inventory location. This field is returned if defined for the inventory location. Occurrence: Conditional |
merchantLocationKey | string | The 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. Occurrence: Always |
merchantLocationStatus | StatusEnum | This 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 |
name | string | The 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. Occurrence: Conditional |
operatingHours | array of OperatingHours | This 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.dayOfWeekEnum | DayOfWeekEnum | A dayOfWeekEnum value is required for each day of the week that the store location has regular operating hours. Occurrence: Conditional |
operatingHours.intervals | array of Interval | This 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 Occurrence: Conditional |
operatingHours.intervals.close | string | The 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: Occurrence: Conditional |
operatingHours.intervals.open | string | The 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: Occurrence: Conditional |
phone | string | The phone number for an inventory location. This field will typically only be set and returned for store locations. Occurrence: Always |
specialHours | array of SpecialHours | This container shows the special operating hours for a store location on a specific date or dates. Occurrence: Conditional |
specialHours.date | string | A date value is required for each specific date that the store location has special operating hours. Occurrence: Conditional |
specialHours.intervals | array of Interval | This 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. Occurrence: Conditional |
specialHours.intervals.close | string | The 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: Occurrence: Conditional |
specialHours.intervals.open | string | The 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: 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.
Status | Meaning |
---|---|
200 | Success |
400 | Bad Request |
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 |
---|---|---|---|
25001 | API_INVENTORY | APPLICATION | System error. {additionalInfo} |
25804 | API_INVENTORY | REQUEST | Input error. {additionalInfo} |
25805 | API_INVENTORY | REQUEST | {fieldName} 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: Get a Location by Key
This example retrieves a specific location.
Input
Specify the location you want to retrieve using the merchantLocationKey path parameter.
GEThttps://api.ebay.com/sell/inventory/v1/location/s*****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.