Order API

Type

Location1

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

  • bhid string optional

    Bubblehouse ID of an existing Location

    Looks up an existing Location only; does not create one. The Location must belong to the order's venue.

  • origin string optional

    Integration that owns the Location

    Use the canonical integration identity, such as ingr:zenoti.0 or ingr:zenoti.2 for a numbered instance. Must be provided together with origin_id.

  • origin_id string optional

    Location identifier within its integration

    For example, a Zenoti center ID. Must be provided together with origin.

  • id string optional

    External Location ID

    Used for lookup when neither bhid nor 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.

  • title string optional

    Name for a newly created Location

    If omitted or empty, uses id, otherwise origin_id. Does not rename an existing Location.

Previous
EntityLocalization1