Schemas

A line item in a shopping cart

Shopping cart with line items. Carts are client-managed — there is no server-side cart storage.

Catalog set ID (required if cart is empty)

Store ID (required if cart is empty)

Billing address for the card. Server upserts (deduplicating by deterministic hash) and binds the resulting address to the saved card. Callers don't thread address ids through the API.

Any manual adjustments made to the order amount

Breakdown of the adjustments made to the order. The sum of the values should equal the Adjustments amount.

Additional fees applied to the order (e.g., service fees, booking fees)

Breakdown of the fees applied to the order. The sum of the values should equal the Fees amount.

The total amount of promotions or discounts applied to the order.
A discount should be represented as a POSITIVE value.

Breakdown of the promotions or discounts applied. A discount should be represented as a POSITIVE value.

The subtotal amount of amounts being purchased before any fees, taxes, or adjustments

Total tax amount applied to the order. This includes line item specific taxes.

Breakdown of the taxes applied to the order. The sum of the values should equal the Taxes amount.

Tip amount added to the order. This should be a full pass-through to the merchant for them to distribute appropriately.

Breakdown of the tip added to the order.
This may specify how the tip total is to be distributed ex:[("Staff", 5), ("Driver", 5)] The sum of the values should equal the Tip amount.

The final total amount of the order. SubTotal + Fees + (-Promotions) + Taxes + Adjustments + Tip = Total

Day of week this availability window applies to

End time of the availability window. Use 00:00:00 to represent end-of-day.

Start time of the availability window

Catalog set identifier (canonical Guid).

Line items in the cart

Store identifier (canonical Guid).

Selected modifier line items

Reference to modifier group in CatalogSet

Item ID — must be one of the modifier group's itemIds

Number of times this item is pre-selected

Location to search near

Filter by fulfillment method (delivery or pickup).

Maximum number of results to return

Offset for pagination

Free-text search query. Accepts anything from single keywords like "pizza" to natural language requests like "healthy lunch spots with outdoor seating".

Whether more results are available

Stores matching the discovery criteria.

Total number of matching stores (for pagination)

Server-geocoded coordinates. Populated on responses; ignored on requests (the server always geocodes from the address fields to avoid trusting partner-supplied points).

Ordered list of section IDs

Time windows when this catalog is available. Empty or null = the catalog is never open; supply explicit windows for every day to declare 24/7 availability. Mirrors the same fail-closed semantic as Store.Availability. See the CatalogSet Guide for overnight handling.

Unique catalog identifier

Menu name (e.g., 'Lunch Menu')

Menus keyed by catalog ID

Menu items keyed by item ID

Modifier groups keyed by modifier group ID

Menu sections keyed by section ID

Unique identifier for this catalog version

Partner-side stable identifier for this customer. Used as the durable bridge key to a Gett User via DistributionPartnerUser. Required on api-key direct-order requests; null on session-derived customers (the session JWT already pins the user).

Type of delivery handoff

Physical address for external/partner-facing APIs. Excludes internal references (AddressId).

Item display name

Raw price of the item before modifiers, and the ONLY authority for commerce. The running/cart total is ALWAYS BasePrice + Σ(modifier BasePrice); see the CatalogSet Guide #price-calculation. Never compute a total from StartingAt.

Original/marketplace price for showing savings (e.g., strikethrough pricing). Present when the item is priced below a comparable marketplace listing.

Item description

Item image URL

Unique item identifier

List of modifier group IDs for this item

Headline "from $X" DISPLAY price only (e.g., 'Starting at $12.00') — the cheapest orderable configuration. It already folds in the cheapest required modifier of each group, so NEVER add modifiers to it; doing so double-counts. The cart total is computed from raw BasePrice, not from StartingAt. CompareAt (not StartingAt) drives savings/strikethrough.

Available modifier options (references items)

Maximum selections allowed

Minimum selections required

Display name (e.g., 'Choose Size')

Pre-selected modifier options. Total quantity across all defaults must not exceed maximumAllowed.

Whether same modifier can be selected multiple times (e.g., 'Extra Pepperoni' x2). Required for scenarios like dozen bagels where fewer unique items than minimumAllowed exist.

Unique modifier group identifier

Quantity-based pricing tiers. When present, overrides item basePrice for selections in this group. See the CatalogSet Guide for calculation details.

Shopping cart with line items.

Flat fulfillment mode for the partner-facing wire shape. Lives on ExternalOrder only — the internal Gett.Core.Order.Order carries a discriminated Gett.Core.Order.Fulfillment variant instead. Projected from Order.Fulfillment.Mode by Gett.Core.Order.ExternalOrderMapper on the way out; read and used to construct Order.Fulfillment on the way in.

Pricing breakdown. On validateOrder, the partner supplies Amounts.Tip; the server computes and returns the rest of the breakdown. On placeOrder, the provider returns the authoritative post-place breakdown that gets persisted. Nullable because validate-only flows may omit it.

Customer contact information.

Required for partner api-key flows. Optional when the request is authenticated with a Marketfront session JWT — the server resolves the customer from the session user's profile.

Delivery details. Required when FulfillmentType is DeliveryByMerchant.

Validation or placement errors, if any. Same element shape as Gett.Core.ProblemDetail.Errors so partners get one parser across both inline-on-200 and 4xx error paths.

Unique order identifier assigned by Gett. Empty in wire requests — set by server on placement.

Whether the order passed validation (no errors).

Partner's own order identifier, assigned after placement by the provider.

When the order was placed.

W3C trace id (32-hex) for this response, populated only when Gett.Core.Order.ExternalOrder.Errors is non-empty. Lets a tester or support agent jump straight from a failed validation/placement to the distributed trace and correlated logs in SigNoz — the bridge that was missing when a generic OTHER error gave no handle back to the server-side exception. Null on success.

Section name (e.g., 'Appetizers')

Ordered list of item IDs

Unique section identifier

Child section IDs for nested hierarchies (e.g., 'Food' → 'Hot Food' → 'Pizza')

Fulfillment method for the order

A Google ID token obtained from the gett.co Google OAuth client. The server validates the token signature, expiry, and audience (pinned to gett.co client IDs) before promoting the session.

Reference to item in CatalogSet

Selected modifier groups for this item

Item quantity

Unique identifier for this line item

Latitude coordinate

Longitude coordinate

Unique item identifier within the store catalog.

Dish display name.

Base price of the dish.

Dish description.

Highlighted versions of text fields, with match tokens wrapped in «…» sentinels.

Dish image URL.

Payment method type — one of gettPayment, cardOnFile, savedCard.

For cardOnFile: Your processor's card token

For savedCard: id of a Gett-managed payment owned by the session user.

For cardOnFile: stripe, braintree, square, etc.

Shopping cart with line items.

Flat fulfillment mode for the partner-facing wire shape. Lives on ExternalOrder only — the internal Gett.Core.Order.Order carries a discriminated Gett.Core.Order.Fulfillment variant instead. Projected from Order.Fulfillment.Mode by Gett.Core.Order.ExternalOrderMapper on the way out; read and used to construct Order.Fulfillment on the way in.

Payment details — see the Payments Guide.

Pricing breakdown. On validateOrder, the partner supplies Amounts.Tip; the server computes and returns the rest of the breakdown. On placeOrder, the provider returns the authoritative post-place breakdown that gets persisted. Nullable because validate-only flows may omit it.

Customer contact information.

Required for partner api-key flows. Optional when the request is authenticated with a Marketfront session JWT — the server resolves the customer from the session user's profile.

Delivery details. Required when FulfillmentType is DeliveryByMerchant.

Validation or placement errors, if any. Same element shape as Gett.Core.ProblemDetail.Errors so partners get one parser across both inline-on-200 and 4xx error paths.

Unique order identifier assigned by Gett. Empty in wire requests — set by server on placement.

Whether the order passed validation (no errors).

Partner's own order identifier, assigned after placement by the provider.

When the order was placed.

W3C trace id (32-hex) for this response, populated only when Gett.Core.Order.ExternalOrder.Errors is non-empty. Lets a tester or support agent jump straight from a failed validation/placement to the distributed trace and correlated logs in SigNoz — the bridge that was missing when a generic OTHER error gave no handle back to the server-side exception. Null on success.

The HTTP status code.

A short, human-readable summary of the problem type.

A URI reference that identifies the problem type.

A human-readable explanation specific to this occurrence.

Machine-readable error category (e.g. validation, rate_limit, payment, availability, server_error).

Machine-readable error code for domain-specific errors.

Validation error details, when applicable.

A URI reference that identifies the specific occurrence.

Unique identifier for this request, useful for support.

Seconds to wait before retrying. Present when retryable is true and a wait period is known.

Whether the request can be retried with a reasonable expectation of success.

When the error occurred.

W3C trace id (32-hex) for this request. Paste into SigNoz trace search to find the distributed trace and correlated logs. Populated by the global exception filter.

Shopping cart with line items. Carts are client-managed — there is no server-side cart storage.

ID of the line item to remove

Partner-facing identity flag. true when no identity tuple was supplied at session-create; false when the full {partnerUserId, email, firstName, lastName} tuple resolved a Gett user. Orthogonal to Gett.Service.Marketfront.DTOs.SessionCreateResponse.Level (which encodes order-readiness progression).

Order-readiness progression: 0 (anonymous), 1 (identified, no delivery info), 2 (identified + address AND phone), 3 (identified + delivery + payment, fully order-ready). Create-time max is 2 — L3 requires payment tokenization via Evervault post-create. Identity is binary and orthogonal (Gett.Service.Marketfront.DTOs.SessionCreateResponse.IsAnonymous); Gett.Service.Marketfront.DTOs.SessionCreateResponse.Level only progresses for identified sessions. ProfileCompleteness.IsComplete remains the canonical place-order gate.

Always set. Echoes the caller-supplied id for identified sessions, or a server-minted gen_<guid> for anonymous sessions. For anonymous sessions the value is ephemeral — the within-session FulfillmentContext blob uses it as a key but it is not promised across fresh anonymous sessions.

Stable per-token identifier — the JWT's jti claim surfaced for clients that key session-scoped state without parsing the token. Same value across Gett.Service.Marketfront.DTOs.SessionCreateResponse and Gett.Service.Marketfront.DTOs.SessionMeResponse for one token. Distinct on every fresh session-create (anonymous or identified). Used by the SDK Web Component as the mf:<sessionId>:* localStorage prefix.

Partner-facing identity flag. true when the session has no identity tuple resolved (anonymous browse); false when the session is identified. Orthogonal to Gett.Service.Marketfront.DTOs.SessionMeResponse.Level.

Order-readiness progression computed from the user's current DB state: 0 (anonymous), 1 (identified, no delivery info), 2 (identified + address AND phone), 3 (identified + delivery + payment, fully order-ready). ProfileCompleteness.IsComplete remains the canonical place-order gate.

Subset of ["address", "phone", "payment"] the user has not yet supplied. Empty when Gett.Service.Marketfront.DTOs.SessionMeResponse.Level is 3 (fully order-ready); ["address", "phone", "payment"] for anonymous sessions. Drives session-level "tap to add" UX without re-deriving from the User block.

Stable per-token identifier — the JWT's jti claim surfaced for clients that key session-scoped state without parsing the token. Same value as on Gett.Service.Marketfront.DTOs.SessionCreateResponse for one token. Used by the SDK Web Component as the mf:<sessionId>:* localStorage prefix.

Current atomic fulfillment context for the session, or null if the user has not committed one yet. When set, the address referenced by AddressId is guaranteed to belong to the authenticated user. Anonymous sessions always receive null.

Authenticated user block. null for anonymous sessions — the JWT carries no Id claim, no Gett user resolved. Populated for identified sessions.

Last-used saved payment. Drives "default for next order" payment selection on the consumer client.

Last-used address from the user's address book. Drives "default for next order" selection on the consumer client.

Fulfillment method for the order

Tags the client groups and filters by. Mixes cuisine names from the store's category metadata with synthetic system tags computed at request time: Closest — in the closest cluster by distance.Popular — high average rating.Savings — currently runs a meaningful discount.Exclusive — catalog set is partner-supplied (no discount). Synthetic tags are best-effort on search-mode results — index data is sufficient for cuisine + Popular but Savings/Exclusive are skipped when not derivable from the search hit.

Whether this store supports delivery fulfillment.

Store display name

Per-store capability flags. Unlike availability (Gett.Service.Marketfront.DTOs.Store.DeliveryAllowed/ Gett.Service.Marketfront.DTOs.Store.PickupAllowed), options describe how the store can be interacted with. Extension point for future capabilities (min-order, scheduling modes, …).

Whether this store supports pickup fulfillment.

URL-safe slug used to navigate to the store page: /store/{stem}.

Unique store identifier

Physical address for external/partner-facing APIs. Excludes internal references (AddressId).

Weekly opening-hours pattern. Null when the store does not publish availability windows. The server treats null/empty as "closed" when computing Gett.Service.Marketfront.DTOs.Store.IsAcceptingOrders — partners should rely on that flag rather than deriving open-state from this field.

ID for fetching the store's catalog

Store description

Distance from search location in miles

Highlighted versions of text fields, with match tokens wrapped in «…» sentinels. Populated only for search-mode results so the UI can bold the matched substring.

Store hero image

Whether the store is accepting orders right now. Computed server-side by intersecting the request instant with Gett.Service.Marketfront.DTOs.Store.Availability in the store's Gett.Service.Marketfront.DTOs.Store.TimeZone. False when the store is disabled, has no catalog, has no published windows, or has no zone.

Dishes on this store's menu that matched the query. Populated only when the search query surfaced the store through a dish hit (e.g. "pad thai" landing you on a restaurant whose name has no mention of Thai food).

Price tier (1=cheap … 4=expensive).

Average rating (1-5)

Number of reviews

Active discount as a percentage (0–100). Null when no discount is running. The "Savings" entry in Gett.Service.Marketfront.DTOs.Store.Categories is the presentation flag; this is the underlying number for display (e.g. "SAVE 11%").

IANA timezone of the store's address (e.g. "America/Los_Angeles"). Used by the client to interpret Gett.Service.Marketfront.DTOs.Store.Availability windows against the user's clock.

Whether this store accepts tips on delivery orders.

Whether this store accepts tips on pickup orders.

0-based selection index where this tier begins. For the k-th selection, use the tier with the greatest offset that is <= k.

Price charged per selection at this tier

Shopping cart with line items. Carts are client-managed — there is no server-side cart storage.

ID of the line item to update

New quantity (0 removes the item)

True when offset + limit < totalCount.

The page of results.

Effective page size after clamping.

Effective offset after clamping.

Total number of items matching the query, across all pages.

True when offset + limit < totalCount.

The page of results.

Effective page size after clamping.

Effective offset after clamping.

Total number of items matching the query, across all pages.

Specific validation error code identifying the issue.

Affected item ID (if applicable)

JSON path to the offending field (e.g. $.cart.lineItems[0], $.fulfillmentType). More general than Gett.Core.ValidationError.ItemId.

User-friendly error message