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 associated with a location.
Important!Publish offer note: Fields may be optional or conditionally required when calling this method, but become required when publishing the offer to create an active listing. For this method, see Location fields for a list of fields required to publish an offer.
Upon first creating an inventory location, only a seller-defined location identifier and a physical location is required, and once set, these values can not be changed. The unique identifier value (merchantLocationKey) is passed in at the end of the call URI. This merchantLocationKey value will be used in other Inventory Location calls to identify the inventory location to perform an action against.
At this time, location types are either warehouse or store. Warehouse locations are used for traditional shipping, and store locations are generally used by US merchants selling products through the In-Store Pickup program, or used by UK, Australian, and German merchants selling products through the Click and Collect program. A full address is required for store inventory locations. However, for warehouse inventory locations, a full street address is not needed, but the city, state/province, and country of the location must be provided.
Note that all inventory locations are "enabled" by default when they are created, and you must specifically disable them (by passing in a value of DISABLED
in the merchantLocationStatus field) if you want them to be set to the disabled state. The seller's inventory cannot be loaded to inventory locations in the disabled state.
Unless one or more errors and/or warnings occur with the call, there is no response payload for this call. A successful call will return an HTTP status value of 204 No Content.
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, seller-defined key (ID) for an inventory location. 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.
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 |
---|---|---|
Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
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
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
Input container/field | Type | Description |
---|---|---|
location | LocationDetails | This required container is used to set the physical address and geographical coordinates (optional) of a warehouse or store inventory location. A warehouse inventory location only requires the city, province/state, and country, and does not require a full street address. However, the seller may still supply a full street address for a warehouse location. The physical location/address for an inventory location cannot be modified once set with a createInventoryLocation call. All other details of an inventory location (e.g. phone or operating hours) can be changed with an updateInventoryLocation call. Occurrence: Required |
location.address | Address | This required container sets the physical address of an inventory location. 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. For warehouse locations, the fields required in this container are either of the following sets:
Occurrence: Required |
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: Required |
location.address.county | string | The county in which the address resides. Occurrence: Optional |
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: Conditional |
location.geoCoordinates | GeoCoordinates | This container is used to set the Global Positioning System (GPS) latitude and longitude coordinates for the 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 |
locationAdditionalInformation | string | This text field is used by the merchant to provide additional information about an inventory location. Occurrence: Optional |
locationInstructions | string | This text field is generally used by the merchant to provide special pickup instructions for a store inventory location. Although this field is optional, it is recommended that merchants provide this field to create a pleasant and easy pickup experience for In-Store Pickup and Click and Collect orders. If this field is not included in the call request payload, eBay will use the default pickup instructions contained in the merchant's profile (if available). Occurrence: Optional |
locationTypes | array of StoreTypeEnum | This container is used to define 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: Conditional |
locationWebUrl | string | This text field is used by the merchant to provide the Website address (URL) associated with the inventory location. Occurrence: Optional |
merchantLocationStatus | StatusEnum | This field is used to indicate whether the inventory location will be enabled (inventory can be loaded to location) or disabled (inventory can not be loaded to location). If this field is omitted, a successful createInventoryLocation call will automatically enable the inventory location. A merchant may want to create a new inventory location but leave it as disabled if the inventory location is not yet ready for active inventory. Once the inventory location is ready, the merchant can use the enableInventoryLocation call to enable an inventory location that is in a disabled state. Occurrence: Optional |
name | string | The seller-defined 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. A name is not required for warehouse inventory locations. For store inventory locations, this field is not immediately required, but will be required before an offer enabled with the In-Store Pickup or Click and Collect capability can be published. So, if the seller omits this field in a createInventoryLocation call, it becomes required for an updateInventoryLocation call. Occurrence: Conditional |
operatingHours | array of OperatingHours | Although not technically required, this container is highly recommended to be used to specify operating hours for a store inventory location. This container is used to express the regular operating hours for a store location during each day of the week. A dayOfWeekEnum field and an intervals container will be needed for each day of the week that the store location is open. Occurrence: Optional |
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 | This field is used to specify the phone number for an inventory location. Occurrence: Required |
specialHours | array of SpecialHours | This container is used to express the special operating hours for a store inventory location on a specific date, such as a holiday. The special hours specified for the specific date will override the normal operating hours for that particular day of the week. Occurrence: Optional |
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 |
Output
HTTP response headers
This call has no response headers.
Response payload
This call has no payload.
Response fields
This call has no field definitions.
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 |
---|---|
204 | No Content |
400 | Bad Request |
409 | Location Already Exists |
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} |
25800 | API_INVENTORY | REQUEST | Invalid {fieldName}. |
25801 | API_INVENTORY | REQUEST | Missing field {fieldName}. |
25802 | API_INVENTORY | REQUEST | Input error. {additionalInfo} |
25803 | API_INVENTORY | REQUEST | {fieldName} already exists. |
25804 | API_INVENTORY | REQUEST | Input error. {additionalInfo} |
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: Create a location
Use this operation to configure warehouse and store locations that sellers can use to track the storage of the items in their inventory.
Input
Suppy a unique seller-defined merchantLocationKey as a path parameter in this call.
POSThttps://api.ebay.com/sell/inventory/v1/location/"W********1"
Output
A successful call returns the HTTP status code 204 No content. This method has no response payload.