Locations

Locations are operational children of a merchant. They are not organization hierarchy nodes.

The external merchant API does not currently expose standalone /v1/locations or /v1/merchants/{merchant_id}/locations routes. Location concepts still appear on the public surface in these places:

  • location_id on devices
  • location_id filters and assignments on /v1/devices
  • location_id on inherited settings responses
  • location-scoped settings policies through /v1/settings/policies
  • shared API scopes such as accounts.locations.read and accounts.locations.write, which are defined but not currently used by public /v1 routes

Current Public Surface#

GET/v1/settings/effective?location_id={location_id}

Resolve inherited effective settings for a location under the authenticated merchant.

GET/v1/settings/policies?scope=location&location_id={location_id}

List location-scoped settings policies.

PUT/v1/settings/policies

Replace location-scoped settings policies by sending scope=location and location_id in the request body.

Devices And Locations#

Devices may optionally be assigned to a location.

  • If a device has a location_id, effective settings resolve through organization -> merchant -> location -> device
  • If a device has no location_id, effective settings resolve directly through organization -> merchant -> device or merchant -> device
  • Updating a device's location_id changes operational assignment, not merchant identity
Rate this doc