GET
/
partner
/
locations

This endpoint can be used to fetch the IDs of all locations that are currently accessible to the integration partner.

Parameters

merchant_id
string

Filter by Merchant ID

page
integer

The current page of paginated resources.

  • Default: 1.
per_page
integer

Number of records to be returned per API request.

  • Default: 10
  • Minimum: 1
  • Maximum: 100

Response

id
string

Location ID

merchant_id
string

Merchant ID

street
string

Location’s street address

city
string

Location’s city

state
string

Location’s state

zip
string

Location’s zip code

name
string

The name of the location if it has one

phone
string

The phone number of the location

pagination
hash

Pagination information