Options
All
  • Public
  • Public/Protected
  • All
Menu

Module shopperStores

Index

References

DistanceUnit

Re-exports DistanceUnit

DistanceUnit

Re-exports DistanceUnit

ErrorResponse

Re-exports ErrorResponse

ErrorResponse

Re-exports ErrorResponse

GetStoresPersonalizedEnum

Re-exports GetStoresPersonalizedEnum

GetStoresPersonalizedEnum

Re-exports GetStoresPersonalizedEnum

GetStoresSfdcDwDntEnum

Re-exports GetStoresSfdcDwDntEnum

GetStoresSfdcDwDntEnum

Re-exports GetStoresSfdcDwDntEnum

LocaleCode

Re-exports LocaleCode

LocaleCode

Re-exports LocaleCode

PaginatedResultBase

Re-exports PaginatedResultBase

PaginatedResultBase

Re-exports PaginatedResultBase

ResultBase

Re-exports ResultBase

ResultBase

Re-exports ResultBase

SearchStoresPersonalizedEnum

Re-exports SearchStoresPersonalizedEnum

SearchStoresPersonalizedEnum

Re-exports SearchStoresPersonalizedEnum

SearchStoresSfdcDwDntEnum

Re-exports SearchStoresSfdcDwDntEnum

SearchStoresSfdcDwDntEnum

Re-exports SearchStoresSfdcDwDntEnum

ShopperStores

Re-exports ShopperStores

ShopperStores

Re-exports ShopperStores

ShopperStoresParameters

Re-exports ShopperStoresParameters

ShopperStoresParameters

Re-exports ShopperStoresParameters

ShopperStoresPathParameters

Re-exports ShopperStoresPathParameters

ShopperStoresPathParameters

Re-exports ShopperStoresPathParameters

ShopperStoresQueryParameters

Re-exports ShopperStoresQueryParameters

ShopperStoresQueryParameters

Re-exports ShopperStoresQueryParameters

Store

Re-exports Store

Store

Re-exports Store

StoreResult

Re-exports StoreResult

StoreResult

Re-exports StoreResult

Stores

Re-exports Stores

Stores

Re-exports Stores

defaultBaseUri

Re-exports defaultBaseUri

getStoresPathParameters

Re-exports getStoresPathParameters

getStoresPathParameters

Re-exports getStoresPathParameters

getStoresQueryParameters

Re-exports getStoresQueryParameters

getStoresQueryParameters

Re-exports getStoresQueryParameters

searchStoresPathParameters

Re-exports searchStoresPathParameters

searchStoresPathParameters

Re-exports searchStoresPathParameters

searchStoresQueryParameters

Re-exports searchStoresQueryParameters

searchStoresQueryParameters

Re-exports searchStoresQueryParameters

Type aliases

DistanceUnit

DistanceUnit: "km" | "mi"

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

ErrorResponse

ErrorResponse: { detail: string; instance?: undefined | string; title: string; type: string } & {}
property

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

  • Max Length: 256
property

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

  • Max Length: 2048
property

detail: A human-readable explanation specific to this occurrence of the problem.

property

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

  • Max Length: 2048

GetStoresPersonalizedEnum

GetStoresPersonalizedEnum: "none"

GetStoresSfdcDwDntEnum

GetStoresSfdcDwDntEnum: "0" | "1"

LocaleCode

LocaleCode: string

PaginatedResultBase

PaginatedResultBase: { limit: number; offset: number; total: number } & {}
property

offset: The zero-based index of the first hit/data to include in the result.

property

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

property

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

ResultBase

ResultBase: { limit: number; total: number } & {}
property

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

property

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

SearchStoresPersonalizedEnum

SearchStoresPersonalizedEnum: "none"

SearchStoresSfdcDwDntEnum

SearchStoresSfdcDwDntEnum: "0" | "1"

ShopperStoresParameters

All parameters that are used by ShopperStores.

ShopperStoresPathParameters

ShopperStoresPathParameters: Partial<getStoresPathParameters & searchStoresPathParameters & {}>

All path parameters that are used by at least one ShopperStores method.

ShopperStoresQueryParameters

ShopperStoresQueryParameters: Partial<getStoresQueryParameters & searchStoresQueryParameters & {}>

All query parameters that are used by at least one ShopperStores method.

Store

Store: { address1?: undefined | string; address2?: undefined | string; city?: undefined | string; countryCode?: undefined | string; distance?: undefined | number; distanceUnit?: DistanceUnit; email?: undefined | string; fax?: undefined | string; id: string; image?: undefined | string; inventoryId?: undefined | string; latitude?: undefined | number; longitude?: undefined | number; name?: undefined | string; phone?: undefined | string; posEnabled?: undefined | false | true; postalCode?: undefined | string; stateCode?: undefined | string; storeEvents?: undefined | string; storeHours?: undefined | string; storeLocatorEnabled?: undefined | false | true } & {}
property

address1: The primary address of the store.

  • Min Length: 1
property

address2: The secondary address of the store.

property

city: The city of the store.

property

countryCode: A two letter uppercase country code conforming to the ISO 3166-1 alpha-2 standard.

  • Pattern: /^[A-Z][A-Z]$/
property

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

property

distanceUnit:

property

email: The email address of the store.

property

fax: The fax number of the store.

property

id: The id of the store.

  • Min Length: 1
  • Max Length: 256
property

image: The store image.

property

inventoryId: The inventory list id associated with this store.

  • Max Length: 256
property

latitude: The latitude of the store.

property

longitude: The longitude of the store.

property

name: The store name.

property

phone: The phone number of the store.

property

posEnabled: Whether this store uses Store Point-of-Sale.

property

postalCode: The postal code of the store.

  • Min Length: 3
  • Max Length: 10
property

stateCode: The state code of the store.

property

storeEvents: The store events.

property

storeHours: The opening hours of the store.

property

storeLocatorEnabled: Whether this store should show up in store locator results.

StoreResult

StoreResult: { data?: Array<Store>; limit: number; total: number } & {}
property

data: The list of stores in the search result.

property

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

property

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

Stores

Stores: { data?: Array<Store>; limit: number; offset: number; total: number } & {}
property

data: The list of stores in the search result.

property

offset: The zero-based index of the first hit/data to include in the result.

property

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

property

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

getStoresPathParameters

getStoresPathParameters: { organizationId: string }

Type declaration

  • organizationId: string

getStoresQueryParameters

getStoresQueryParameters: { ids: string; locale?: LocaleCode; personalized?: undefined | "none"; siteId: string }

Type declaration

  • ids: string
  • Optional locale?: LocaleCode
  • Optional personalized?: undefined | "none"
  • siteId: string

searchStoresPathParameters

searchStoresPathParameters: { organizationId: string }

Type declaration

  • organizationId: string

searchStoresQueryParameters

searchStoresQueryParameters: { countryCode?: undefined | string; distanceUnit?: DistanceUnit; latitude?: undefined | number; limit?: undefined | number; locale?: LocaleCode; longitude?: undefined | number; maxDistance?: undefined | number; offset?: undefined | number; personalized?: undefined | "none"; postalCode?: undefined | string; siteId: string }

Type declaration

  • Optional countryCode?: undefined | string
  • Optional distanceUnit?: DistanceUnit
  • Optional latitude?: undefined | number
  • Optional limit?: undefined | number
  • Optional locale?: LocaleCode
  • Optional longitude?: undefined | number
  • Optional maxDistance?: undefined | number
  • Optional offset?: undefined | number
  • Optional personalized?: undefined | "none"
  • Optional postalCode?: undefined | string
  • siteId: string

Variables

Const defaultBaseUri

defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/store/shopper-stores/v1" = "https://{shortCode}.api.commercecloud.salesforce.com/store/shopper-stores/v1"

Generated using TypeDoc