v1

latestOpenAPI 3.0.02026-07-2480129136.5 KB
Stores

Search Stores

Returns a collection of storeKey values based on the search parameters.

get/stores

Query parameters

namestring

Optional filter to search by store name.

addressstring

Optional filter to search by store address.

citystring

Optional filter to search by store city.

statestring

Optional filter to search by store state.

zipCodestring

Optional filter to search by store ZIP/Postal code.

sortstring

If specified, sort the results by this value. Default is "Name ASC".

offsetinteger

Used for paging. The number of records to skip. Default is 0.

limitinteger

Used for paging. The maximum number of records to return. Default is 10.

Response

OK

totalItemsinteger
successboolean
errorsstring[]
resultsstring[]