Store Locator API Structure
Field Name DataType Required Instances Minimum Usage Maximum Usage Minimum Length Maximum Length XPath Documentation
StoreLocator AnyType Yes 0       /StoreLocator Root element , encapsulates the message for Store Locator.
  MessageHeader AnyType Yes 0 1 1   /StoreLocator/MessageHeader Encapsulates message Routing data. The elements included in this grouping are standard across all messages.
    Standard String Yes 0 1 1 1   /StoreLocator/MessageHeader/Standard Code identifying the schema controlling agency, for example, GSI. Allowable Values: Text string Required: Yes Length: 10 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore
    HeaderVersion String Yes 0 1 1 1   /StoreLocator/MessageHeader/HeaderVersion Version of the message being used. Each new version whole number represents a significant change from a previous whole version and reflects a need for upgrades. For example, a change from Version 1.X to 2.X represents a substantial change in the framework and would be a recommended upgrade point. A change in the number after the decimal represents a minor upgrade/modification to the framework. Allowable Values: Text string Required: Yes Length: 10 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore
    VersionReleaseNumber String Yes 0 1 1 1   /StoreLocator/MessageHeader/VersionReleaseNumber Release number within the current message header version number. Allowable Values: Text string Required: No Length: 15 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore
    SourceData AnyType Yes 0 1 1   /StoreLocator/MessageHeader/SourceData
      SourceId String Yes 0 1 1 1   /StoreLocator/MessageHeader/SourceData/SourceId Unique identifier of the System that originated the message. The SourceId is a unique identifier provided by the initiator of the message. For those messages originating from an Order Management System (OMS), it would be the unique OMS identifier. For those messages originating from a Warehouse Management System (WMS), it would be the unique WMS identifier. Allowable Values: Text string Required: Yes Length: 20 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore
      SourceType String Yes 0 1 1 1   /StoreLocator/MessageHeader/SourceData/SourceType The descriptive category/name/code used to define the system that originated the message. Allowable Values: OMS = Order Management System WMS = Warehouse Management System Required: Yes Length: 10 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore
    DestinationData AnyType Yes 1..n 1 -1   /StoreLocator/MessageHeader/DestinationData Encapsulates data related to the Destination or Receiving System.
      DestinationId String Yes 0 1 1 1   /StoreLocator/MessageHeader/DestinationData/DestinationId Unique identifier of the System that is the intended recipient of the message. There can be multiple DestinationId/DestinationType sets per message to allow for one message to be sent to multiple receiving systems. Allowable Values: Text string Required: Yes Length: 20 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore
      DestinationType String Yes 0 1 1 1   /StoreLocator/MessageHeader/DestinationData/DestinationType The descriptive category used to define the system that is the intended recipient of the message. Allowable Values: OMS = Order Management System, WMS = Warehouse Management System, FH= Fulfillment Hub. Required: Yes Length: 10 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore
    EventType String Yes 0 1 1 1   /StoreLocator/MessageHeader/EventType The name of the event to which the message pertains. Allowable Values: Varies depending on the feed, for example InventoryStatus Required: Yes Length: 35 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore.
    MessageData AnyType Yes 0 1 1   /StoreLocator/MessageHeader/MessageData Encapsulates message identification information unique to the eBay Enterprise Xchange.
      MessageId String Yes 0 1 1 1   /StoreLocator/MessageHeader/MessageData/MessageId Globally unique identifier for each Message. The Message ID is populated from the Source system and must be a global identifier for eBay Enterprise Xchange. Allowable Values: Text string Required: Yes Length: 20 Default Value: blank Restrictions: In cases when the Product Hub or Fulfillment Hub originates the message, this field is the unique Business Process ID (BPID). Aliases: N/A Offering: Exchange Platform, Webstore
      CorrelationId String No 0 0 1 1   /StoreLocator/MessageHeader/MessageData/CorrelationId When present, it must contain the MessageId value of an earlier eBay Enterprise Xchange Message to which this message relates. Allowable Values: Text string Required: No Length: 20 Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore
    CreateDateAndTime   Yes 0 1 1   /StoreLocator/MessageHeader/CreateDateAndTime Original message creation date and time assigned by the Source. Allowable Values: ISO 8601 standard with offset from UTC in xsd:datetime data format which is yyyy-mm-ddTHH:mm:ss-hh:mm for e.g. 2012-01-11T14:19:05-06:00. Required: Yes Length: Follows ISO 8601 standard with offset from UTC. Default Value: blank Restrictions: N/A Aliases: N/A Offering: Exchange Platform, Webstore.
  storefronts AnyType Yes 0 1 1   /StoreLocator/storefronts Encapsulates data for a Client's physical stores.
    storefront AnyType Yes 1..n 1 -1   /StoreLocator/storefronts/storefront Encapsulates data for a single physical store
      storefront_effective_start_date   No 0 0 1   /StoreLocator/storefronts/storefront/storefront_effective_start_date Not currently used in the store locator application. Date to start using the storefront data. Modified XML date format date with optional timezone in HH:MM format. YYYY-MM-DD[(+-)HH:MM] The element can also be empty.
      storefront_effective_end_date   No 0 0 1   /StoreLocator/storefronts/storefront/storefront_effective_end_date Not currently used in the store locator application. Date to end using the storefront data. Modified XML date format date with optional timezone in HH:MM format. YYYY-MM-DD[(+-)HH:MM] The element can also be empty.
      latitude Decimal Yes 0 1 1   /StoreLocator/storefronts/storefront/latitude The latitude of the store used for location mapping. Allowable Values: Format is a decimal number (+-)NN.[NNNNNNN] Required: Yes Length: TBD Default Value: blank Restrictions: N/A Aliases: N/A
      longitude Decimal Yes 0 1 1   /StoreLocator/storefronts/storefront/longitude The longitude of the store used for location mapping. Allowable Values: Format is a decimal number (+-)NN.[NNNNNNN] Required: Yes Length: TBD Default Value: blank Restrictions: N/A
      status   No 0 0 1   /StoreLocator/storefronts/storefront/status Can be used to control store location display. A - Active store that will be displayed I - Inactive store that will not be displayed. Default is A - Active.
      state_code String No 0 0 1 1   /StoreLocator/storefronts/storefront/state_code The state, province or other country sub-division code for the store address. Allowable Values: A valid code as specified by ISO 3166-2 SUB-DIVISION/STATE CODE value without the ISO Country Code prefix. Required: No Length: 20 Default Value: blank Restrictions: ISO 3166-2 SUB-DIVISION/STATE CODE value without the ISO Country Code prefix. Aliases: N/A
      country_code   Yes 0 1 1   /StoreLocator/storefronts/storefront/country_code Two digit country code. Allowable Values: Text string Required: Yes Length: TBD Default Value: blank Restrictions: Use of ISO 3166 alpha 2 code is recommended, but not required. See: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.. Aliases: N/A
      postal_code String Yes 0 1 1 1 10 /StoreLocator/storefronts/storefront/postal_code Typically, the string of letters and/or numbers that more closely specifies the delivery area than just the City component alone, for example, the Zip Code in the U.S. Allowable Values: Text string Required: Yes Length: 10 Default Value: blank Restrictions: N/A Aliases: N/A.
      email_address String No 0 0 1   /StoreLocator/storefronts/storefront/email_address The email address used to contact a specific store. Allowable Values: Text string Required: Yes Length: 100 Default Value: blank Restrictions: N/A Aliases: N/A
      phone_number String No 0 0 1 15 /StoreLocator/storefronts/storefront/phone_number Store Phone Number (unformatted). Allowable Values: Integer Required: No Length: 15 Default Value: blank Restrictions: N/A Aliases: N/A
      fax_number String No 0 0 1   /StoreLocator/storefronts/storefront/fax_number Store Fax number (unformatted). Allowable Values: Integer Required: No Length: 15 Default Value: blank Restrictions: N/A Aliases: N/A
      isp_eligible   No 0 0 1   /StoreLocator/storefronts/storefront/isp_eligible In Store Pickup program eligibility. 1 - participating in program. 0 - Not participating in program. Default - Not participating in program.
      sfs_eligible   No 0 0 1   /StoreLocator/storefronts/storefront/sfs_eligible Ship From Store program eligibility. . Allowable Values: 1 - participating in program. 0 - Not participating in program. Required: No Length: TBD Default Value: 0 Restrictions: N/A Aliases: N/A
      sts_eligible   No 0 0 1   /StoreLocator/storefronts/storefront/sts_eligible Ship To Store program eligibility. Allowable Values: 1 - participating in program. 0 - Not participating in program. Required: No Length: TBD Default Value: 0 Restrictions: N/A Aliases: N/A
      inventory_check_eligible   No 0 0 1   /StoreLocator/storefronts/storefront/inventory_check_eligible Inventory Lookup program eligibility. Allowable Values: 1 - participating in program. 0 - Not participating in program. Required: No Length: TBD Default Value: 0 Restrictions: N/A Aliases: N/A
      isp_reserve_eligible   No 0 0 1   /StoreLocator/storefronts/storefront/isp_reserve_eligible In Store Pickup Reservation program eligibility. Allowable Values: 1 - participating in program. 0 - Not participating in program. Required: No Length: TBD Default Value: 0 Restrictions: N/A Aliases: N/A
      marker_image_id String Yes 0 1 1 1 256 /StoreLocator/storefronts/storefront/marker_image_id Identifier to specify the map stickpin image.
      timezone_raw_gmt_offset Decimal No 0 0 1   /StoreLocator/storefronts/storefront/timezone_raw_gmt_offset The timezone offset from UTC expressed as a decimal number. The range is constrained to be +14.00 to -13.00. The default is 0.
      timezone_uses_daylight_savings_time   No 0 0 1   /StoreLocator/storefronts/storefront/timezone_uses_daylight_savings_time Flag to indicate if the TZ uses daylight savings time. The default is 0. (false TZ does not use daylight savings time)
      storefront_locales AnyType Yes 0 1 1   /StoreLocator/storefronts/storefront/storefront_locales Encapsulates locale specific store information.
        storefront_locale AnyType Yes 1..n 1 -1   /StoreLocator/storefronts/storefront/storefront_locales/storefront_locale Encapsulates store information for a single locale.
          location_name String Yes 0 1 1 1 200 /StoreLocator/storefronts/storefront/storefront_locales/storefront_locale/location_name Name of the physical store or store location.
          address1 String Yes 0 1 1 1 200 /StoreLocator/storefronts/storefront/storefront_locales/storefront_locale/address1 address 1 line
          address2 String No 0 0 1 200 /StoreLocator/storefronts/storefront/storefront_locales/storefront_locale/address2 address 2 line
          address3 String No 0 0 1 200 /StoreLocator/storefronts/storefront/storefront_locales/storefront_locale/address3 address 3 line
          address4 String No 0 0 1 200 /StoreLocator/storefronts/storefront/storefront_locales/storefront_locale/address4 address 4 line
        @operation   Yes 0          
        @locale_code   Yes 0          
          city String Yes 0 1 1 1   /StoreLocator/storefronts/storefront/storefront_locales/storefront_locale/city Locale -specific city name.
      schedules AnyType No 0 0 1   /StoreLocator/storefronts/storefront/schedules Encapsulates all sets of hours of operation data for the store.
        schedule AnyType Yes 1..n 1 -1   /StoreLocator/storefronts/storefront/schedules/schedule Encapsulates a single set of hours of operation data for the store
          schedule_effective_start_date   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/schedule_effective_start_date Not currently supported in the store locator application. Date to start using the schedule data. Modified XML date format date with optional timezone in HH:MM format. YYYY-MM-DD[(+-)HH:MM] The element can also be empty.
          schedule_effective_end_date   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/schedule_effective_end_date Not currently supported in the store locator application. Date to end using the schedule data. Modified XML date format date with optional timezone in HH:MM format. YYYY-MM-DD[(+-)HH:MM] The element can also be empty.
          start_display_date   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/start_display_date Not currently supported in the store locator application. Start date for displaying this schedule on the webstore.
          end_display_date   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/end_display_date Not currently supported in the store locator application. Start date for displaying this schedule on the webstore.
          closed_ind   Yes 0 1 1   /StoreLocator/storefronts/storefront/schedules/schedule/closed_ind Flag to indicate store is closed. 1 - the store is closed 0 - the store is open Default is 0 - the store is open.
          default_open   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/default_open Default time in hours minutes (24 hour clock) to be used for blank daily open times. Default is 0000.j
          default_close   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/default_close Default time in hours minutes (24 hour clock) to be used for blank daily closing times. Default is 0000
          opening_time_monday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/opening_time_monday Monday opening time in hours minutes (24 hour clock). Default is .
          closing_time_monday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closing_time_monday Monday closing time in hours minutes (24 hour clock). Default is .
          open_24_hr_monday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/open_24_hr_monday_ind Monday open 24 hour flag. 1 - store is open 24 hours. 0 - store is not open 24 hours.
          closed_monday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closed_monday_ind Monday closed flag. 1 - store is closed on Monday. 0 - store is not closed on Monday.
          opening_time_tuesday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/opening_time_tuesday Tuesday opening time in hours minutes (24 hour clock). Default is .
          closing_time_tuesday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closing_time_tuesday Tuesday closing time in hours minutes (24 hour clock). Default is .
          open_24_hr_tuesday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/open_24_hr_tuesday_ind Tuesday open 24 hour flag. 1 - store is open 24 hours. 0 - store is not open 24 hours.
          closed_tuesday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closed_tuesday_ind Tuesday closed flag. 1 - store is closed on Tuesday. 0 - store is not closed on Tuesday.
          opening_time_wednesday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/opening_time_wednesday Wednesday opening time in hours minutes (24 hour clock). Default is .
          closing_time_wednesday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closing_time_wednesday Wednesday closing time in hours minutes (24 hour clock). Default is .
          open_24_hr_wednesday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/open_24_hr_wednesday_ind Wednesday open 24 hour flag. 1 - store is open 24 hours. 0 - store is not open 24 hours.
          closed_wednesday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closed_wednesday_ind Wednesday closed flag. 1 - store is closed on Wednesday. 0 - store is not closed on Wednesday.
          opening_time_thursday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/opening_time_thursday Thursday opening time in hours minutes (24 hour clock). Default is .
          closing_time_thursday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closing_time_thursday Thursday closing time in hours minutes (24 hour clock). Default is .
          open_24_hr_thursday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/open_24_hr_thursday_ind Thursday open 24 hour flag. 1 - store is open 24 hours. 0 - store is not open 24 hours.
          closed_thursday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closed_thursday_ind Thursday closed flag. 1 - store is closed on Thursday. 0 - store is not closed on Thursday.
          opening_time_friday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/opening_time_friday Friday opening time in hours minutes (24 hour clock). Default is .
          closing_time_friday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closing_time_friday Friday closing time in hours minutes (24 hour clock). Default is .
          open_24_hr_friday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/open_24_hr_friday_ind Friday open 24 hour flag. 1 - store is open 24 hours. 0 - store is not open 24 hours.
          closed_friday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closed_friday_ind Friday closed flag. 1 - store is closed on Friday. 0 - store is not closed on Friday.
          opening_time_saturday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/opening_time_saturday Saturday opening time in hours minutes (24 hour clock). Default is .
          closing_time_saturday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closing_time_saturday Saturday closing time in hours minutes (24 hour clock). Default is .
          open_24_hr_saturday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/open_24_hr_saturday_ind Saturday open 24 hour flag. 1 - store is open 24 hours. 0 - store is not open 24 hours.
          closed_saturday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closed_saturday_ind Saturday closed flag. 1 - store is closed on Saturday. 0 - store is not closed on Saturday.
          opening_time_sunday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/opening_time_sunday Sunday opening time in hours minutes (24 hour clock). Default is .
          closing_time_sunday   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closing_time_sunday Sunday closing time in hours minutes (24 hour clock). Default is .
          open_24_hr_sunday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/open_24_hr_sunday_ind Sunday open 24 hour flag. 1 - store is open 24 hours. 0 - store is not open 24 hours.
          closed_sunday_ind   No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/closed_sunday_ind Sunday closed flag. 1 - store is closed on Sunday. 0 - store is not closed on Sunday.
          schedule_locales AnyType No 0 0 1   /StoreLocator/storefronts/storefront/schedules/schedule/schedule_locales Encapsulates locale specific store information
            schedule_locale AnyType Yes 1..n 1 -1   /StoreLocator/storefronts/storefront/schedules/schedule/schedule_locales/schedule_locale Encapsulates locale specific store information for a specific locale.
            @operation   Yes 0          
            @locale_code   Yes 0          
        @operation   Yes 0          
        @schedule_type   Yes 0          
              schedule_name String Yes 0 1 1   /StoreLocator/storefronts/storefront/schedules/schedule/schedule_locales/schedule_locale/schedule_name Not currently supported in the store locator application. The name of the schedule.
      attribs AnyType No 0 0 1   /StoreLocator/storefronts/storefront/attribs Encapsulates all attributes data for the store.
        attrib AnyType No 1..n 0 -1   /StoreLocator/storefronts/storefront/attribs/attrib Encapsulates a single attribute data for the store.
          attrib_effective_start_date   No 0 0 1   /StoreLocator/storefronts/storefront/attribs/attrib/attrib_effective_start_date Not currently supported in the store locator application. Date to start using the schedule data. Modified XML date format date with optional timezone in HH:MM format. YYYY-MM-DD[(+-)HH:MM] The element can also be empty.
          attrib_effective_end_date   No 0 0 1   /StoreLocator/storefronts/storefront/attribs/attrib/attrib_effective_end_date Not currently supported in the store locator application. Date to stop using the schedule data. Modified XML date format date with optional timezone in HH:MM format. YYYY-MM-DD[(+-)HH:MM] The element can also be empty.
        @operation   Yes 0          
        @locale_code   Yes 0          
        @storefront_attrib_tag   Yes 0          
          tag_text_value String Yes 0 1 1 1000 /StoreLocator/storefronts/storefront/attribs/attrib/tag_text_value The locale specific attrib text value.
      storefront_types AnyType Yes 0 1 1   /StoreLocator/storefronts/storefront/storefront_types Encapsulates all storefront_type data for the store.
        storefront_type AnyType Yes 1..n 1 -1   /StoreLocator/storefronts/storefront/storefront_types/storefront_type Encapsulates a single storefront_type data for the store.
        @operation   Yes 0          
    @storefront_id   Yes 0          
    @operation   Yes 0          
    @location_code   Yes 0          
  @environment   Yes 0          
  @store_code   Yes 0          
  @feed_update_type   Yes 0          
          type_id String Yes 0 1 1 100 /StoreLocator/storefronts/storefront/storefront_types/storefront_type/type_id Store Type is a designation used by the partner to group stores.