Order API
TypeLocation1
Identifies a Location entity and supplies defaults for creating it.
Use id for a Location external ID, origin with origin_id for an integration-owned Location, or bhid for an existing Bubblehouse Location.
Lookup is scoped to the order's venue. External IDs match both manual and integration-owned Locations. When a supplied external ID or origin pair has no match, a Location is created.
Existing Locations are reused unchanged, including archived Locations. The title and external ID supplied alongside an origin pair only apply when creating a Location.
An unusable identity (unknown Bubblehouse ID, conflicting or partial identities, or an ambiguous match) is omitted: a new order is saved without a Location, and an update keeps the stored Location. Do not combine bhid with an origin pair. A title alone is not a valid identity.
| Kind | Type |
|---|---|
| Used in | Cart2, EstimateAccrual1, LoadCart1, UpdateOrders4 |
Properties
-
bhidstring optionalBubblehouse ID of an existing Location
Looks up an existing Location only; does not create one. The Location must belong to the order's venue.
-
originstring optionalIntegration that owns the Location
Use the canonical integration identity, such as
ingr:zenoti.0oringr:zenoti.2for a numbered instance. Must be provided together withorigin_id. -
origin_idstring optionalLocation identifier within its integration
For example, a Zenoti center ID. Must be provided together with
origin. -
idstring optionalExternal Location ID
Used for lookup when neither
bhidnor an origin pair is supplied. Creates an unowned Location when no match exists.With an origin pair, supplies the external ID for a newly created Location. Existing external IDs remain unchanged.
-
titlestring optionalName for a newly created Location
If omitted or empty, uses
id, otherwiseorigin_id. Does not rename an existing Location.