UberEatsPromotion

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 (ONE-3290).

• 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

  ONE-3409, ADDITIVE. Uber's user_group for this promotion, echoed back.

  Possible values: [ALL_CUSTOMERS, FIRST_TIME_CUSTOMER]