References

The following page lists available REST APIs for ICM 11 and their version dependencies:

Reference - Intershop Commerce Management 11 REST API

API Specification

Introduction

OpenAPI Version: 3.0.1

Store Version: 1.0.0

The Store REST API provides store locator functionality.

Changelog

Version 1.0.0

Created a separate REST API 'Store' out of 'Shop'

Store Locator API

/stores

GET: Store locator

Description

Retrieves a list of stores and returns them to the client

Java Method

public com.intershop.sellside.rest.common.capi.resource.store.locator.StoreLocatorResource$StoreROResourceCollection com.intershop.sellside.rest.common.capi.resource.store.locator.StoreLocatorResource.getStores(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean)

Request Body

Request Parameters

Location	Name	Format	Description
in query	postalCode	string	a postal code, search expressions are supported
in query	countryCode	string	country code in ISO format
in query	city	string	city, search expressions are supported
in query	storeName	string	name of the store, search expressions are supported
in query	usePreference	boolean	If set to true, check if the pick up in store preference is enabled. If usePreference is set to true and the pick up in store preference is disabled, the response contains no stores. If usePreference is set to false, the pick up in store preference will be ignored and the response will contain all listed stores.

Response

200 - OK

StoreROResourceCollection application/json

204 - No Content

Request and Response Object Schemata

StoreROResourceCollection application/json

{

"pageable":
string
The pageable ID
"total":
integer
The pageable amount total | Format: int32
"offset":
integer
The pageable offset | Format: int32
"amount":
integer
The pageable amount | Format: int32
"elements":
array
An array of StoreRO objects. The list of elements
[
StoreRO: The list of elements
{
- "name":
  string
  The name of an element | Example: Factory Outlet B5
- "type":
  string
  The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: StoreLocation
- "address2":
  string
- "address3":
  string
- "postalCode":
  string
  the postal code of the stores location | Example: 14641
- "city":
  string
  the city the store is located in | Example: Wustermark
- "country":
  string
- "countryCode":
  string
  the country code of the store | Example: DE
- "email":
  string
  the email address of the store | Example: b5@test.intershop.de
- "fax":
  string
  the fax number of the store | Example: +49 (0) 33 234 - 90 420
- "phoneBusiness":
  string
  the business phone number of the store | Example: +49 (0) 33 234 - 90 40
- "phoneBusinessDirect":
  string
- "firstName":
  string
- "lastName":
  string
- "firstLastName":
  string
- "uuid":
  string
  the uuid of the store | Example: rPMKABsm2RsAAAFOI8ss9GK2
- "latitude":
  string
  Latitude of the Stores location | Example: 52.45323
- "longitude":
  string
  Longitude of the Stores location | Example: 12.02345
- "address":
  string
  the address of the store | Example: Alter Spandauer Weg 1
}
]
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type.
"sortKeys":
array
An array of string literals. The keys to sort for
"name":
string
The name of an element

}

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.