Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.36 KB

OrderCampaign.md

File metadata and controls

61 lines (41 loc) · 2.36 KB

OrderCampaign

Properties

Name Type Description Notes
id String The campaign's ID returned by GrabFood upon campaign creation. [optional]
name String The name of the campaign. This campaign name has been automatically generated by Grab for display in the customer app. [optional]
campaignNameForMex String The campaign name provided by the merchant in Create Campaign. Whitelist required, reach out to your integration manager. [optional]
level LevelEnum The campaign level. [optional]
type TypeEnum The type of campaign. [optional]
usageCount Long The campaign redemption count in this order. [optional]
mexFundedRatio Integer The ratio funded by the merchant in percentage. [optional]
deductedAmount Long The deducted amount in minor unit format. `Item price(tax inclusive) * 20% discount 2375*0.2`
deductedPart DeductedPartEnum The part that the campaign is applied. [optional]
appliedItemIDs List<String> An array of item IDs that get discount under this campaign. `null` if no item applied in this campaign. [optional]
freeItem OrderFreeItem [optional]

Enum: LevelEnum

Name Value
ITEM "item"
CATEGORY "category"
ORDER "order"
DELIVERY_FEE "delivery_fee"
BUNDLE "bundle"
UNKNOWN_DEFAULT_OPEN_API "unknown_default_open_api"

Enum: TypeEnum

Name Value
PERCENTAGE "percentage"
NET "net"
DELIVERY "delivery"
FREE_ITEM "freeItem"
BUNDLE_SAME_NET "bundleSameNet"
BUNDLE_SAME_PERCENTAGE "bundleSamePercentage"
BUNDLE_SAME_FIX_PRICE "bundleSameFixPrice"
UNKNOWN_DEFAULT_OPEN_API "unknown_default_open_api"

Enum: DeductedPartEnum

Name Value
BASKET_AMOUNT "basket_amount"
DELIVERY_FEE "delivery_fee"
UNKNOWN_DEFAULT_OPEN_API "unknown_default_open_api"