Company locations

API reference › Team settings

The team's own addresses: the primary location, warehouses, the default warehouse and tax nexus.

10 operations

• POSTCreate a company location/v1/api/store/{team_slug}/setting/locationAdds a company location and returns it.
• GETList company locations/v1/api/store/{team_slug}/setting/locationReturns all the team's company locations in one list.
• GETShow a company location/v1/api/store/{team_slug}/setting/location/{hash_id}Returns one company location, deleted or not.
• PUTUpdate a company location/v1/api/store/{team_slug}/setting/location/{hash_id}Changes a location's address, label, note or tax nexus in place: the id stays the same, so every order, purchase order and stock record that uses it shows the new address.
• PATCHUpdate a company location without checks/v1/api/store/{team_slug}/setting/location/{hash_id}Use PUT to change a company location.
• PATCHSet the default warehouse/v1/api/store/{team_slug}/setting/location/{id}/default_warehouseMakes this warehouse the team's default warehouse and returns it.
• PATCHSet a location as a warehouse/v1/api/store/{team_slug}/setting/location/{id}/hold_stockTurns a company location into a warehouse that can hold stock (hold_stock: true) and returns it.
• PATCHSet the primary location/v1/api/store/{team_slug}/setting/location/{id}/primaryMakes this company location the team's primary location (its primary billing address) and returns it.
• DELETEDelete a company location/v1/api/store/{team_slug}/setting/location/{hash_id}Deletes a company location.
• PATCHRestore a company location/v1/api/store/{team_slug}/setting/location/{id}/restoreBrings back a deleted company location.