younifyd
Menu

Search Stores

Search Stores

GET/organizations/{organizationId}/store-search

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Search Stores action (under Shopper Stores).
  3. Fill in the fields below, then reference the result from later steps as {{searchStores.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

Query parameters

countryCodestring

The two letter ISO country code, such as "US". This value is required when a postalCode is provided.

distanceUnitstring

The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".

One ofkmmi

latitudenumber (double)

The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.

longitudenumber (double)

The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.

maxDistancenumber (double)

The area (radius) in distanceUnit where stores will be searched.

postalCodestring

The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

localeoneOf

A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.

limitinteger (int32)

Maximum records to retrieve per request, not to exceed 200. Defaults to 25.

Default 25

offsetinteger (int32)

Used to retrieve the results based on a particular resource offset.

Default 0

Response

Returns 200 with an object. Read it in later steps with {{searchStores.response.data.<field>}}.

dataarray<object>

The list of stores in the search result.

address1string

The primary address of the store.

address2string

The secondary address of the store.

citystring

The city of the store.

countryCodestring

A two letter uppercase country code conforming to the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 standard.

distancenumber (double)

The distance to the given geolocation where the stores will be searched, using the unit given in the attribute 'DistanceUnit' (miles or kilometers).

distanceUnitstring

The unit the distance attribute is measured in (either in miles or kilometers).

One ofkmmi

emailstring

The email address of the store.

faxstring

The fax number of the store.

idstringrequired

The id of the store.

imagestring

The store image.

inventoryIdstring

The inventory list id associated with this store.

latitudenumber (double)

The latitude of the store.

longitudenumber (double)

The longitude of the store.

namestring

The store name.

phonestring

The phone number of the store.

posEnabledboolean

Whether this store uses Store Point-of-Sale.

postalCodeany

The postal code of the store.

stateCodestring

The state code of the store.

storeEventsstring

The store events.

storeHoursstring

The opening hours of the store.

storeLocatorEnabledboolean

Whether this store should show up in store locator results.

json
{
  "data": [
    {
      "id": "string",
      "address1": "string",
      "address2": "string",
      "city": "string",
      "countryCode": "US",
      "distance": 0,
      "distanceUnit": "km",
      "email": "string",
      "fax": "string",
      "image": "string",
      "inventoryId": "string",
      "latitude": 0
    }
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.