Update outlet
hub_update_outletChange the details of one outlet. Takes the outlet id from get_outlets, never a name. Only the fields you pass are changed; the rest are left alone. Renaming is safe and takes effect everywhere, including past orders and reports — they store the outlet id and look the name up. Country cannot be changed here: it belongs to the company. An alias that is already set cannot be changed either and the attempt is refused. Stripe account linking is not editable from here.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | ||
| name | No | New outlet name | |
| alias | No | Only settable while it is still empty | |
| phone | No | ||
| state | No | State or province | |
| taxId | No | Business tax number printed on this outlet’s receipts (BN / GST / HST / VAT / EIN) | |
| address | No | Street address | |
| address2 | No | Unit, suite or floor | |
| outletId | Yes | Outlet id from get_outlets — not a name | |
| postCode | No | ZIP / postal code |