Skip to content
Sqquid

Location tools

Locations represent stores and warehouses in one Sqquid Account.

To manage them directly in the app, including business hours for carrier pickups, use Settings > Locations.

Each location has two identifiers:

  • id is the Sqquid database identifier. Update and delete tools use it.
  • store_id is the stable business identifier. Connection maps and routing rules use it.

Do not guess either identifier. Call locations_list first.

List all stores and warehouses in the Account.

Requires locations:read. Read-only.

No input is required.

The result contains the id, store_id, name, address, city, state or province, postal code, and phone number.

Create a store or warehouse.

Requires locations:write. Changes data immediately.

Input Required Description
store_id Yes Stable location key. Use a short POS or outlet code.
name Yes Location name.
address Yes Street address.
city Yes City.
state Yes State or province.
zip Yes ZIP or postal code.
phone Yes Phone number.

The store_id must be unique in the Account. If the store_id already exists, the tool returns the existing location. It does not change that location.

Location names do not have to be unique.

Call account_limits before you create a location.

Update selected location fields.

Requires locations:write. Changes data immediately.

Input Required Description
id Yes Location ID from locations_list.
name No New name.
address No New street address.
city No New city.
state No New state or province.
zip No New ZIP or postal code.
phone No New phone number.

The tool changes only the supplied fields. It cannot change store_id.

Delete a location.

Requires locations:write. Changes data.

User approval is required.

Input Required Description
id Yes Location ID from locations_list.

The tool blocks deletion when an order routing rule uses the location. The tool also blocks deletion when a Connection location map uses store_id.

Remove each reference before you retry deletion.

After deletion, stock at the location is not addressable. If you recreate the same store_id, the stock becomes addressable again.

Use connections_map_locations for a Lightspeed X or Shopify source Connection. The tool can create Sqquid locations and map provider locations in one operation.

See Connection tools.