View Source GoogleApi.Content.V21.Model.OrderPromotion (google_api_content v0.67.1)
Attributes
-
applicableItems
(type:list(GoogleApi.Content.V21.Model.OrderPromotionItem.t)
, default:nil
) - Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item. -
appliedItems
(type:list(GoogleApi.Content.V21.Model.OrderPromotionItem.t)
, default:nil
) - Items that this promotion have been applied to. Do not provide fororders.createtestorder
. This field will be empty for shipping promotions because shipping is not tied to any specific item. -
endTime
(type:String.t
, default:nil
) - Promotion end time in ISO 8601 format. Date, time, and offset required, for example, "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z". -
funder
(type:String.t
, default:nil
) - Required. The party funding the promotion. Onlymerchant
is supported fororders.createtestorder
. Acceptable values are: - "google
" - "merchant
" -
merchantPromotionId
(type:String.t
, default:nil
) - Required. This field is used to identify promotions within merchants' own systems. -
priceValue
(type:GoogleApi.Content.V21.Model.Price.t
, default:nil
) - Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order. -
shortTitle
(type:String.t
, default:nil
) - A short title of the promotion to be shown on the checkout page. Do not provide fororders.createtestorder
. -
startTime
(type:String.t
, default:nil
) - Promotion start time in ISO 8601 format. Date, time, and offset required, for example, "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z". -
subtype
(type:String.t
, default:nil
) - Required. The category of the promotion. OnlymoneyOff
is supported fororders.createtestorder
. Acceptable values are: - "buyMGetMoneyOff
" - "buyMGetNMoneyOff
" - "buyMGetNPercentOff
" - "buyMGetPercentOff
" - "freeGift
" - "freeGiftWithItemId
" - "freeGiftWithValue
" - "freeShippingOvernight
" - "freeShippingStandard
" - "freeShippingTwoDay
" - "moneyOff
" - "percentOff
" - "rewardPoints
" - "salePrice
" -
taxValue
(type:GoogleApi.Content.V21.Model.Price.t
, default:nil
) - Estimated discount applied to tax (if allowed by law). Do not provide fororders.createtestorder
. -
title
(type:String.t
, default:nil
) - Required. The title of the promotion. -
type
(type:String.t
, default:nil
) - Required. The scope of the promotion. Onlyproduct
is supported fororders.createtestorder
. Acceptable values are: - "product
" - "shipping
"
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Content.V21.Model.OrderPromotion{ applicableItems: [GoogleApi.Content.V21.Model.OrderPromotionItem.t()] | nil, appliedItems: [GoogleApi.Content.V21.Model.OrderPromotionItem.t()] | nil, endTime: String.t() | nil, funder: String.t() | nil, merchantPromotionId: String.t() | nil, priceValue: GoogleApi.Content.V21.Model.Price.t() | nil, shortTitle: String.t() | nil, startTime: String.t() | nil, subtype: String.t() | nil, taxValue: GoogleApi.Content.V21.Model.Price.t() | nil, title: String.t() | nil, type: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.