v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Wallet Store Locations API

Get store locations

List the store locations attached to a wallet campaign. Results are paginated; use the page and page_size parameters to page through them.

get/companies/{company_key}/campaigns/wallet/{token}/locations

Path parameters

company_keystring required

tokenstring required

The token is the SmartLink token (wallet_id) for the campaign.

Query parameters

pageinteger

1-indexed page number to return.

page_sizeinteger

Number of locations per page.

zipstring

Optional filter by zip/postal code (exact match).

latitudestring

Optional filter by latitude (exact match).

longitudestring

Optional filter by longitude (exact match).

Headers

X-API-Versionstring

Response

Successful response

idinteger

Unique identifier of the store location.

location_idstring

Your own identifier for the store (for example a store number).

namestring

Store or location name.

addressstring

Street address.

address_2string

Optional second address line (suite, unit, etc.).

citystring

City.

statestring

State or province.

zipstring

Zip or postal code.

phone_numberstring

Store contact phone number.

store_hoursstring

Store operating hours.

latitudestring

Latitude of the location.

longitudestring

Longitude of the location.

notification_messagestring

Lock-screen message shown to pass holders when they are near this location.