UberEatsPromotion

Schema

An Uber Eats promotion as the platform reports it.

Visibility is limited by the platform to promotions CREATED THROUGH THE API. A promotion an operator set up by hand in Uber Eats Manager is invisible here, so an absent promotion does NOT mean the storefront is running none — do not reconcile spend against this feed and conclude anything about promotions you did not create.

Fields

promotionIdstring
UberEats' own id for the promotion — the handle every other promotion operation takes.
storeIdstring
The OneTablet storeId the promotion runs on. When several of your stores are connected to the same Uber Eats storefront, this names one of them, which may not be the one you created the promotion on.
promoTypestring
The promotion mechanic. See UberEatsPromoType.
Possible values: [FLATOFF, PERCENTOFF, BOGO, FREEITEM_MINBASKET, MENU_ITEM_DISCOUNT, FREEDELIVERY]
statestring
Where the promotion is in its lifecycle. See UberEatsPromotionState.
Possible values: [completed, active, pending, revoked, expired, deleted]
startsAtstring<date-time>
When the promotion starts running.
endsAtstring<date-time>
When the promotion stops running.
createdAtstring<date-time>
When the promotion was created on the platform.
externalPromotionIdstring
The id supplied by whoever created the promotion, echoed back.
currencyCodestring
ISO-4217 currency of budget.amount, e.g. USD.
budgetUberEatsPromotionBudget
The spend ceiling. See UberEatsPromotionBudget — integer minor units.
discountobject
The mechanic-specific parameters, exactly as the promotion was created — the branch of UberEatsDiscount whose promoType matches this promotion's.
userGroupstring
Which customers the promotion is offered to, echoed back. See UberEatsUserGroup.
Possible values: [ALL_CUSTOMERS, FIRST_TIME_CUSTOMER]