eBay Promotion Manager Technical Scope

Useful to read when configuring promotions: https://developer.ebay.com/api-docs/sell/static/marketing/promotions-manager.html

PHASE 1

Create Item Price Markdown Promotion

This method creates an item price markdown promotion (know simply as a "markdown promotion") where a discount amount is applied directly to the items included the promotion. Discounts can be specified as either a monetary amount or a percentage off the standard sales price. eBay highlights promoted items by placing teasers for the items throughout the online sales flows.

Unlike an item promotion, a markdown promotion does not require the buyer meet a "threshold" before the offer takes effect. With markdown promotions, all the buyer needs to do is purchase the item to receive the promotion benefit.

Important: There are some restrictions for which listings are available for price markdown promotions. For details, see Promotions Manager requirements and restrictions.

In addition, we recommend you list items at competitive prices before including them in your markdown promotions. For an extensive list of pricing recommendations, see the Growth tab in Seller Hub.

There are two ways to add items to markdown promotions:

• Key-based promotions select items using either the listing IDs or inventory reference IDs of the items you want to promote. Note that if you use inventory reference IDs, you must specify both the inventoryReferenceId and the associated inventoryReferenceType of the item(s) you want to include the promotion.
• Rule-based promotions select items using a list of eBay category IDs or seller Store category IDs. Rules can further constrain items in a promotion by minimum and maximum prices, brands, and item conditions. In phase one we will be introducing only Key-based promotions selection. POST https://api.ebay.com/sell/marketing/v1/item_price_markdown

{
  "applyFreeShipping": "boolean",
  "autoSelectFutureInventory": "boolean",
  "blockPriceIncreaseInItemRevision": "boolean",
  "description": "string",
  "endDate": "string",
  "marketplaceId": "MarketplaceIdEnum : [EBAY_AT,EBAY_AU,EBAY_BE,EBAY_CA,EBAY_CH,EBAY_CN,EBAY_CZ,EBAY_DE,EBAY_DK,EBAY_ES,EBAY_FI,EBAY_FR,EBAY_GB,EBAY_GR,EBAY_HK,EBAY_HU,EBAY_ID,EBAY_IE,EBAY_IL,EBAY_IN,EBAY_IT,EBAY_JP,EBAY_MY,EBAY_NL,EBAY_NO,EBAY_NZ,EBAY_PE,EBAY_PH,EBAY_PL,EBAY_PR,EBAY_PT,EBAY_RU,EBAY_SE,EBAY_SG,EBAY_TH,EBAY_TW,EBAY_US,EBAY_VN,EBAY_ZA,EBAY_HALF_US,EBAY_MOTORS_US]",
  "name": "string",
  "priority": "PromotionPriorityEnum : [PRIORITY_1,PRIORITY_2,PRIORITY_3,PRIORITY_4,INVALID]",
  "promotionImageUrl": "string",
  "promotionStatus": "PromotionStatusEnum : [SCHEDULED,RUNNING,PAUSED,DRAFT,ENDED,INVALID]",
  "selectedInventoryDiscounts": [
    {
      "discountBenefit": {
        "amountOffItem": {
          "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
          "value": "string"
        },
        "amountOffOrder": {
          "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
          "value": "string"
        },
        "percentageOffItem": "string",
        "percentageOffOrder": "string"
      },
      "discountId": "string",
      "inventoryCriterion": {
        "inventoryCriterionType": "InventoryCriterionEnum : [INVENTORY_BY_RULE,INVENTORY_BY_VALUE,INVENTORY_ANY]",
        "inventoryItems": [
          {
            "inventoryReferenceId": "string",
            "inventoryReferenceType": "InventoryReferenceTypeEnum : [INVENTORY_ITEM,INVENTORY_ITEM_GROUP]"
          }
        ],
        "listingIds": [
          "string"
        ],
        "ruleCriteria": {
          "excludeInventoryItems": [
            {
              "inventoryReferenceId": "string",
              "inventoryReferenceType": "InventoryReferenceTypeEnum : [INVENTORY_ITEM,INVENTORY_ITEM_GROUP]"
            }
          ],
          "excludeListingIds": [
            "string"
          ],
          "markupInventoryItems": [
            {
              "inventoryReferenceId": "string",
              "inventoryReferenceType": "InventoryReferenceTypeEnum : [INVENTORY_ITEM,INVENTORY_ITEM_GROUP]"
            }
          ],
          "markupListingIds": [
            "string"
          ],
          "selectionRules": [
            {
              "brands": [
                "string"
              ],
              "categoryIds": [
                "string"
              ],
              "categoryScope": "CategoryScopeEnum : [MARKETPLACE,STORE]",
              "listingConditionIds": [
                "string"
              ],
              "maxPrice": {
                "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
                "value": "string"
              },
              "minPrice": {
                "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
                "value": "string"
              }
            }
          ]
        }
      },
      "ruleOrder": "integer"
    }
  ],
  "startDate": "string"
}

If the type of the eBay promotion in our Hemi Promotion Manager wizard is set as ITEM_PRICE_MARKDOWN_PROMOTION then we need to be able to store all promotion details in Hemi and I would suggest the following.

New Table eBay Promotions

Coded Coupon Markdown Sale Order Discount Volume Discount | enum field with all promotion types and depends on the selection the correct fields should be displayed. | | | | | | | | eBay Promotion > External ID | | Unique Id returned from eBay when created successfully | | | | | | | | eBay Promotion > Account ID | Dropdown field with all eBay Accounts | For which Hemi account we would like to create promotion | | | | | | | | eBay Promotion > Action | Radio buttons: Create Pause Resume | Enumeration with the relevant actions. Create is our Default Action | | | | | | | | eBay Promotion >Action Status | Radio buttons: Pending Error Not Needed Sent | | | | | | | | | eBay Promotion Discount Rule > Total Listings | | Field which will count the total products in a discount rule of promotion (only in case inventory criterion is INVENTORY_BY_VALUE). | | | | | | | | eBay Promotion Discount Rule > Success Listings | | Field which will count the total successfully added products in a discount rule of promotion (only in case inventory criterion is INVENTORY_BY_VALUE). | | applyFreeShipping | | | | | | eBay Markdown Sale Promotion > Apply Free Shipping | | If set to true, free shipping is applied to the first shipping service specified for the item. The first domestic shipping option is set to "free shipping," regardless if the shipping optionType for that service is set to FLAT_RATE, CALCULATED, or NOT_SPECIFIED (freight). This flag essentially adds free shipping as a promotional bonus. | | autoSelectFutureInventory | | | | | | N/A | | If set to true, eBay will automatically add inventory items to the markdown promotion if they meet the selectedInventoryDiscounts criteria specified for the markdown promotion. | | blockPriceIncreaseInItemRevision | | | | | | eBay Markdown Sale Promotion > Protect Price Increase | Read Only field with default value - Yes | If set to true, price increases (including removing the free shipping flag) are blocked and an error message is returned if a seller attempts to adjust the price of an item that's partaking in this markdown promotion. If set to false, an item is dropped from the markdown promotion if the seller adjusts the price. | | description | | | | | | eBay Promotions > Description | | This field is required if you are configuring an MARKDOWNSALE promotion. This is the seller-defined "tag line" for the offer, such as "Save on designer shoes." A tag line appears under the "offer-type text" that is generated for the promotion. The text is displayed on the offer tile that is shown on the seller's All Offers page and on the event page for the promotion.  Note: Offer-type text is a teaser that's presented throughout the buyer's journey through the sales flow and is generated by eBay. This text is not editable by the seller—it's derived from the settings in the discountRules and discountSpecification fields—and can be, for example, "20% off". | | startDate | | | | | | eBay Promotion > Start Date | | The date and time the promotion starts in UTC format (yyyy-MM-ddThh:mm:ssZ). For display purposes, convert this time into the local time of the seller. | | endDate | | | | | | eBay Promotion > End Date | | The date and time the promotion ends, in UTC format (yyyy-MM-ddThh:mm:ssZ). The value supplied for endDate must be at least 24 hours after the value supplied for the startDate of the markdown promotion. If this field is blank (null), it indicates the promotion has no end date. For display purposes, convert this time into the local time of the seller. Max value: • 14 days for the AT, CH, DE, ES, FR, IE, IT, and UK, marketplaces. • 45 days for all other marketplaces. | | marketplaceId | | | | | | Account > Country | | Prefix the value from this field with “EBAY”. In the end we should get something like “EBAY_GB”. | | name | | | | | | eBay Promotion > Promotion Name | | The seller-defined name or 'title' of the promotion that the seller can use to identify a promotion. This label is not displayed in end-user flows. | | priority | | | | | | N/A | | | | promotionImageUrl | | | | | | eBay Promotions > Image URL | | Required for CODED_COUPON and MARKDOWN_SALE promotions, and optional for ORDER_DISCOUNT promotions, populate this field with a URL that points to an image to be used with the promotion. This image is displayed on the seller's All Offers page. The URL must point to either JPEG or PNG image and it must be a minimum of 500x500 pixels in dimension and cannot exceed 12Mb in size. | | promotionStatus | | | | | | eBay Promotions > External Status | Hardcode SCHEDULED when creating promotions. | The current status of the promotion. When creating a new promotion, you must set this value to either DRAFT or SCHEDULED. Note that you must set this value to SCHEDULED when you update a RUNNING promotion | | selectedInventoryDiscounts | | | | | | | | | | | discountBenefit | | | | | eBay Promotion Discount Rule > Discount Type AND eBay Promotion Discount Rule > Discount Object | | The content in this container is determined by the value of the two fields. • Discount Type = Amount + Discount Object = Item → send amountOffItem container • Discount Type = Amount + Discount Object = Order → send amountOffOrder container • Discount Type = Percentage + Discount Object = Item → send percentageOffItem field • Discount Type = Percentage + Discount Object = Order → send percentageOffOrder field | | | | amountOffItem | | | | | | | | | | | value | | | eBay Promotion Discount Rule > Discount Value | | The monetary amount that is discounted off an item (or items) when the promotion criteria is met. For threshold promotions, where the buyer triggers the discount, the valid values for this field are:   5, 6, 7, 8, 9, 10, 15, 20, 25,  30, 35, 40, 45, 50, 55, 60, 65,  70, 75, 80, 85, 90, 95, 100, 110,  120, 125, 150, 200, 250 For markdown promotions, the range is greater, as outlined below and detailed more precisely here: • $1 increments from $5 to $100 • $5 increments from $105 to $1,000 • $100 increments from $1,100 to $15,000 Occurrence: Optional | | | | | currency | | | Account > Exchange Rate Calculator Currency | | The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD. Default: The default currency of the eBay marketplace that hosts the listing. | | | | amountOffOrder | | | | | | | | | | | currency | | | Account > Exchange Rate Calculator Currency | | The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD. Default: The default currency of the eBay marketplace that hosts the listing. | | | | | value | | | eBay Promotion Discount Rule > Discount Value | | The monetary amount in the specified currency. Required in the amount type. | | | | percentageOffItem | | | | eBay Promotion Discount Rule > Discount Value | | The percentage applied to the sales price that is discounted off the promoted item (or items) when the promotion criteria is met. Valid integer values for percentage off:   Min: 5   Max: 80 | | | | percentageOffOrder | | | | eBay Promotion Discount Rule > Discount Value | | Used for threshold promotions, this is the percentage of the order price that is discounted off the order when the promotion criteria is met. This field is not value for markdown promotions. Valid integer values for ORDER_DISCOUNT promotions:   Min: 5   Max: 80 For VOLUME_DISCOUNT promotions: Must be set to 0 for the first discount rule. | | | discountId | | | | | N/A | | A unique, eBay-generated ID that you can use to identify the discount. This field is ignored in POST and PUT operations. | | | inventoryCriterion | | | | | | | | | | | inventoryCriterionType | | | | eBay Promotion Discount Rule > Inventory Criterion Type | Radio buttons: Inventory by Value Any Inventory | Indicates how the items to include in the promotion are selected. You can include inventory by ID, using rules, or globally include all your inventory Available enum items - INVENTORY_BY_VALUE, INVENTORY_ANY | | | | listingIds | | | | eBay Promotion Listing > Channel Item ID | | An array of eBay listing IDs to be added to the promotion.  Note: The request can have either inventoryItems or listingIds, but not both.

Required: All listings in a promotion must offer an electronic payment method. Maximum: 500 parent items Maximum SKU or custom label length: 50 characters Required if InventoryCriterionType is set to INVENTORY_BY_VALUE, you must specify either inventoryItems or listingIds.

Should contains all listings ids separated by comma participating in the promotion | | | | ruleCriteria | | | | | | | | | | | excludeListingIds | | | N/A | | A list of eBay listing IDs to exclude from the promotion. Note: The request can have either excludeInventoryItems or excludeListingIds but not both.  Maximum: 100 parent items Maximum SKU or custom label length: 50 characters Should contains all listings ids separated by comma which we would like to exclude from the promotion | | | | | selectionRules | | | | | | | | | | | brands | | N/A | | The list of brands in the seller's inventory to include in the promotion. This field is applicable only when categoryScope is set to MARKETPLACE. | | | | | | categoryIds | | N/A | | Each selectionRules container can specify only a single category ID to include in the promotion. The ID can be either an eBay category ID or a seller's store category ID. | | | | | | categoryScope | | N/A | | The type of the category ID for the item(s) to be included in the promotion. You must always supply both categoryIds and categoryScope. Note: A request can have only one categoryScope. Required: When inventoryCriterionType is set to INVENTORY_BY_RULE. MARKETPLACE Indicates the category ID specified is an eBay category ID. STORE Indicates the category ID specified is a seller's Store category ID. | | | | | | listingConditionIds | | N/A | | A list of IDs that describe the condition of the items included in the promotion. For more information, see Item condition ID and name values. | | | | | | maxPrice | | | | | | | | | | | currency | N/A | | This sets the maximum value of the price range for the items included in the promotion. Only items whose price is equal to or less than maxPrice are included in the promotion. Important: You must set minPrice if you set maxPrice. | | | | | | | value | N/A | | The monetary amount in the specified currency. Required in the amount type. | | | | | | minPrice | | | | | | | | | | | currency | N/A | | This sets the minimum value of the price range for the items included in the promotion. Only items whose price is equal to or greater than minPrice are included in the promotion. Important: You must set maxPrice if you set minPrice. | | | | | | | value | N/A | | The monetary amount in the specified currency. Required in the amount type. |

Get Item Price Markdown Promotion

This method returns the complete details of the item price markdown promotion that's indicated by the promotion_id path parameter.

Call getPromotions to retrieve the IDs of a seller's promotions. We will use this call to update our IPM promotion status. GET https://api.ebay.com/sell/marketing/v1/item_price_markdown/{promotion_id}

Create Item Promotion

Here we have to decide if we would like to introduce a new table where to store these promotions or we can use the same table as Item Price Markdown Promotions.

This method creates an item promotion, where the buyer receives a discount when they meet the buying criteria that's set for the promotion. Known here as "threshold promotions", these promotions trigger when a threshold is met.

eBay highlights promoted items by placing teasers for the promoted items throughout the online buyer flows.

Discounts are specified as either a monetary amount or a percentage off the standard sales price of a listing, letting you offer deals such as "Buy 1 Get 1" and "Buy $50, get 20% off".

Volume pricing promotions increase the value of the discount as the buyer increases the quantity they purchase.

Coded Coupons provide unique codes that a buyer can use during checkout to receive a discount. The seller can specify the number of times a buyer can use the coupon and the maximum amount across all purchases that can be discounted using the coupon. The coupon code can also be made public (appearing on the seller’s Offer page, search pages, the item listing, and the checkout page) or private (only on the seller’s Offer page, but the seller can include the code in email and social media).

Note: Coded Coupons are currently available in the US, UK, DE, FR, IT, ES, and AU marketplaces.

We will be using Key-based promotions in order to specify for which listing IDs we would like to advertise a new promotion.

If we receive error we will store it in the promotion ads table .

POST https://api.ebay.com/sell/marketing/v1/item_promotion

{
  "applyDiscountToSingleItemOnly": "boolean",
  "budget": {
    "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
    "value": "string"
  },
  "couponConfiguration": {
    "couponCode": "string",
    "couponType": "CouponTypeEnum : [PRIVATE_SINGLE_SELLER_COUPON,PUBLIC_SINGLE_SELLER_COUPON]",
    "maxCouponRedemptionPerUser": "integer"
  },
  "description": "string",
  "discountRules": [
    {
      "discountBenefit": {
        "amountOffItem": {
          "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
          "value": "string"
        },
        "amountOffOrder": {
          "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
          "value": "string"
        },
        "percentageOffItem": "string",
        "percentageOffOrder": "string"
      },
      "discountSpecification": {
        "forEachAmount": {
          "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
          "value": "string"
        },
        "forEachQuantity": "integer",
        "minAmount": {
          "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
          "value": "string"
        },
        "minQuantity": "integer",
        "numberOfDiscountedItems": "integer"
      },
      "maxDiscountAmount": {
        "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
        "value": "string"
      },
      "ruleOrder": "integer"
    }
  ],
  "endDate": "string",
  "inventoryCriterion": {
    "inventoryCriterionType": "InventoryCriterionEnum : [INVENTORY_BY_RULE,INVENTORY_BY_VALUE,INVENTORY_ANY]",
    "inventoryItems": [
      {
        "inventoryReferenceId": "string",
        "inventoryReferenceType": "InventoryReferenceTypeEnum : [INVENTORY_ITEM,INVENTORY_ITEM_GROUP]"
      }
    ],
    "listingIds": [
      "string"
    ],
    "ruleCriteria": {
      "excludeInventoryItems": [
        {
          "inventoryReferenceId": "string",
          "inventoryReferenceType": "InventoryReferenceTypeEnum : [INVENTORY_ITEM,INVENTORY_ITEM_GROUP]"
        }
      ],
      "excludeListingIds": [
        "string"
      ],
      "markupInventoryItems": [
        {
          "inventoryReferenceId": "string",
          "inventoryReferenceType": "InventoryReferenceTypeEnum : [INVENTORY_ITEM,INVENTORY_ITEM_GROUP]"
        }
      ],
      "markupListingIds": [
        "string"
      ],
      "selectionRules": [
        {
          "brands": [
            "string"
          ],
          "categoryIds": [
            "string"
          ],
          "categoryScope": "CategoryScopeEnum : [MARKETPLACE,STORE]",
          "listingConditionIds": [
            "string"
          ],
          "maxPrice": {
            "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
            "value": "string"
          },
          "minPrice": {
            "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
            "value": "string"
          }
        }
      ]
    }
  },
  "marketplaceId": "MarketplaceIdEnum : [EBAY_AT,EBAY_AU,EBAY_BE,EBAY_CA,EBAY_CH,EBAY_CN,EBAY_CZ,EBAY_DE,EBAY_DK,EBAY_ES,EBAY_FI,EBAY_FR,EBAY_GB,EBAY_GR,EBAY_HK,EBAY_HU,EBAY_ID,EBAY_IE,EBAY_IL,EBAY_IN,EBAY_IT,EBAY_JP,EBAY_MY,EBAY_NL,EBAY_NO,EBAY_NZ,EBAY_PE,EBAY_PH,EBAY_PL,EBAY_PR,EBAY_PT,EBAY_RU,EBAY_SE,EBAY_SG,EBAY_TH,EBAY_TW,EBAY_US,EBAY_VN,EBAY_ZA,EBAY_HALF_US,EBAY_MOTORS_US]",
  "name": "string",
  "priority": "PromotionPriorityEnum : [PRIORITY_1,PRIORITY_2,PRIORITY_3,PRIORITY_4,INVALID]",
  "promotionImageUrl": "string",
  "promotionStatus": "PromotionStatusEnum : [SCHEDULED,RUNNING,PAUSED,DRAFT,ENDED,INVALID]",
  "promotionType": "PromotionTypeEnum : [CODED_COUPON,MARKDOWN_SALE,ORDER_DISCOUNT,VOLUME_DISCOUNT]",
  "startDate": "string"
}

If set to true, the discount is applied only when the buyer purchases multiple quantities of a single item in the promotion. Otherwise, the promotional discount applies to multiple quantities of any items in the promotion. Different variations of a multi-variation item are considered to be the same item. Note that this flag is not relevant if the inventoryCriterion container identifies a single listing ID for the promotion. | | budget | | | | | | | | | currency | | | | eBay Coded Coupon Promotion > Currency | Drop Down Filed with USD, GBP, EUR, and AUD options | | | value | | | | eBay Coded Coupon Promotion > Budget | | | couponConfiguration | | | | | | | | | couponCode | | | | eBay Coded Coupon Promotion > Coupon Code | A unique code that buyers can use during checkout to receive a discount. The code must be unique across eBay. The code must be from 8-15 alphanumeric characters and can contain no more than two dashes ( - ). This is required when the promotion type is CODED_COUPON. | | | couponType | | | | eBay Coded Coupon Promotion > Coupon Type | • PRIVATE_SINGLE_SELLER_COUPON: Anyone can use and share the coupon code, but it isn't posted on eBay. • PUBLIC_SINGLE_SELLER_COUPON: Anyone can find the coupon code on eBay and use it. Enumeration with the values | | | maxCouponRedemptionPerUser | | | | eBay Coded Coupon Promotion > Max Coupon Redemption Per User | This sets the limit on the number of times a buyer can use this coupon. The range of values is 1-10. If no value is provided, a buyer can use the coupon an unlimited number of times. | | description | | | | | eBay Promotion > Description | This is the seller-defined "tag line" for the offer, such as "Save on designer shoes." The tag line appears under the "offer-type text" that is generated for the promotion and is displayed on the offer tile that's shown on the seller's All Offers page, and on the event page for the promotion.  Note: Offer-type text is a teaser that's presented throughout the buyer's journey through the sales flow and is generated by eBay. The offer-type text is not editable by the seller—it's derived from the settings in the discountRules and discountSpecification fields—and can be, for example, "Extra 20% off when you buy 3+".

Maximum length: 50 Required if you are configuring ORDER_DISCOUNT or MARKDOWN_SALE promotions (and not valid for VOLUME_DISCOUNT promotions). | | discountRules | | | | | | | | | discountBenefit | | | | eBay Promotion Discount Rule > Discount Type AND eBay Promotion Discount Rule > Discount Object | The content in this container is determined by the value of the two fields. • Discount Type = Amount + Discount Object = Item → send amountOffItem container • Discount Type = Amount + Discount Object = Order → send amountOffOrder container • Discount Type = Percentage + Discount Object = Item → send percentageOffItem field • Discount Type = Percentage + Discount Object = Order → send percentageOffOrder field | | | | amountOffItem | | | | The monetary amount that is discounted off an item (or items) when the promotion criteria is met. For threshold promotions, where the buyer triggers the discount, the valid values for this field are:   5, 6, 7, 8, 9, 10, 15, 20, 25,  30, 35, 40, 45, 50, 55, 60, 65,  70, 75, 80, 85, 90, 95, 100, 110,  120, 125, 150, 200, 250 For markdown promotions, the range is greater, as outlined below and detailed more precisely here: • $1 increments from $5 to $100 • $5 increments from $105 to $1,000 • $100 increments from $1,100 to $15,000 Occurrence: Optional | | | | | currency | | Account > Exchange Rate Calculator Currency | The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD. Default: The default currency of the eBay marketplace that hosts the listing. | | | | | value | | eBay Promotion Discount Rule > Discount Value | | | | | amountOffOrder | | | | Used for threshold promotions, this is the monetary amount that is discounted off an order when the promotion criteria is met. Because this field is valid only for orders, it's not a valid combination to use with markdown promotions. Valid values for the associated amountOffOrder.value field:   5, 6, 7, 8, 9, 10, 15, 20, 25,  30, 35, 40, 45, 50, 55, 60, 65,  70, 75, 80, 85, 90, 95, 100, 110,  120, 125, 150, 200, 250 Occurrence: Optional | | | | | currency | | Account > Exchange Rate Calculator Currency | | | | | | value | | eBay Promotion Discount Rule > Discount Value | The monetary amount in the specified currency. Required in the amount type. | | | | percentageOffItem | | | eBay Promotion Discount Rule > Discount Value | The percentage applied to the sales price that is discounted off the promoted item (or items) when the promotion criteria is met. Valid integer values for percentage off:   Min: 5   Max: 80 | | | | percentageOffOrder | | | eBay Promotion Discount Rule > Discount Value | Used for threshold promotions, this is the percentage of the order price that is discounted off the order when the promotion criteria is met. This field is not value for markdown promotions. Valid integer values for ORDER_DISCOUNT promotions:   Min: 5   Max: 80 For VOLUME_DISCOUNT promotions: Must be set to 0 for the first discount rule. | | | discountSpecification | | | | eBay Promotion Discount Rule > Discount Specification Type | Depending on this field’s value send the respective node: • Min Amount - send minAmount container • Min Quantity - send minQuantity field • For Each Quantity - send forEachQuantity field • For Each Amount - send forEachAmount container | | | | forEachAmount | | | | Important: When configuring volume pricing promotions, only minQuantity is applicable as a discountSpecification. Also, the configuration for minQuantity in a volume pricing configuration is specific. In the first discountSpecification container, set minQuantity to 1, and in the second, set minQuantity to 2. If you include a third discountRules pair, minQuantity must be set to 3, and in a fourth, it must be set to 4. Also, you must set a ruleOrder value in each discountRules container. In the first container, discountRules must be set to 1, and in each subsequent container, the value be be incremented by 1. For more, see Configuring volume pricing discounts. Tip: see Configuring discounts for threshold promotions for information and examples on how to combine discountBenefit and discountSpecification to create different types of promotions. The monetary amount that must be spent on promoted items before the promotional discount is applied. Valid values for the associated forEachAmount.value field:   5, 10, 15, 20, 25, 30, 35, 40, 45, 49,  50, 55, 59, 60, 65, 69, 70, 75, 79, 80,  85, 89, 90, 95, 99, 100, 110, 120, 125,  149, 150, 175, 199, 200, 249, 250, 299,  300, 350, 399, 400, 450, 499, 500 Occurrence: Optional | | | | | currency | | Account > Exchange Rate Calculator Currency | The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD. Default: The default currency of the eBay marketplace that hosts the listing. Occurrence: Optional | | | | | value | | eBay Promotion Discount Rule > Discount Specification Value | The monetary amount in the specified currency. Required in the amount type. | | | | forEachQuantity | | | eBay Promotion Discount Rule > Discount Specification Value | The number of items that must be purchased in order to qualify for the discount. Valid values:   1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11,  12, 13, 14, 15, 16, 17, 18, 19  20, 25, 50, 75, 100 | | | | minAmount | | | | | | | | | currency | | Account > Exchange Rate Calculator Currency | | | | | | value | | eBay Promotion Discount Rule > Discount Specification Value | | | | | minQuantity | | | eBay Promotion Discount Rule > Discount Specification Value | The minimum quantity of promoted items that needs to be bought in order to qualify for the promotion's discount. Valid values:   1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11,  12, 13, 14, 15, 16, 17, 18, 19  20, 25, 50, 75, 100 Occurrence: Optional | | | | numberOfDiscountedItems | | | eBay Promotion Discount Rule > Number of Discounted Items | Use this field to configure "Buy One Get One" (or BOGO) promotions. You must couple this field with forEachQuantity and an amountOffItem or percentOffItem field to configure your BOGO promotion. This field is not valid with order-based promotions. The value of this field represents the number of items to be discounted when other promotion criteria is met. For example, when the buyer adds the number of items identified by the forEachQuantity value to their cart, they are then eligible to receive the stated discount from an additional number of like items (the number of which is identified by this field) when they add those items to their cart. To receive the discount, the buyer must purchase the number of items indicated by forEachQuantity plus the number indicated by this field. Valid values:   1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Occurrence: Optional | | | maxDiscountAmount | | | | | | | | | currency | | | Same as eBay Coded Coupon Promotion > Currency | | | | | value | | | eBay Coded Coupon Promotion > Max Discount Amount | | | | ruleOrder | | | | eBay Promotion Discount Rule > Rule Order | | | endDate | | | | | eBay Promotion > End Date | The date and time the promotion ends in UTC format (yyyy-MM-ddThh:mm:ssZ). If this field is blank (null), it indicates the promotion has no end date. For display purposes, convert this time into the local time of the seller. | | inventoryCriterion | | | | | | | | | inventoryCriterionType | | | | eBay Promotion Discount Rule > Inventory Criterion Type | Indicates how the items to include in the promotion are selected. You can include inventory by ID, using rules, or globally include all your inventory Dropdown with available enums - INVENTORY_BY_VALUE | | | inventoryItems | | | | | | | | | inventoryReferenceId | | | N/A | | | | | inventoryReferenceType | | | N/A | | | | listingIds | | | | eBay Promotion Listing > Channel Item ID | An array of eBay listing IDs to be added to the promotion. To be used if INVENTORY_BY_VALUE is selected | | | ruleCriteria | | | | | | | | | excludeInventoryItems | | | | | | | | | | inventoryReferenceId | N/A | | | | | | | inventoryReferenceType | N/A | | | | | excludeListingIds | | | Exclude Listing IDs? | A list of eBay listing IDs to exclude from the promotion. Note: The request can have either excludeInventoryItems or excludeListingIds but not both. Maximum: 100 parent items Maximum SKU or custom label length: 50 characters Should contains all listings ids separated by comma which we would like to exclude from the promotion | | | | markupInventoryItems | | | | | | | | | inventoryReferenceId | | N/A | | | | | | inventoryReferenceType | | N/A | | | | | markupListingIds | | | N/A | | | | | selectionRules | | | | | | | | | brands | | N/A | The list of brands in the seller's inventory to include in the promotion. This field is applicable only when categoryScope is set to MARKETPLACE. | | | | | categoryIds | | N/A | Each selectionRules container can specify only a single category ID to include in the promotion. The ID can be either an eBay category ID or a seller's store category ID. | | | | | categoryScope | | N/A | The type of the category ID for the item(s) to be included in the promotion. You must always supply both categoryIds and categoryScope. Note: A request can have only one categoryScope. Required: When inventoryCriterionType is set to INVENTORY_BY_RULE. MARKETPLACE Indicates the category ID specified is an eBay category ID. STORE Indicates the category ID specified is a seller's Store category ID. | | | | | maxPrice | | | | | | | | | currency | N/A | This sets the maximum value of the price range for the items included in the promotion. Only items whose price is equal to or less than maxPrice are included in the promotion. Important: You must set minPrice if you set maxPrice. | | | | | | value | N/A | The monetary amount in the specified currency. Required in the amount type. | | | | | minPrice | | | | | | | | | currency | N/A | This sets the minimum value of the price range for the items included in the promotion. Only items whose price is equal to or greater than minPrice are included in the promotion. Important: You must set maxPrice if you set minPrice. | | | | | | value | N/A | The monetary amount in the specified currency. Required in the amount type. | | marketplaceId | | | | | Account > Country | The eBay marketplace ID of the site where the markdown promotion is hosted. Markdown promotions are supported on all eBay marketplaces. Prefix the value from this field with “EBAY_”. In the end we should get something like “EBAY_GB”. | | name | | | | | eBay Promotion > Promotion Name | The seller-defined name or 'title' of the promotion that the seller can use to identify a promotion. This label is not displayed in end-user flows. | | priority | | | | | N/A | | | promotionImageUrl | | | | | eBay Promotions > Image URL | Required for CODED_COUPON and MARKDOWN_SALE promotions, and optional for ORDER_DISCOUNT promotions, populate this field with a URL that points to an image to be used with the promotion. This image is displayed on the seller's All Offers page. The URL must point to either JPEG or PNG image and it must be a minimum of 500x500 pixels in dimension and cannot exceed 12Mb in size. | | promotionStatus | | | | | eBay Promotions > External Status (but hardcode SCHEDULED when creating promotion) | The current status of the promotion. When creating a new promotion, this value must be set to either DRAFT or SCHEDULED.

Note that you must set this value to SCHEDULED when you update a RUNNING promotion. | | promotionType | | | | | eBay Promotions > Promotion Type | Use this field to specify the type of the promotion you are creating. The supported types are: • MARKDOWN_SALE – A markdown promotion set with createItemPriceMarkdownPromotion. • ORDER_DISCOUNT – A threshold promotion set with createItemPromotion. • VOLUME_DISCOUNT – A volume pricing promotion set with createItemPromotion. • CODED_COUPON - Coded coupon promotion set See the Promotions Manager documentation for details. Required if you are creating a volume pricing promotion (VOLUME_DISCOUNT). Occurrence: Conditional | | startDate | | | | | eBay Promotions > Start Date | The date and time the promotion starts in UTC format (yyyy-MM-ddThh:mm:ssZ). For display purposes, convert this time into the local time of the seller. |

Get Item Promotion

This method returns the complete details of the threshold promotion specified by the promotion_id path parameter. Call getPromotions to retrieve the IDs of a seller's promotions.

We will use this call to update our Item Promotion status. GET https://api.ebay.com/sell/marketing/v1/item_promotion/{promotion_id}

Pause Item Promotion

This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from RUNNING to PAUSED. Pausing a promotion makes the promotion temporarily unavailable to buyers and any currently-incomplete transactions will not receive the promotional offer until the promotion is resumed. Also, promotion teasers are not displayed when a promotion is paused.

Pass the ID of the promotion you want to pause using the promotion_id path parameter. Call getPromotions to retrieve the IDs of the seller's promotions. Note: You can only pause threshold promotions (you cannot pause markdown promotions). POST https://api.ebay.com/sell/marketing/v1/promotion/{promotion_id}/pause

Input

Specify the markdown promotion you want to pause using the promotion ID concatenated with the marketplace ENUM as a URI query parameter. See the endpoint below for an example.POST

https://api.ebay.com/sell/marketing/v1/promotion/1****5@EBAY_US/pause

Resume Item Promotion

This method restarts a threshold promotion that was previously paused and changes the state of the promotion from PAUSED to RUNNING. Only promotions that have been previously paused can be resumed. Resuming a promotion reinstates the promotional teasers and any transactions that were in motion before the promotion was paused will again be eligible for the promotion.

Pass the ID of the promotion you want to resume using the promotion_id path parameter. Call getPromotions to retrieve the IDs of the seller's promotions. POST https://api.ebay.com/sell/marketing/v1/promotion/{promotion_id}/resume

Input

Specify the markdown promotion you want to resume using the promotion ID concatenated with the marketplace ENUM as a URI query parameter. See the endpoint below for an example.POST

https://api.ebay.com/sell/marketing/v1/promotion/1****5@EBAY_US/resume

Get Listing Ids of a promotion

This method returns the set of listings associated with the promotion_id specified in the path parameter. Call getPromotions to retrieve the IDs of a seller's promotions.

The listing details are returned in a paginated set and you can control and results returned using the following query parameters: limit, offset, q, sort, and status.

• Maximum associated listings returned: 200

• Default number of listings returned: 200

  GET https://api.ebay.com/sell/marketing/v1/promotion/{promotion_id}/get_listing_set?
  q=string&
  limit=string&
  offset=string&
  sort=SortField&
  status=ItemMarkdownStatusEnum

Responses:

{
    "href": "http://api.ebay.com/sell/marketing/v1/promotion/1********3@EBAY_US/get_listing_set?limit=200&offset=0",
    "total": 4,
    "limit": 200,
    "offset": 0,
    "listings": [
        {
            "listingId": "1********1",
            "inventoryReferenceId": "",
            "title": "0-2017-02-10-11-19-27: Created Fixed Price Item Successfully-1********5",
            "currentPrice": {
                "value": "1.1",
                "currency": "USD"
            },
            "quantity": 20,
            "freeShipping": false,
            "listingCategoryId": "12",
            "storeCategoryId": "1"
        },
        {
            "listingId": "1********2",
            "inventoryReferenceId": "",
            "title": "0-GTC Item1********1",
            "currentPrice": {
                "value": "35.0",
                "currency": "USD"
            },
            "quantity": 15,
            "freeShipping": false,
            "listingCategoryId": "12",
            "storeCategoryId": "1"
        },
        {
            "listingId": "1********3",
            "inventoryReferenceId": "",
            "title": "0-2017-02-10-11-19-27: Created Fixed Price Item Successfully-1********8",
            "currentPrice": {
                "value": "1.1",
                "currency": "USD"
            },
            "quantity": 20,
            "freeShipping": false,
            "listingCategoryId": "12",
            "storeCategoryId": "1"
        },
        {
            "listingId": "1********4",
            "inventoryReferenceId": "",
            "title": "0-2017-02-10-11-29-40: Created Fixed Price Item Successfully-1********6",
            "currentPrice": {
                "value": "50.0",
                "currency": "USD"
            },
            "quantity": 20,
            "freeShipping": false,
            "listingCategoryId": "12",
            "storeCategoryId": "1"
        }
    ]
}

Full sample response:

{
  "href": "string",
  "limit": "integer",
  "listings": [
    {
      "currentPrice": {
        "currency": "CurrencyCodeEnum : [AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL]",
        "value": "string"
      },
      "freeShipping": "boolean",
      "inventoryReferenceId": "string",
      "inventoryReferenceType": "string",
      "listingCategoryId": "string",
      "listingCondition": "string",
      "listingConditionId": "string",
      "listingId": "string",
      "listingPromotionStatuses": [
        {
          "listingMarkdownStatus": "ItemMarkdownStatusEnum : [PENDING,MARKED_DOWN,MARKED_UP,SKIPPED,FAILED]",
          "statusChangedDate": "string",
          "statusMessage": "string"
        }
      ],
      "quantity": "integer",
      "storeCategoryId": "string",
      "title": "string"
    }
  ],
  "next": "string",
  "offset": "integer",
  "prev": "string",
  "total": "integer",
  "warnings": [
    {
      "category": "string",
      "domain": "string",
      "errorId": "integer",
      "inputRefIds": [
        "string"
      ],
      "longMessage": "string",
      "message": "string",
      "outputRefIds": [
        "string"
      ],
      "parameters": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "subdomain": "string"
    }
  ]
}

Mapping What we need to do is to check which channel item ids are successfully added in the promotion and actually participate. This can be checked based on the status we receive for each listing id

Please note based on the states of the promotion the statuses can be excluded from the payload. Also this cron should work only for promotion in PAUSED or RUNNING Statuses and if any of the items which we have imported are missing from the payload should be set on Error with the relevant error message.

Q&A Can single product be part of PL and PM? yes

Can we use Pause and Resume promotion calls for IPM promotions as well?