Protocol Documentation
Table of Contents
- engine/shop/common/v1/addon.proto
- engine/shop/common/v1/conditions_override_addon.proto
- Scalar Value Types
engine/shop/common/v1/addon.proto
Addon
An optional add-on that may be purchased with a shop Offer, or returned on ConfirmOfferResponse.
| Field | Type | Label | Description |
|---|---|---|---|
| addon_token | string | An opaque token identifying this add-on. Pass to ConfirmOfferRequest.selected_addon_tokens when confirming an offer that includes this add-on. | |
| title | string | A short display name for the add-on. Intended for partner-facing shopping and confirmation UI. | |
| summary | string | optional | An optional longer description of the add-on for display during shopping or confirmation. |
| fee | engine.common.v1.Surcharge | The surcharge charged when this add-on is purchased with the offer. On shop Offer.addons this is indicative and may change before booking. On ConfirmOfferResponse.available_addons this is the confirmed fee for this confirmation. | |
| conditions_override | ConditionsOverrideAddon | An add-on that overrides the offer's modification and cancellation Conditions. |
engine/shop/common/v1/conditions_override_addon.proto
ConditionsOverrideAddon
An optional add-on that overrides the modification and cancellation Conditions on an OfferSummary.
| Field | Type | Label | Description |
|---|---|---|---|
| conditions | engine.common.v1.Conditions | The Conditions that override OfferSummary.conditions when the add-on is purchased. |