updateInventoryLocation

This container is used to add any addition physical address and geographical coordinate information for a warehouse, store, or fulfillment center inventory location.

Note: For warehouse and store inventory locations, address fields can be updated any number of times. For fulfilment center locations, address fields cannot be updated. However, if any address fields were omitted during the createInventoryLocation call, they can be added through this method.
Note: When updating a warehouse location to a fulfillment center, sellers can update any of the address fields a single time during the same call used to make this update. After this, they can no longer be updated.

Occurrence: Optional

This required container sets the physical address of an inventory location. Except in the case store or fulfillment center location, a full address is not a requirement when setting up a location. For warehouse locations, the fields required in this container are either of the following sets:

• city, stateOrProvince, and country
• postalCode and country

Occurrence: Required

The first line of a street address. This field is required for store and fulfillment center locations. A street address is not required for warehouse locations.

This field will be returned if defined for an inventory location.

Max length: 128

Occurrence: Conditional

The second line of a street address. This field can be used for additional address information, such as a suite or apartment number.

This field will be returned if defined for an inventory location.

Max length: 128

Occurrence: Conditional

The city in which the inventory location resides. This field is required for store and fulfillment center locations. 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 postal code and this field is technically optional.

This field is returned if defined for an inventory location.

Max length: 128

Occurrence: Conditional

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.

Occurrence: Required

The county in which the address resides.

This field is returned if defined for an inventory location.

Occurrence: Optional

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. This field is required for store and fulfillment center locations.

For warehouse locations, this field is conditionally required if a city and stateOrProvince pair is not provided.

Note: For warehouse locations, city and 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

The state/province in which the inventory location resides. This field is required for store and fulfillment center locations. 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.

Max length: 128

Occurrence: Conditional

This container is used to set the Global Positioning System (GPS) latitude and longitude coordinates for the inventory location.

Geographical coordinates are required for the location of In-Store Pickup inventory.

Occurrence: Conditional

The 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 location.

Example: 33.089805

Occurrence: Conditional

The 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 location.

Example: -88.709822

Occurrence: Conditional

This text field is used by the merchant to provide/update additional information about an inventory location. Whatever text is passed in this field will replace the current text string defined for this field. If the text will not change, the same text should be passed in once again.

Max length: 256

Occurrence: Conditional

This text field is generally used by the merchant to provide/update 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). Whatever text is passed in this field will replace the current text string defined for this field. If the text will not change, the same text should be passed in once again.

Max length: 1000

Occurrence: Conditional

This container is used to update the location type(s) associated with an inventory location.

Occurrence: Optional

This text field is used by the merchant to provide/update the Website address (URL) associated with the inventory location. The URL that is passed in this field will replace any other URL that may be defined for this field.

Max length: 512

Occurrence: Conditional

This text field is used by the merchant to update the name of the inventory location. This name should be a human-friendly name as it will be in In-Store Pickup and Click and Collect listings. A name is not required for warehouse locations. For store 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 omitted this field in the createInventoryLocation call, it is required for an updateInventoryLocation call. The name that is passed in this field will replace any other name that may be defined for this field.

Occurrence: Optional

This container is used to provide/update the regular operating hours for a store location during the days of the week. A dayOfWeekEnum field and an intervals container will be needed for each day of the week that the location is open. Note that if operating hours are already set for a location for a specific day of the week, whatever is set through an updateInventoryLocation call will override those existing hours.

Occurrence: Conditional

A 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

This container is used to define the opening and closing times of a store location'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

The close value is actually the time that the store location 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

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: 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

This text field is used by the merchant to provide/update the phone number for the inventory location. The phone number that is passed in this field will replace any other phone number that may be defined for this field.

Max length: 36

Occurrence: Optional

This container is used to provide/update the special operating hours for a store 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. If special hours have already been set up for an inventory location, specifying special hours through an updateInventoryLocation call will only add to the list, unless the date(s) used are the same special date(s) already set up, in which case, the special hours set up through the updateInventoryLocation call will override the existing special hours.

Occurrence: Conditional

A 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

This container is used to define the opening and closing times of a store location 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: Conditional

The close value is actually the time that the store location 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

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: 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

This field is used to provide/update 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.

Note: If specified, this time zone will be used for all hour related fields. If this field is not specified, the time zone will be calculated from the provided address fields.

Occurrence: Optional

This container is used to update information about a fulfillment center's shipping specifications, such as the weekly cut-off time schedule for order handling and any cut-off overrides.

Occurrence: Optional

Note: This container only applies to listings with same-day handling.
This container specifies cut-off time(s) for order handling (and optionally cut-off overrides) at a fulfillment center location.

For example, if the cut-off time for order handling is 14:00, any orders made after this time will be handled on the next available business day.

Note: Shipping cut-off times must be specified if one of the locationTypes of the inventory location is FULFILLMENT_CENTER.

Occurrence: Conditional

This container can be used to override the existing cut-off time(s), specified in the weeklySchedule container, for a specific date or date range.

Occurrence: Optional

This field is used to override the cut-off time(s) specified in the weeklySchedule container. If an order is placed after this time in the specified date or date range, it will be handled by the seller on the following day.

Format: 00:00

Occurrence: Conditional

The end date of the cut-off time override in ISO 8601 format, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Note: If the cut-off time override is only for a single day, input the same date in the startDate and endDate fields.
Format: [YYYY]-[MM]-[DD]

Example: 2024-08-06

Note: The time zone for this date is specified from the timeZoneId field. If this field is not used, the time zone will be derived from the provided address.

Occurrence: Conditional

The start date of the cut-off time override in ISO 8601 format, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Note: If the cut-off time override is only for a single day, input the same date in the startDate and endDate fields.
Format: [YYYY]-[MM]-[DD]

Example: 2024-08-04

Note: The time zone for this date is specified from the timeZoneId field. If this field is not used, the time zone will be derived from the provided address.

Occurrence: Conditional

This container is used to specify the weekly schedule for shipping and handling cut-off times. A cut-off time is required for each business day that the fulfillment center operates. Any orders made after the specified cutOffTime on the specified day(s) of the week will be handled on the next day.

Occurrence: Conditional

This field specifies the cut-off times (in 24-hour format) for the business day(s) specified in the dayOfWeekEnum array.

Cut-off times default to the time zone of the specified address if the timeZoneId is not provided.

Note: If cut-off hours are not specified for a particular day, the fulfillment center is considered to be on holiday for that day.
Format: 00:00

Occurrence: Conditional

This comma-separated array defines the days of week for which the specified cutOffTime is used.

Occurrence: Conditional