eBay Location API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Location. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
7 operations
across 5 paths,
and defines 11 schemas.
It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
7 operations5 paths11 schemas1 DELETE2 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
eBay Location API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth — The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Location 7
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 th…
getInventoryLocation1 param→ 200400404500
POST
/location/{merchantLocationKey}
Use this call to create a new inventory location. In order to create and publish an offer (and create an eBay listing), a seller must have at least one inventory location, as every offer must be asso…
createInventoryLocation2 paramsbody→ 204400409500
DELETE
/location/{merchantLocationKey}
This call deletes the inventory location that is specified in the merchantLocationKey path parameter. Note that deleting a location will not affect any active eBay listings associated with the delete…
deleteInventoryLocation1 param→ 204400404500
POST
/location/{merchantLocationKey}/disable
This call disables the inventory location that is specified in the merchantLocationKey path parameter. Sellers can not load/modify inventory to disabled inventory locations. Note that disabling an in…
disableInventoryLocation1 param→ 200400404500
POST
/location/{merchantLocationKey}/enable
This call enables a disabled inventory location that is specified in the merchantLocationKey path parameter. Once a disabled inventory location is enabled, sellers can start loading/modifying invento…
enableInventoryLocation1 param→ 200400404500
GET
/location
This call retrieves all defined details for every inventory location associated with the seller's account. There are no required parameters for this call and no request payload. However, there are tw…
Use this call to update non-physical location details for an existing inventory location. Specify the inventory location you want to update using the merchantLocationKey path parameter. You can updat…
updateInventoryLocation2 paramsbody→ 204400404500
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are InventoryLocationResponse (11 properties), InventoryLocationFull (10 properties), InventoryLocation (7 properties), Address (7 properties). Each schema is shown below with its type and property counts.
InventoryLocation
object
This type is used by the updateInventoryLocation call to update operating hours, special hours, phone number, and other minor details of an inventory location.
7 properties
InventoryLocationFull
object
This type is used by the createInventoryLocation call to provide details on the inventory location, including the location's name, physical address, operating…
10 properties
Address
object
This type is used to define the physical address of an inventory location.
7 properties
Location
object
A complex type that is used to provide the physical address of a location, and it geo-coordinates.
3 properties
OperatingHours
object
This type is used to express the regular operating hours of a merchant's store during the days of the week.
2 properties
SpecialHours
object
This type is used to express the special operating hours of a store location on a specific date. A specialHours container is needed when the store's opening ho…
2 properties
GeoCoordinates
object
This type is used to express the Global Positioning System (GPS) latitude and longitude coordinates of an inventory location.
2 properties
LocationDetails
object
This type is used by the createInventoryLocation call to provide an full or partial address of an inventory location.
2 properties
InventoryLocationResponse
object
This type is used by the base response of the getInventoryLocation and getInventoryLocations calls. These responses provide details about inventory location(s)…
11 properties
LocationResponse
object
This type is used by the base response payload for the getInventoryLocations call.
7 properties
Interval
object
This type is used by the intervals container to define the opening and closing times of a store's working day. Local time (in Military format) is used, with th…
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
