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
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.
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.
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.
The unit the distance attribute is measured in (either in miles or kilometers).