REST API - Store locator


Note

Starting with 7.10 our REST API is documented using Swagger notation accessible at developer.cloud.intershop.com.

URI

/stores

Http Method

GET

Short Description

Retrieves a list of stores and returns them to the client

Query Parameters

Parameters to narrow the store locations result:

  • postalCode - a postal code, search expressions are supported
  • countryCode - country code in ISO format
  • city - city, search expressions are supported
  • storeName - name of the store, search expressions are supported
  • usePreference - If set to true, than request check if pick up in store preference is enabled. If usePreference is set to true and the pick up in store preference is disabled, than response contains no stores. If usePreference is set to false, the pick up in store preference will ignored and response contains all listed stores.

usePreference:true | PickUpInStorePreference:true - all existing stores displayed

usePreference:true |  PickUpInStorePreference:false - no stores displayed

usePreference:false | PickUpInStorePreference:true - all existing stores displayed

usePreference:false | PickUpInStorePreference:false - all existing stores displayed

Example Requests

/stores?city=<city>&postalCode=<postalCode>&countryCode=<countryCode>&storeName=<storeName>&usePreference<true|false>

HTTP Status Codes

200 OK
204 No content

Description

A resource that will retrieve a list of stores locations, narrowed by the optional search parameters. If no stores are found the status code 204 No content is returned.

Cartridge

app_sf_rest

ApplicationB2C Web Shop, SMB Web Shop

Product Version

7.6

Product To Version

 

Status

final

JSON

Request Data Format

Request related java object

N/A

Request Example

N/A

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.b2c.capi.resource.store.locator.StoreLocatorResource
com.intershop.sellside.rest.b2c.capi.resourceobject.store.location.StoreRO

Response Example

{
  "elements": [
    {
      "name": "Factory Outlet B5",
      "type": "StoreLocation",
      "address": "Alter Spandauer Weg 1",
      "city": "Wustermark",
      "countryCode": "DE",
      "postalCode": "14641",
      "fax": "+49 (0) 33 234 - 90 420",
      "phoneBusiness": "+49 (0) 33 234 - 90 40",
      "email": "b5@test.intershop.de",
      "uuid": "rPMKABsm2RsAAAFOI8ss9GK2"
    },
    {
      "name": "Oceanside Paradies Store",
      "type": "StoreLocation",
      "address": "Wesenberger Chaussee 22",
      "city": "Mirow",
      "countryCode": "DE",
      "postalCode": "17252",
      "fax": "039829 1258",
      "phoneBusiness": "039829 1257",
      "email": "brandt@test.intershop.de",
      "uuid": "_bYKABsm48gAAAFOUsss9GK2"
    },
    {
      "name": "PrimTech Jena-Paradies",
      "type": "StoreLocation",
      "address": "Im Stadtzentrum 1",
      "city": "Jena",
      "countryCode": "DE",
      "postalCode": "07743",
      "fax": "123 456 788",
      "phoneBusiness": "123 456 789",
      "email": "jena@test.intershop.de",
      "uuid": "qOIKABsmqzoAAAFOXsss9GK2"
    },
    {
      "name": "PrimTechno Italia",
      "type": "StoreLocation",
      "address": "Via Del Pigneto 050",
      "city": "Roma",
      "countryCode": "IT",
      "postalCode": "00176",
      "fax": "914 597 947",
      "phoneBusiness": "914 597 946",
      "email": "ferrari@test.intershop.de",
      "uuid": "Dp8KABsmjV0AAAFOWsss9GK2"
    },
    {
      "name": "PrimeTech Retail Center1",
      "type": "StoreLocation",
      "address": "Cricklewood Lane 221b",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "14482",
      "fax": "020 8450 3031",
      "phoneBusiness": "020 8450 3030",
      "email": "ptuk@test.intershop.de",
      "uuid": "qPQKABsmyVkAAAFO8Mss9GK2"
    },
    {
      "name": "PrimeTech Superstore",
      "type": "StoreLocation",
      "address": "Gneisenaustraße 8",
      "city": "Leipzig",
      "countryCode": "DE",
      "postalCode": "04105",
      "fax": "+49 341 1234 457",
      "phoneBusiness": "+49 341 1234 456",
      "email": "primetechLE@test.intershop.de",
      "uuid": "BvQKABsmLE4AAAFO98ss9GK2"
    },
    {
      "name": "PrimeTech Village",
      "type": "StoreLocation",
      "address": "Bundesstraße 44",
      "city": "PrimeTech Village",
      "countryCode": "DE",
      "postalCode": "977877",
      "fax": "+49 (0)9342-91 99-112",
      "phoneBusiness": "+49 (0)9342-91 99-111",
      "email": "lederhose@test.intershop.de",
      "uuid": "ibsKABsmlFIAAAFO9Mss9GK2"
    },
    {
      "name": "PrimeTechOutlet France",
      "type": "StoreLocation",
      "address": "Rue Rivoli 12",
      "city": "Paris",
      "countryCode": "FR",
      "postalCode": "75001",
      "fax": "01 44 50 03 11",
      "phoneBusiness": "01 44 50 03 10",
      "email": "jaques@test.intershop.de",
      "uuid": "bEIKABsmOnEAAAFOa8ss9GK2"
    },
    {
      "name": "PrimoTecho Espagnol",
      "type": "StoreLocation",
      "address": "Santa Juliana 13S",
      "city": "Madrid",
      "countryCode": "ES",
      "postalCode": "28039",
      "fax": "914 597 947",
      "phoneBusiness": "914 597 946",
      "email": "hola@test.intershop.de",
      "uuid": "2DUKABsmHxUAAAFOZsss9GK2"
    },
    {
      "name": "Store Berlin",
      "type": "StoreLocation",
      "address": "Marlene-Dietrich-Allee 44",
      "city": "Potsdam",
      "countryCode": "DE",
      "postalCode": "14482",
      "fax": "035187756",
      "phoneBusiness": "035187703",
      "email": "mlehmann@test.intershop.de",
      "uuid": "EC0KABsmFZYAAAFOSsss9GK2"
    }
  ],
  "type": "Stores"
}

XML

XML Request Data Format

XML Request Java Objects

N/A

XML Request Example

N/A

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.b2c.capi.resource.store.locator.StoreLocatorResource
com.intershop.sellside.rest.b2c.capi.resourceobject.store.location.StoreLocationRO

XML Response Example

<Stores type="Stores">
  <elements>
    <StoreLocation name="Factory Outlet B5" type="StoreLocation">
      <address>Alter Spandauer Weg 1</address>
      <city>Wustermark</city>
      <countryCode>DE</countryCode>
      <email>b5@test.intershop.de</email>
      <fax>+49 (0) 33 234 - 90 420</fax>
      <phoneBusiness>+49 (0) 33 234 - 90 40</phoneBusiness>
      <postalCode>14641</postalCode>
      <uuid>rPMKABsm2RsAAAFOI8ss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="Oceanside Paradies Store" type="StoreLocation">
      <address>Wesenberger Chaussee 22</address>
      <city>Mirow</city>
      <countryCode>DE</countryCode>
      <email>brandt@test.intershop.de</email>
      <fax>039829 1258</fax>
      <phoneBusiness>039829 1257</phoneBusiness>
      <postalCode>17252</postalCode>
      <uuid>_bYKABsm48gAAAFOUsss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="PrimTech Jena-Paradies" type="StoreLocation">
      <address>Im Stadtzentrum 1</address>
      <city>Jena</city>
      <countryCode>DE</countryCode>
      <email>jena@test.intershop.de</email>
      <fax>123 456 788</fax>
      <phoneBusiness>123 456 789</phoneBusiness>
      <postalCode>07743</postalCode>
      <uuid>qOIKABsmqzoAAAFOXsss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="PrimTechno Italia" type="StoreLocation">
      <address>Via Del Pigneto 050</address>
      <city>Roma</city>
      <countryCode>IT</countryCode>
      <email>ferrari@test.intershop.de</email>
      <fax>914 597 947</fax>
      <phoneBusiness>914 597 946</phoneBusiness>
      <postalCode>00176</postalCode>
      <uuid>Dp8KABsmjV0AAAFOWsss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="PrimeTech Retail Center1" type="StoreLocation">
      <address>Cricklewood Lane 221b</address>
      <city>London</city>
      <countryCode>GB</countryCode>
      <email>ptuk@test.intershop.de</email>
      <fax>020 8450 3031</fax>
      <phoneBusiness>020 8450 3030</phoneBusiness>
      <postalCode>14482</postalCode>
      <uuid>qPQKABsmyVkAAAFO8Mss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="PrimeTech Superstore" type="StoreLocation">
      <address>Gneisenaustraße 8</address>
      <city>Leipzig</city>
      <countryCode>DE</countryCode>
      <email>primetechLE@test.intershop.de</email>
      <fax>+49 341 1234 457</fax>
      <phoneBusiness>+49 341 1234 456</phoneBusiness>
      <postalCode>04105</postalCode>
      <uuid>BvQKABsmLE4AAAFO98ss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="PrimeTech Village" type="StoreLocation">
      <address>Bundesstraße 44</address>
      <city>PrimeTech Village</city>
      <countryCode>DE</countryCode>
      <email>lederhose@test.intershop.de</email>
      <fax>+49 (0)9342-91 99-112</fax>
      <phoneBusiness>+49 (0)9342-91 99-111</phoneBusiness>
      <postalCode>977877</postalCode>
      <uuid>ibsKABsmlFIAAAFO9Mss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="PrimeTechOutlet France" type="StoreLocation">
      <address>Rue Rivoli 12</address>
      <city>Paris</city>
      <countryCode>FR</countryCode>
      <email>jaques@test.intershop.de</email>
      <fax>01 44 50 03 11</fax>
      <phoneBusiness>01 44 50 03 10</phoneBusiness>
      <postalCode>75001</postalCode>
      <uuid>bEIKABsmOnEAAAFOa8ss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="PrimoTecho Espagnol" type="StoreLocation">
      <address>Santa Juliana 13S</address>
      <city>Madrid</city>
      <countryCode>ES</countryCode>
      <email>hola@test.intershop.de</email>
      <fax>914 597 947</fax>
      <phoneBusiness>914 597 946</phoneBusiness>
      <postalCode>28039</postalCode>
      <uuid>2DUKABsmHxUAAAFOZsss9GK2</uuid>
    </StoreLocation>
    <StoreLocation name="Store Berlin" type="StoreLocation">
      <address>Marlene-Dietrich-Allee 44</address>
      <city>Potsdam</city>
      <countryCode>DE</countryCode>
      <email>mlehmann@test.intershop.de</email>
      <fax>035187756</fax>
      <phoneBusiness>035187703</phoneBusiness>
      <postalCode>14482</postalCode>
      <uuid>EC0KABsmFZYAAAFOSsss9GK2</uuid>
    </StoreLocation>
  </elements>
</Stores>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets