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)

City / locality.

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

State / region.

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

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.

ISO 4217 currency code (e.g. USD, EUR) that every amount in this breakdown is denominated in. Determined by the store; read-only and always present on responses.

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 how the tip is to be distributed (e.g. Staff 5.00, Driver 5.00), as a full pass-through to the merchant. When non-empty, the sum of the values must equal the Tip amount. Empty when the tip is not itemized.

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

Ordered list of section IDs

Fulfillment methods this menu can be ordered under (pickup and/or delivery). A menu always declares at least one method; a method absent here cannot be used to order from this menu.

Time windows when this catalog is available. Empty or null = never open; use Open247 to declare 24/7 availability explicitly. This mirrors the fail-closed semantic of Store.Availability in the Marketfront API. 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

The end user's originating IP address, IPv4 or IPv6. Must be a publicly routable address — loopback, link-local and private-range addresses are rejected, as is any placeholder value. If your front end sits behind a proxy or CDN, this is the first address in the forwarded-for chain, not the address of your own server.

The end user's User-Agent, taken verbatim from the request your front end received. Do not substitute your own service's user agent.

Your own stable identifier for this customer, so the customer can be recognized across orders. Supply it on your order requests.

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

Number of times this item is pre-selected

Delivery handoff method (door-to-door, leave at door, etc.).

Fulfillment mode discriminator.

Whether the customer wants immediate or scheduled fulfillment.

Delivery destination. On a request, the inline street fields. On a response, the fully-resolved address (canonical street fields + server-geocoded latLong). Resolved into AddressId at build time.

Optional free-text delivery instructions. Maximum 500 characters.

UTC instant the customer wants the order ready. Required when ScheduleType is Scheduled; must be null for Asap.

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)

Item display name

Legal age restrictions that apply to ordering this item (e.g. ALCOHOL). null means unknown (no signal); an empty array means known to be unrestricted.

Major food allergens this item is known to contain as an ingredient (the FDA / CA SB 68 set; see Allergen). null means no allergen data is available — you must NOT imply the item is allergen-free. An empty array means the restaurant affirmatively declares no major allergens. These two states are distinct — treat them differently and do not coerce one to the other.

Price of the item before modifiers, in the store's currency. A line's unit price is this base price plus the base price of each selected modifier, clamped up to StartingAt. Never compute a total as StartingAt + modifiers — that figure already folds in the cheapest required choice, so adding modifiers double-counts it.

This is normally the advertised price, but it is not for an item using the synthetic-base encoding (gett-2748.21), where it is the advertised price minus the value of the item's pre-selected DefaultItems and may be NEGATIVE. Such a number means nothing on its own — only under the StartingAt floor that clamps it. Display surfaces should therefore read StartingAt, not this field, for any price shown outside a fully built line.

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

The cheapest orderable configuration — BasePrice plus the cheapest choice of every required group. Show it on menu tiles as "from $X"; never add modifiers to it (that double-counts the cheapest required choice, which it already folds in). For strikethrough pricing, use CompareAt.

It is also a FLOOR on the line total, not display-only (gett-2748.21). CartSubTotal computes max(StartingAt, BasePrice + Σ selected modifiers). For an ordinary item this is a no-op — nothing can price below the cheapest orderable configuration by definition — but it is what lets a provider express a merchant rule that gives value back without ever refunding below the advertised price. Menufy's substitution credit is the case it was built for: a removed default modifier credits its value against paid extras, and BasePrice carries the synthetic base (advertised minus the defaults' value, possibly negative) with this field carrying the advertised price the customer cannot go under. Incompatible with a negative-priced modifier on the same item. A deselect credit (Olo "No Drink" −0.75) legitimately prices a configuration BELOW the base, so an item offering one must either leave this null or fold the credit into the value — otherwise the floor clamps the credit away. No provider does both today; the shared conversion suite pins that.

Reference to item in CatalogSet

Selected modifier groups for this item

Item quantity

Unique identifier for this line item

Latitude coordinate

Longitude coordinate

Available modifier options (references items)

Maximum selections allowed

Minimum selections required

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

Pre-selected modifier options — the configuration the customer gets if they change nothing. Total quantity across all defaults must not exceed maximumAllowed, and every item must appear in ItemIds.

A default is priced like any other selection: it contributes its item's BasePrice to the line, and cart math has no "free because it is default" rule. The cart that is sent is the order, so a default omitted from it is one the kitchen will not make — track defaults as real, removable selections rather than as decoration on the option list. Where a merchant credits a removed default against paid extras, that is expressed entirely through the pair on the parent item — a synthetic BasePrice (advertised minus the whole default pool) under an StartingAt floor — and needs no special case here or in cart math. Keeping every default then reproduces the advertised price exactly; removing one frees its value to offset a paid extra; removing more than is spent hits the floor and refunds nothing.

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.

The end user's own IP and user agent. Required on every order request — Gett cannot observe them, because your call reaches us server-to-server.

How and when the order should be fulfilled — the mode (delivery or pickup), schedule, and (for delivery) the destination Address and handoff details. Supply it on the request; on the response it is returned fully resolved.

Pricing breakdown. On validateOrder you supply tip and the response returns the rest of the breakdown; on placeOrder the response returns the final, authoritative amounts. Optional on requests that only need validation.

Customer contact information for the order. Supply it on your order requests; it is echoed back, fully resolved, on the response.

Error reason code (wire: code; x-extensible-enum).

User-facing error message (wire: message). Always a curated, canonical string — never raw vendor text.

RFC 6901 JSON Pointer to the wire element that caused the error (e.g. /cart/lineItems/0).

Shopping cart with line items.

The end user's own IP and user agent. Required on every order request — Gett cannot observe them, because your call reaches us server-to-server.

How and when the order should be fulfilled — the mode (delivery or pickup), schedule, and (for delivery) the destination Address and handoff details. Supply it on the request; on the response it is returned fully resolved.

Payment details — see the Payments Guide.

Pricing breakdown. On validateOrder you supply tip and the response returns the rest of the breakdown; on placeOrder the response returns the final, authoritative amounts. Optional on requests that only need validation.

Customer contact information for the order. Supply it on your order requests; it is echoed back, fully resolved, on the response.

Shopping cart with line items.

The end user's own IP and user agent. Required on every order request — Gett cannot observe them, because your call reaches us server-to-server.

How and when the order should be fulfilled — the mode (delivery or pickup), schedule, and (for delivery) the destination Address and handoff details. Supply it on the request; on the response it is returned fully resolved.

Pricing breakdown. On validateOrder you supply tip and the response returns the rest of the breakdown; on placeOrder the response returns the final, authoritative amounts. Optional on requests that only need validation.

Customer contact information for the order. Supply it on your order requests; it is echoed back, fully resolved, on the response.

Payment method type — one of GETT_PAYMENT, CARD_ON_FILE, SAVED_CARD.

For CARD_ON_FILE: a single-use card token (nonce) from your own payment solution. The secure interchange that lets Gett resolve it is configured with your Gett representative during onboarding — see the Payments guide.

Fulfillment mode discriminator.

Whether the customer wants immediate or scheduled fulfillment.

UTC instant the customer wants the order ready. Required when ScheduleType is Scheduled; must be null for Asap.

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. These use the same element shape (OrderError) as the inline order.errors[] on a 200 validate response with isValid:false, so you can parse one error shape across both paths.

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. Include it when contacting support so we can locate the request.

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

ID of the line item to remove

Ordered list of item IDs

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

Unique section identifier

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

Labels describing this store — a mix of cuisine types (e.g. Thai, Pizza) and highlight tags such as Popular, Savings, Exclusive, and Closest. Use them to group or filter stores in your UI.

Fulfillment modes this store offers, as the same FulfillmentType values the discovery filter and the order graph use (PICKUP, DELIVERY_BY_MERCHANT). Empty only for a store that offers neither. Filter or badge stores off this set rather than separate per-mode booleans.

Store display name

Per-store capability flags — e.g. whether the store accepts tips. Distinct from FulfillmentModes, which says which fulfillment modes are offered at all.

Unique store identifier

A postal address used across the order API.

On a request, supply the street fields; LatLong is ignored — the server geocodes coordinates from the street fields. On a response, the street fields are echoed alongside the server-geocoded LatLong.

Weekly opening-hours pattern, for display. Empty when the store does not publish availability windows. To decide whether the store can take an order right now, use IsAcceptingOrders rather than deriving open-state from these windows.

ID for fetching the store's catalog

Store description

Distance from search location in miles

Store hero image

Whether the store is accepting orders right now. Prefer this flag over deriving open-state yourself from Availability — it already accounts for the store's hours, timezone, and catalog status.

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

Average rating (1-5)

Number of reviews

Active discount as a percentage (0–100), for display (e.g. "SAVE 11%"). Null when no discount is running.

IANA timezone of the store's address (e.g. "America/Los_Angeles"). Used by the client to interpret 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)