Create outlet
hub_create_outletOpen a new point of sale — the cabinet’s Add Outlet form. Name and the full street address (address, city, state, postCode) are all REQUIRED, exactly as on that form. Do NOT try to set a country: every outlet inherits the company’s country, and it can never be changed per outlet. Ask the merchant for any part of the address you do not know — an invented address ends up on receipts. This is BILLABLE: a new outlet counts against the company plan’s outlet allowance and the call is refused once that allowance is used up. Confirm with the merchant before calling. Afterwards the platform seeds a stock row of 0 for every product at the new outlet in the background, so its stock reads as empty until someone receives or transfers stock in. Linking a Stripe account to the outlet is NOT possible from here — the merchant does that in Settings → Outlets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | Yes | City | |
| name | Yes | Outlet name as the merchant calls it, e.g. "King Street" | |
| alias | No | Short code used by the WooCommerce / Metorik integration. Can never be changed once set — leave it out unless the merchant asked for it | |
| phone | No | Phone number of this location | |
| state | Yes | State or province, e.g. "ON" | |
| taxId | No | Business tax number printed on this outlet’s receipts (BN / GST / HST / VAT / EIN) | |
| address | Yes | Street address, e.g. "123 King St W" | |
| address2 | No | Unit, suite or floor | |
| postCode | Yes | ZIP / postal code |