REST Resource: promotions

Resource: Promotion

Represents a promotion. See the following articles for more details.

JSON representation
{
  "id": string,
  "targetCountry": string,
  "contentLanguage": string,
  "promotionId": string,
  "productApplicability": enum (ProductApplicability),
  "offerType": enum (OfferType),
  "longTitle": string,
  "promotionEffectiveDates": string,
  "redemptionChannel": [
    enum (RedemptionChannel)
  ],
  "couponValueType": enum (CouponValueType),
  "promotionDestinationIds": [
    string
  ],
  "itemId": [
    string
  ],
  "brand": [
    string
  ],
  "itemGroupId": [
    string
  ],
  "productType": [
    string
  ],
  "itemIdExclusion": [
    string
  ],
  "brandExclusion": [
    string
  ],
  "itemGroupIdExclusion": [
    string
  ],
  "productTypeExclusion": [
    string
  ],
  "shippingServiceNames": [
    string
  ],
  "genericRedemptionCode": string,
  "promotionDisplayDates": string,
  "minimumPurchaseAmount": {
    object (PriceAmount)
  },
  "minimumPurchaseQuantity": integer,
  "limitQuantity": integer,
  "limitValue": {
    object (PriceAmount)
  },
  "percentOff": integer,
  "moneyOffAmount": {
    object (PriceAmount)
  },
  "getThisQuantityDiscounted": integer,
  "freeGiftValue": {
    object (PriceAmount)
  },
  "freeGiftDescription": string,
  "freeGiftItemId": string,
  "moneyBudget": {
    object (PriceAmount)
  },
  "orderLimit": integer
}
Fields
id

string

Required. Output only. The REST promotion id to uniquely identify the promotion. Content API methods that operate on promotions take this as their promotionId parameter. The REST ID for a promotion is of the form [channel][#channel]:[contentLanguage][#contentLanguage]:[targetCountry][#targetCountry]:[promotionId][#promotionId] The channel field will have a value of "online", "in_store", or "online_in_store".

targetCountry

string

Required. The target country used as part of the unique identifier.

contentLanguage

string

Required. The content language used as part of the unique identifier.

promotionId

string

Required. The user provided promotion id to uniquely identify the promotion.

productApplicability

enum (ProductApplicability)

Required. Applicability of the promotion to either all products or only specific products.

offerType

enum (OfferType)

Required. Type of the promotion.

longTitle

string

Long title for the promotion.

promotionEffectiveDates

string

Required. String representation of the promotion effective dates.

redemptionChannel[]

enum (RedemptionChannel)

Required. Redemption channel for the promotion. At least one channel is required.

couponValueType

enum (CouponValueType)

Required. Coupon value type for the promotion.

promotionDestinationIds[]

string

Destination ID for the promotion.

itemId[]

string

Product filter by item id for the promotion.

brand[]

string

Product filter by brand for the promotion.

itemGroupId[]

string

Product filter by item group id for the promotion.

productType[]

string

Product filter by product type for the promotion.

itemIdExclusion[]

string

Product filter by item id exclusion for the promotion.

brandExclusion[]

string

Product filter by brand exclusion for the promotion.

itemGroupIdExclusion[]

string

Product filter by item group id exclusion for the promotion.

productTypeExclusion[]

string

Product filter by product type exclusion for the promotion.

shippingServiceNames[]

string

Shipping service names for thse promotion.

genericRedemptionCode

string

Generic redemption code for the promotion. To be used with the above field.

promotionDisplayDates

string

String representation of the promotion display dates.

minimumPurchaseAmount

object (PriceAmount)

Minimum purchase amount for the promotion.

minimumPurchaseQuantity

integer

Minimum purchase quantity for the promotion.

limitQuantity

integer

Maximum purchase quantity for the promotion.

limitValue

object (PriceAmount)

Maximum purchase value for the promotion.

percentOff

integer

The percentage discount offered in the promotion.

moneyOffAmount

object (PriceAmount)

The money off amount offered in the promotion.

getThisQuantityDiscounted

integer

The number of items discounted in the promotion.

freeGiftValue

object (PriceAmount)

Free gift value for the promotion.

freeGiftDescription

string

Free gift description for the promotion.

freeGiftItemId

string

Free gift item id for the promotion.

moneyBudget

object (PriceAmount)

Promotion cost cap of the promotion.

orderLimit

integer

Order limit for the promotion.

ProductApplicability

Specification in a promotion to a specific product or list of products.

Enums
PRODUCT_APPLICABILITY_UNSPECIFIED Unknown product applicability.
ALL_PRODUCTS Applicable to all products.
SPECIFIC_PRODUCTS Applicable to only a single product or list of products.

OfferType

Offer type of a promotion.

Enums
OFFER_TYPE_UNSPECIFIED Unknown offer type.
NO_CODE Offer type without a code.
GENERIC_CODE Offer type with a code.

RedemptionChannel

Channel of a promotion.

Enums
REDEMPTION_CHANNEL_UNSPECIFIED Indicates that the channel is unspecified.
IN_STORE Indicates that the channel is in store.
ONLINE Indicates that the channel is online.

CouponValueType

Coupon value type of a promotion.

Enums
COUPON_VALUE_TYPE_UNSPECIFIED Indicates that the coupon value type is unspecified.
MONEY_OFF Money off coupon value type.
PERCENT_OFF Percent off coupon value type.
BUY_M_GET_N_MONEY_OFF Buy M quantity, get N money off coupon value type. buy_this_quantity and get_this_quantity must be present. moneyOffAmount must also be present.
BUY_M_GET_N_PERCENT_OFF Buy M quantity, get N percent off coupon value type. buy_this_quantity and get_this_quantity must be present. percent_off_percentage must also be present.
BUY_M_GET_MONEY_OFF Buy M quantity, get money off. buy_this_quantity and moneyOffAmount must be present.
BUY_M_GET_PERCENT_OFF Buy M quantity, get money off. buy_this_quantity and percent_off_percentage must be present.
FREE_GIFT Free gift with description only
FREE_GIFT_WITH_VALUE Free gift with value (description is optional).
FREE_GIFT_WITH_ITEM_ID Free gift with item id (description is optional).
FREE_SHIPPING_STANDARD Standard free shipping coupon value type.
FREE_SHIPPING_OVERNIGHT Overnight free shipping coupon value type.
FREE_SHIPPING_TWO_DAY Two day free shipping coupon value type.

Methods

create

Inserts a promotion for your Merchant Center account.

get

Retrieves a promotion from your Merchant Center account.