Class OrderPromotion
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1.Data
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class OrderPromotion : IDirectResponseSchema
Properties
ApplicableItems
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.
Declaration
[JsonProperty("applicableItems")]
public virtual IList<OrderPromotionItem> ApplicableItems { get; set; }
Property Value
Type | Description |
---|---|
IList<OrderPromotionItem> |
AppliedItems
Items that this promotion have been applied to. Do not provide for orders.createtestorder
. This field will
be empty for shipping promotions because shipping is not tied to any specific item.
Declaration
[JsonProperty("appliedItems")]
public virtual IList<OrderPromotionItem> AppliedItems { get; set; }
Property Value
Type | Description |
---|---|
IList<OrderPromotionItem> |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EndTime
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".
Declaration
[JsonProperty("endTime")]
public virtual string EndTime { get; set; }
Property Value
Type | Description |
---|---|
string |
Funder
Required. The party funding the promotion. Only merchant
is supported for orders.createtestorder
.
Acceptable values are: - "google
" - "merchant
"
Declaration
[JsonProperty("funder")]
public virtual string Funder { get; set; }
Property Value
Type | Description |
---|---|
string |
MerchantPromotionId
Required. This field is used to identify promotions within merchants' own systems.
Declaration
[JsonProperty("merchantPromotionId")]
public virtual string MerchantPromotionId { get; set; }
Property Value
Type | Description |
---|---|
string |
PriceValue
Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
Declaration
[JsonProperty("priceValue")]
public virtual Price PriceValue { get; set; }
Property Value
Type | Description |
---|---|
Price |
ShortTitle
A short title of the promotion to be shown on the checkout page. Do not provide for
orders.createtestorder
.
Declaration
[JsonProperty("shortTitle")]
public virtual string ShortTitle { get; set; }
Property Value
Type | Description |
---|---|
string |
StartTime
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".
Declaration
[JsonProperty("startTime")]
public virtual string StartTime { get; set; }
Property Value
Type | Description |
---|---|
string |
Subtype
Required. The category of the promotion. Only moneyOff
is supported for orders.createtestorder
.
Acceptable values are: - "buyMGetMoneyOff
" - "buyMGetNMoneyOff
" - "buyMGetNPercentOff
" -
"buyMGetPercentOff
" - "freeGift
" - "freeGiftWithItemId
" - "freeGiftWithValue
" -
"freeShippingOvernight
" - "freeShippingStandard
" - "freeShippingTwoDay
" - "moneyOff
" -
"percentOff
" - "rewardPoints
" - "salePrice
"
Declaration
[JsonProperty("subtype")]
public virtual string Subtype { get; set; }
Property Value
Type | Description |
---|---|
string |
TaxValue
Estimated discount applied to tax (if allowed by law). Do not provide for orders.createtestorder
.
Declaration
[JsonProperty("taxValue")]
public virtual Price TaxValue { get; set; }
Property Value
Type | Description |
---|---|
Price |
Title
Required. The title of the promotion.
Declaration
[JsonProperty("title")]
public virtual string Title { get; set; }
Property Value
Type | Description |
---|---|
string |
Type
Required. The scope of the promotion. Only product
is supported for orders.createtestorder
. Acceptable
values are: - "product
" - "shipping
"
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type | Description |
---|---|
string |