Skip to main content

This type is used by the base response of the getInventoryLocation and getInventoryLocations calls. These responses provide details about inventory location(s) defined for the merchant's account.

Type that uses InventoryLocationResponse

LocationResponse

Calls that use InventoryLocationResponse

Fields

Field
Type
Description
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 a store or fulfillment center location, 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.
locationAdditionalInformation
This text field provides additional information about an inventory location. This field is returned if it is set for the location.
locationInstructions
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.
locationTypes
array of StoreTypeEnum
This container defines the function of the inventory location. Typically, a location will serve as a store, warehouse, or fulfillment center, but in some cases, an inventory location may be more than one type.
locationWebUrl
This text field shows the Website address (URL) associated with the inventory location. This field is returned if defined for the location.
merchantLocationKey
The unique identifier of the inventory location. This identifier is set up by the merchant when the location is first created with the createInventoryLocation call.
merchantLocationStatus
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 a location in disabled status, or the disableInventoryLocation call to disable a location in enabled status.
name
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.
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 location is open.
phone
The phone number for an inventory location. This field will typically only be returned for store locations.
specialHours
array of SpecialHours
This container shows the special operating hours for a store or fulfillment center location on a specific date or dates.
timeZoneId
This field specifies the time zone of the inventory location being created. This value should be in Olson format (for example America/Vancouver). For supported values, see Java Supported Zone Ids and Offsets.
fulfillmentCenterSpecifications
This container provides information about a fulfillment center's shipping specifications, such as the weekly cut-off time schedule for order handling and any cut-off time overrides.

Note: This field is only returned for fulfillment center locations.