Marketing API Release Notes

1.23.2

The following changes have been made in this release.

This release added new error codes to support specific campaign-management scenarios for the createCampaign, cloneCampaign, pauseCampaign, updateCampaignIdentification, and updateAdRateStrategy methods.

The following error codes were added (refer to the specific API method documentation for more information):

• 35303 – The status of this campaign cannot be modified through this API.

• 35304 – Another campaign cannot be created at this time, as the user is currently using a feature that only supports one campaign at a time.

• 35306 – The 'endDate' of this campaign cannot be modified through this API.

• 35307 – The 'campaignName' of this campaign cannot be modified through this API.

• 35308 – The 'adRateStrategy' of this campaign cannot be modified through this API.

1.23.1

The following changes have been made in this release.

As of this release, the Promoted Listings with priority campaign strategy is now open to the public and is no longer restricted to approved users only.

1.23.0

The following changes have been made in this release.

This release decommissions two methods from the campaign resource: setupQuickCampaign and launchCampaign.

Decommissioned Methods

The setupQuickCampaign and launchCampaign methods have been decommissioned and removed from the campaign resource. All references to these methods have been removed from the docset.

1.22.4

The following changes have been made in this release.

This release adds a new annotation key value for Promoted Listings reports, as well as three new listing site metric key values.

Added new annotation and metric key values to Promoted Listings reports

For applicable reports, the daily_budget_payout_currency annotationKey has been added when dimensionKey = campaign_id.

In addition, the following listing site metricKeys have been added to applicable reports: 

• When avg_cost_per_sale is supported, the avg_cost_per_sale_listingsite_currency metric key is also now supported.

• When cost_per_click is supported, the cost_per_click_listingsite_currency metric key is also now supported.

• When cpc_avg_cost_per_sale is supported, the cpc_avg_cost_per_sale_listingsite_currency metric key is also now supported.

1.22.3

The following changes have been made in this release.

This release adds new annotation key values for Promoted Listings reports, as well as expands support for the sales_type dimension key for transaction reports.

Added new annotation key values to Promoted Listings reports

For all applicable reports, support for the following annotationKeys have been added when dimensionKey = campaign_id:

• campaign_status

• daily_budget (CPC only)

• daily_budget_status (CPC only)

For All Campaign Performance Summary reports, the following annotationKeys have been added when dimensionKey = campaign_id

• listing_strategy

• budget_strategy

For all applicable reports, support for the following annotationKeys have been added when dimensionKey = seller_keyword_id:

• keyword_bid

• keyword_status

For all applicable reports, support for the listing_status annotation key has been added when dimensionKey = listing_id.

Expanded support for the sales_type dimension key for transaction reports

The sales_type dimensionKey is now applicable for both the CPC and CPS funding models for transaction reports.

1.22.2

The following changes have been made in this release.

This release introduces a new error message in the createReportTask method to effectively manage invalid date entries within the date range filters.

1.22.1

The following changes have been made in this release.

This release adds a daily limit (15 calls per day) to the budget updates you can make to a campaign using the updateCampaignBudget method.

In order to support this change, two new error codes and two new warning codes to the updateCampaignBudget method. In addition, HTTP status code 200 Success has been added to the method.

New error / warning codes

The following error codes have been added to the updateCampaignBudget method: 

Error Code	Description
36167	The daily budget change must be at least 0.50 {currencyCode}.
36168	You have exceeded the allowed limit on daily budget changes for this campaign.

The following warning codes have been added to the updateCampaignBudget method:

Warning Code	Description
36169	You can update your budget one more time today.
36170	You’ve reached the daily update limit for daily budget changes.

1.22.0

The following changes have been made in this release.

This release adds the suggestMaxCpc method to the campaign resource. This method allows sellers to retrieve the suggested maxCpc value for a smart targeting priority strategy campaign.

1.21.2

The following changes have been made in this release.

Promoted Listings Standard campaigns can now be applied to auction listings on all marketplaces. No schema updates were required for this enhancement.

Updated Promoted Listings Standard listing Requirements

For Promoted Listings Standard, all marketplaces now support fixed-price listings, auction listings, and auction listings with Buy It Now feature enabled.

1.21.1

The following changes have been made in this release.

This release adds a new filter option to the getCampaigns method, as well as various new error codes relating to smart targeting campaigns for createCampaign and updateBiddingStrategy.

Added new filter to getCampaigns

The optional campaign_targeting_types filter has been added to the getCampaigns method. This new query parameter allows users to filter their results by campaign targeting type, such as only returning smart targeting campaigns.

New error codes

The following error code has been added to getCampaigns:

Error Code	Description
35123	The 'campaignTargetingType' is not valid. Valid values for 'campaignTargetingType' are: {campaignTargetingTypeValues}.

The following error codes have been added to createCampaign and updateBiddingStrategy:

Error Code	Description
35125	The 'bidPreferences' list currently supports only one element. Please remove additional elements and try again.
35134	A 'biddingStrategy' cannot be supplied for smart targeting campaigns. Please either remove 'biddingStrategy' from the request to create a smart targeting campaign or supply another value for 'campaignTargetingType'.
36161	Smart targeting campaigns require a 'bidPreferences.maxCpc' value.
36162	The 'maxCpc' currency should be the same as the daily budget.
36163	The 'maxCpc' value {maxCpcValue} is below minimum value {maxCpcMinimumValue}.
36164	The 'maxCpc' value {maxCpcValue} is above maximum value {maxCpcMaximumValue}.
36165	The 'maxCpc' value {maxCpcValue} is more than maximum daily budget {maxDailyBudget}.
36166	The 'maxCpc' value {maxCpcValue} is invalid. Refer to the API call documentation for more information.

1.21.0

The following changes have been made in this release.

This release adds updates to the existing schema to support smart targeting for Promoted Listings Advanced (PLA) campaigns, as well as adds new error messages for this functionality.

Changed Functionality

Using the createCampaign method, sellers can now create smart targeting PLA campaigns by setting the campaignTargetingType to SMART and specifying the max cost per click they are willing to pay through the maxCpc field. Smart targeting campaigns are easy to set up and automatically optimize ad campaign settings and handle the bidding and targeting for the seller.

Sellers can update the maxCpc of their smart targeting campaign through the updateBiddingStrategy method.

Schema Changes

The following fields have been added to the createCampaign, getCampaign, getCampaignByName, and getCampaigns methods:

• campaignTargetingType

• bidPreferences

• maxCPC

The following fields have been added to the updateBiddingStrategy method:

• bidPreferences

• maxCPC

New Error Codes

The following error code has been added to the createAdGroup, getAdGroups, getAdGroup, updateAdGroup, suggestBids, suggestKeywords, createKeyword, bulkCreateKeyword, updateKeyword, bulkUpdateKeyword, createNegativeKeyword, bulkCreateNegativeKeyword, updateNegativeKeyword, bulkUpdateNegativeKeyword methods: 

Error Code	Description
35129	This method is not supported for campaigns with smart targeting type

The following error codes have been added to the bulkCreateAdsByListingId method: 

Error Code	Description
35064	This operation is only supported for key based campaigns
35068	You have exceeded the maximum number of listing Ids. Only {maxSupportedNumber} listings are supported per call
36412	Campaigns where the 'campaignTargetingType' is 'SMART' do not support ad groups. Please remove the {adGroupFieldName} and try again.

The following error code has been added to the createAdsByListingId, getAds, bulkUpdateAdsByListingId, bulkCreateAdsByListingId, bulkUpdateAdsStatusByListingId methods: 

Error Code	Description
36412	Campaigns where the 'campaignTargetingType' is 'SMART' do not support ad groups. Please remove the {adGroupFieldName} and try again.

The following error codes have been added to the createCampaign method:

Error Code	Description
35124	The 'maxCpc' {maxCpc} is not valid. Minimum value: {minMaxCpc} , Maximum value:{maxMaxCpc}.
35127	'maxCPC' is only supported for CPC funding model campaigns with on-site channels and smart targeting type.
35128	'campaignTargetingType' is only supported for CPC funding model campaigns with on-site channels.

The following error codes have been added to the updateBiddingStrategy method: 

Error Code	Description
35124	The 'maxCpc' {maxCpc} is not valid. Minimum value: {minMaxCpc} , Maximum value:{maxMaxCpc}.
35126	The 'biddingStrategy' isn't applicable for campaigns with smart targeting type.
35127	'maxCPC' is only supported for CPC funding model campaigns with on-site channels and smart targeting type.

1.20.0

The following changes have been made in this release.

This release adds new URI parameters, response field, HTTP Status Codes and Error Codes to getReportMetadata and getReportMetadataForReportType methods and corresponding samples have been updated.

The following URI parameters are added to getReportMetadata and getReportMetadataForReportType methods.

• funding_model
• channel

The following response field is added to ReportMetadata type

• channel

The following HTTP Status Code is added to getReportMetadata and getReportMetadataForReportType methods.

• 400 - Bad Request

The following Error Codes are added to getReportMetadata and getReportMetadataForReportType methods.

• 35121 - The 'fundingModel' is invalid. Valid values are: {supportedFundingModels}.
• 35125 - The 'channel' is invalid. Valid values are: {supportedChannels}.
• 35127 - The 'channels' are not supported for the 'fundingModel' {fundingModel}.

The following Error Codes are added to getReportMetadataForReportType method.

• 35132 - The 'channels' {supportedChannels} are not supported for the 'report_type' {reportType}.
• 35133 - The 'fundingModel' is not supported for the 'report_type' {reportType}.

1.19.0

The following changes have been made in this release.

This release adds support for Dynamic Bidding to Cost per Click (CPC) campaigns.

New method

The following new method has been added to the campaign resource to support Dynamic Bidding campaigns:

• updateBiddingStrategy: This method allows sellers to change the bidding strategy for a specified Cost Per Click (CPC) campaign.

Schema changes

The following schema changes have been made to support Dynamic Bidding campaigns:

• New enumerated value BiddingStrategyEnum has been added to the following methods:

  • cloneCampaign
  • createCampaign
  • findCampaignByAdReference
  • getCampaign
  • getCampaignByName
  • getCampaigns
• New biddingStrategy field has been added to the FundingStrategy type.

Errors, warnings, and statuses

The following error has been added to the createCampaign method:

• 35132: The 'biddingStrategy' field is not supported for CPS funding model.

The following warning has been added to the bulkCreateKeyword, bulkUpdateKeyword, createKeyword, and updateKeyword methods:

• 35133: The bid provided in the call was ignored because the selected biddingStrategy is DYNAMIC for the campaign.

The following status has been added to the updateKeyword method:

• 200: Success

1.18.0

The following changes have been made in this release.

This release adds updates to the existing schema and a new method to support Offsite Ads campaigns, as well as adds new error messages for this new functionality.

Changed Functionality:

Using the createCampaign method, sellers can now create an Offsite Ads campaign by setting the new channels array to OFF_SITE in the request. An Offsite Ads campaign allows sellers to create their own advertising campaign and promote their listings on leading external channels.

Sellers can also now use the createReportTask method to monitor their Offsite ads campaigns by passing the channels array with the value of OFF_SITE.

Schema changes

The createCampaign, createReportTask, getCampaign, and getCampaigns methods now include the channels array and the new enumerated value of ChannelEnum.

New Method

The following method has been added as a part of the campaign resource to support Offsite Ads campaigns:

• suggestBudget: This method allows sellers to retrieve the suggested budget for an Offsite Ads campaign.

New Error Messages

The following error messages have been added to the createReportTask method: 

Error/Warning Code	Description
35125	The 'channel' is invalid. Valid values are: {supportedChannels}
35126	Multiple channels are not supported. Please use one of the following channels: {supportedChannels}
35127	The 'channels' are not supported for the 'fundingModel' {fundingModel}
25128	The 'dimensionKey' {dimensionKey} is not valid for the 'channels' {supportedChannels}
35129	The 'metricKey' {metricKey} is not valid for the 'channels' {supportedChannels}
35131	The 'annotationKey' {annotationKey} is not supported for the 'channels' {supportedChannels}

The following error messages have been added to the createCampaign method:

Error/Warning Code	Description
35094	Maximum number of campaigns allowed with the 'channels' value {channel} is exceeded.
35095	'marketplaceId' {marketplaceId} is not supported. Offsite Ads is supported only on these marketplaces: {supportedMarketplaces}.
36406	The 'channels' value {channel} can only be used with the {funding_model} fundingModel.
36407	The 'channels' value is invalid.

The following error message has been added to the updateCampaignBudget method:

Error/Warning Code	Description
36408	The seller must accept the new pricing policy before the campaign can be updated.

The following error message has been added to the updateCampaignIdentification method:

Error/Warning Code	Description
36408	The seller must accept the new pricing policy before the campaign can be updated

1.17.2

The following changes have been made in this release.

Increased the maximum number of campaignIds for PLS from 25 to 1,000.

The data threshold for a single report has been increased from 200,000 to 500,000.

1.17.1

The following changes have been made in this release.

1.17.0

The following changes have been made in this release.

This release added 8 new email_campaign methods that allow users to create and send email campaigns to customers who have signed up to receive a seller's newsletter.

New Methods

The following methods have been added as part of the email_campaign resource: 

• createEmailCampaign: This method can be used to create any of the available email campaign types.

• updateEmailCampaign: This method can be used to make changes to an existing email campaign.

• deleteEmailCampaign: This method can be used to delete one email campaign at a time.

• getEmailCampaign: This method returns the details of a single email campaign.

• getEmailCampaigns: This method retrieves a seller's email campaigns.

• getAudiences: This method returns the details on the available audiences for a particular email campaign type.

• getEmailPreview: This method returns a preview of the contents of an email campaign.

• getEmailReport: This method returns data on user engagement for a seller's email campaign.

1.16.0

The following changes have been made in this release.

This release adds two new methods to the campaign resource of the Marketing API: setupQuickCampaign and launchCampaign.

These new methods support quick setup Promoted Listings Advanced Campaign creation, providing sellers with an easier PLA campaign setup experience.

New Methods

The following methods have been added to the campaign resource of the Marketing API to support quick setup Promoted Listings Advanced (PLA) campaign functionality: 

• setupQuickCampaign: This method allows the seller to expedite the creation of a PLA campaign, providing an easy campaign setup experience for sellers. Sellers only need to provide basic campaign information and eBay creates ad groups and keywords for the campaign.

• launchCampaign: This method launches a PLA campaign that has been created using the setupQuickCampaign method.

1.15.3

The following changes have been made in this release.

Promoted Listings Standard campaigns can now be applied to auction listings on eBay Germany marketplace. No schema updates were required for this enhancement.

Added new items to Promoted Listings listing Requirements

The following items were added:

• For Promoted Listings Standard, the eBay Germany marketplace supports both fixed-price listings and auction listings with Buy It Now feature enabled. All other eBay marketplaces only support fixed-price listings for Promoted Listings Standard.

• For Promoted Listings Advanced, the item must be a fixed price (Buy It Now) item.

1.15.2

The following changes have been made in this release.

This release adds support for listing format as a criteria for Promoted Listings reporting.

Added new criteria to Promoted Listings reports

Promoted Listings reports now includes the dimensionKeylisting_format, which indicates if the listing was an auction or fixed price.

1.15.1

The following changes have been made in this release.

This release removed support for multiple funding models from Promoted Listing Reports. To support this change, the following changes have been made.

Added new optional column to transaction report

For Promoted Listings, a column was added to the transaction report. This report now includes the optional dimensionKeysale_type which indicates if the transaction is a Halo Item or a Direct sale.

Removed support for deprecated TRANSACTION_REPORT metricKeys

Support has been removed for the following deprecated TRANSACTION_REPORTmetricKeys:

• PLS Reports:
  • impressions
  • clicks
  • ctr
  • avg_cost_per_sale
  • pl_transactions
• PLA Reports:
  • cpc_impressions
  • cpc_clicks
  • cpc_ctr
  • cpc_conversion_rate
  • cpc_return_on_ad_spend
  • cpc_avg_cost_per_sale
  • cpc_transactions
  • cpc_ad_fees_listingsite_currency
  • cpc_ad_fees_payout_currency
  • cost_per_click

New Error message

The following error code has been added to createReportTask:

• 35124: Multiple funding models are not supported. Please use one of the following funding models: {supportedFundingModels}

1.15.0

The following changes have been made in this release.

Removed error message, added error messages, updated type description for bidPercentage, and increased days listed amount for DE, FR, IT, and ES.

Error message changes

The following new error message was added to the bulkCreateAdsByInventoryReference, bulkCreateAdsByListingId, createAdByListingId, andcreateAdsByInventoryReferencemethods in this release:

Error/Warning Code	Description
35010	The bidPercentage should not be provided when selected adRateStrategy is DYNAMIC for the campaign.

The following new error message was added to the bulkUpdateAdsBidByInventoryReference, bulkUpdateAdsBidByListingId, and updateBid methods in this release:

Error/Warning Code	Description
35113	This operation is not supported when selected adRateStratergy is DYNAMIC for the campaign.

The following error message was removed from the createCampaign and updateAdRateStrategy methods in this release:

Error/Warning Code	Description
35112	The 'adRateAdjustmentPercent' is currently only supported for criterion based campaign with 'autoselectFutureInventory' as True.

Changed functionality

The bidPercentage request field in the FundingStrategy type has been updated in this release. Users should not provide a bidPercentage value when the adRateStrategy for the campaign is dynamic.

In the markdown promotion listing requirements, the Days Listed value has been updated from 14 to 30 days for the following markets:

• DE
• ES
• IT
• FR

1.14.0

The following changes have been made in this release.

This release adds an error message, warning headers, and deprecates capabilities.

New error and warning messages

The following new error and warning message was added to the createReportTask, getReportTask, and getReportTasks methods in this release:

Error/Warning Code	Description
35123	The 'dimensionKey' {dimensionKey} is not valid for the 'fundingModel' {fundingModel}

New HTTP response header

The following new HTTP response header was added to the createReportTask method in this release:

Header	Meaning
Warning	Carries additional information about the status or transformation of a message that might not be reflected in the status code.

API capabilities deprecated

The following list contains API capabilities that are deprecated and scheduled for decommission:

• Multiple value support for the fundingModels array of the createReportTask method
• Support for specific metric keys used in Transaction reports for either funding model: impressions, clicks, ctr, avg_cost_per_sale, pl_transactions, cpc_impressions, cpc_clicks, cpc_ctr, cpc_conversion_rate, cpc_return_on_ad_spend, cpc_avg_cost_per_sale, cpc_transactions, cpc_ad_fees_listingsite_currency, cpc_ad_fees_payout_currency, cost_per_click.

See API Deprecation Status for additional details.

1.13.0

The following changes have been made in this release.

This release adds support for campaigns that are not getting visibility due to a lower ad rate.

Schema changes

The ad and campaign resources now include the alerts container field, its types, and new enumerated values of AspectKeyEnum, AlertTypeEnum, and DimensionKeyEnum. The following new types were added:

• Alert
• AlertDetails
• Aspect
• Dimension

1.12.0

The following changes have been made in this release.

This release adds a new method and new types to support the Promoted Listings Standard (PLS) program.

Schema changes

The campaign resource now includes the new updateAdRateStrategy method. This method updates the ad rate strategy for an existing PLS rules-based ad campaign that uses the Cost Per Sale (CPS) funding model.

In addition to the new method, the following new types were added in this release:

• AdRateStrategyEnum
• DynamicAdRatePreference

1.11.0

The following changes have been made in this release.

This release adds new resources and methods to support the Promoted Listings Advanced (PLA) program, along with updates to the existing schema to support these additions.

Schema changes

The following new methods were added in this release to support the PLA program:

• ad (existing resource):
  • bulkUpdateAdsStatus
  • bulkUpdateAdsStatusByListingId
• ad_group (new resource):
  • createAdGroup
  • getAdGroup
  • getAdGroups
  • suggestBids
  • suggestKeywords
  • updateAdGroup
• campaign (existing resource):
  • suggestItems
  • updateCampaignBudget
• keyword (new resource):
  • bulkCreateKeyword
  • bulkUpdateKeyword
  • createKeyword
  • getKeyword
  • getKeywords
  • updateKeyword
• negative_keyword (new resource):
  • bulkCreateNegativeKeyword
  • bulkUpdateNegativeKeyword
  • createNegativeKeyword
  • getNegativeKeyword
  • getNegativeKeywords
  • updateNegativeKeyword

1.10.2

The following changes have been made in this release.

This release increases the number of campaigns that can be included in Promoted Listings reports.

Changed functionality

The campaignIds request field in the createReportTask method has been updated in this release. Users can now specify up to 25 campaigns in a request to create a report task.

1.10.1

The following changes have been made in this release.

In this release, support was added for autoSelectFutureInventory in rules-based Promoted Listings campaigns, as described in the sections that follow.

Changed functionality

The existing autoSelectFutureInventory request field in the createCampaign method, previously reserved for future use, is now supported for use in rules-based Promoted Listings campaigns.

This request field can be used to indicate whether listings shall be automatically added to, or removed from, a Promoted Listings campaign, according to the rules that have been set. If set to true, eBay adds all listings matching the campaign criterion to the campaign, including any new listings created from the items in a seller's inventory.

New error and warning messages

The following new error and warning messages were added to the createCampaign method in this release:

Error/Warning Code	Description
35103	This campaign has reached maximum capacity of {maxSupportedNumber} listings. To continue promoting listings, create a new campaign.
35104	'categoryScope' STORE can not be found. Please define the store categories first or use 'categoryScope' MARKETPLACE to select categories.

1.10.0

The following changes have been made in this release.

This release adds support for the Coded Coupon promotion type.

Changed functionality

A Coded Coupon is a unique code that buyers can use during checkout to receive a discount. The code may be private, appearing only on the seller's Offer page, or it may be made public, appearing on the Offer page, the search results page, the View Item page, and the Checkout page. The seller may limit the number of times a buyer can use the coupon code and can set a budget that defines the maximum total cumulative amount that can be discounted from all uses of the coupon code.

1.9.0

The following changes have been made in this release.

This release updates the start and end time inputs used for Promoted Listings reports.

Changed functionality

With this release, Promoted Listings report start and end times are no longer synchronized according to Mountain Standard Time (MST).

The dateFrom and dateTo request fields for all Promoted Listing reports are now input as ISO 8601-formatted strings, which are based on the 24-hour Coordinated Universal Time (UTC) clock with local offset.

For example, if a user wanted to create a report task based on the MST time zone, the timestamp would be input as follows (MST = UTC - 7 hours):

2021-03-15T13:00:00-07:00

1.8.0

The following changes have been made in this release.

In this release, the error message text for error code 35077 has been modified, and the new error code 35078 has been added. A new status for the CampaignStatusEnum enumerated values, SYSTEM_PAUSED, has also been added.

Error message updates

Error Code	Description
35077	To use Promoted Listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity.
35078	To gain access to Promoted Listings, you must be in good standing with recent sales activity.

The previous error code 35077 required that sellers had to own an eBay store to use Promoted Listings. The new error message removes that requirement.

New CampaignStatusEnum value

A new enumerated value and description have been added to CampaignStatusEnum. The new value is SYSTEM_PAUSED. This status indicates a system-generated, temporary pause on the campaign due to the seller's level dropping to Below Standard. Below Standard sellers cannot create new campaigns or edit their existing campaigns, but they can still view their campaign data and download reports. Once their seller level improves to Above Standard or Top Rated, sellers can resume using Promoted Listings and their campaigns will be automatically unpaused and return their last status.

1.7.0

The following changes have been made in this release.

This release increases the maximum amount of listings per campaign and adds Promoted Listings support for new eBay marketplaces.

Changed functionality

This release includes the following Promoted Listings functionality changes:

• The maximum amount of listings per campaign has increased from 25,000 to 50,000.
• The Promoted Listings methods are now supported for the following eBay marketplaces:
  • Canada (English)
  • Canada (French)
  • France
  • Italy
  • Spain

The table below lists the links to terms and conditions for all marketplaces that support Promoted Listings:

Marketplace	Promoted Listings Terms and Conditions URL
Australia	https://scgi.ebay.com.au/ws/ebayisapi.dll?useragreementv2&agrid=17
Canada (English)	https://scgi.ebay.ca/ws/ebayisapi.dll?useragreementv2&agrid=17
Canada (French)	https://scgi.cafr.ebay.ca/ws/ebayisapi.dll?useragreementv2&agrid=17
France	https://scgi.ebay.fr/ws/ebayisapi.dll?useragreementv2&agrid=17
Germany	https://scgi.ebay.de/ws/ebayisapi.dll?useragreementv2&agrid=17
Italy	https://scgi.ebay.it/ws/ebayisapi.dll?useragreementv2&agrid=17
Spain	https://scgi.ebay.es/ws/ebayisapi.dll?useragreementv2&agrid=17
United Kingdom	https://scgi.ebay.co.uk/ws/eBayISAPI.dll?useragreementv2&agrid=17
United States	https://scgi.ebay.com/ws/eBayISAPI.dll?useragreementv2&agrid=17&guest=1

1.6.0

The following changes have been made in this release.

This release standardizes the start and end times used for Promoted Listings reports.

Changed functionality

This release synchronizes Promoted Listings report start and end times with Mountain Standard Time (MST).

Promoted Listings reports are aggregated on a daily basis where each reporting day begins at midnight. With this release, the start time and end time for all Promoted Listing reports is synchronized with MST, which is calculated by subtracting seven hours from the Coordinated Universal Time (UTC). In other way, all Promoted Listings reports start and end at midnight, on the specified dates, based on Mountain Standard Time.

1.5.0

The following changes have been made in this release.

1.4.0

The following changes have been made in this release.

New methods

A new resource (item_price_markdown) and several methods have been added to the Marketing API. Item price markdown promotions are available in all eBay marketplaces.

Here is the list of the methods that were added to support item price markdown promotions:

• createItemPriceMarkdownPromotion = POST /item_price_markdown

  Creates a markdown promotion.

• deleteItemPriceMarkdownPromotion = DELETE /item_price_markdown/{promotion_id}

  Deletes a markdown promotion by ID.

• getItemPriceMarkdownPromotion = GET /item_price_markdown/{promotion_id}

  Retrieves a markdown promotion by ID.

• updateItemPriceMarkdownPromotion = PUT /item_price_markdown/{promotion_id}

  Updates a markdown promotion by ID.

Schema changes

There is a single schema change to support the new item price markdown promotions:

• A new query parameter, status, has been added to getListingSet to filter the promotions returned by their status. This parameter is valid for only markdown promotions.

Changed functionality

The Marketing API v1.4.0 release includes the following functionality changes:

• In Promoted Listings, the maximum value that you can specify for bidPercentage was raised from 20% to 100%.
• In Promotions Manager, the maximum number of inventory items or listing IDs that you can include in a promotion has been increased from 500 items to 2,000 items. These increases are reflected in the inventoryItems and listingIds fields in the inventoryCriterion container.

Documentation changes and errata

This version of the API documentation formally introduces Promotions Manager as a product, and identifies two flavors of promotions: markdown promotions and threshold promotions. In previous versions of the documentation, Promotions Manager had only a single set of functions, all of which supported threshold promotions with the item_promotion resource.

Version 1.4.0 introduces "item price markdown promotions" and these, along with threshold promotions, are grouped under the Promotions Manager umbrella.

1.2.0

The following changes have been made in this release.

New methods

The following report-related methods have been added to Promoted Listings:

• getReport = GET /ad_report/{report_id}

  Downloads a Promoted Listings report by ID.

• getReportMetadata = GET /ad_report_metadata

  Retrieves metadata that details the fields returned in all Promoted Listings reports.

• getReportMetadataForReportType = GET /ad_report_metadata/{report_type}

  Retrieves metadata that details the fields returned in a specific Promoted Listings report.

• createReportTask = POST /ad_report_task

  Creates a report task, which generates a Promoted Listings report.

• deleteReportTask = DELETE /ad_report_task/{report_task_id}

  Deletes a Promoted Listings report task and any associated reports by ID.

• getReportTask = GET /ad_report_task/{report_task_id}

  Retrieves the details on a Promoted Listings report task by ID.

• getReportTasks = GET /ad_report_task

  Retrieves a detailed list of the seller's report tasks. You can filter and paginate the result set.

1.1.0

The following changes have been made in this release.

New methods

This release added one new method:

• getListingSet = GET /promotion/{promotion_id}/get_listing_set

  This method returns a paginated result set of the listings associated with the specified promotion that was created with Promotions Manager.

Schema changes

The following changes were made to the schema:

Added new inventoryCriterion.ruleCriteria container

The inventoryCriterion.ruleCriteria container was added to the createItemPromotion, getItemPromotion, and updateItemPromotion calls. This enables sellers to select the listings to include in the promotions created with Promotions Manager by using a set of rules such as a list of eBay or seller's Store category IDs, items constrained by minimum and maximum prices, and the item brand or condition. You can explicitly exclude up to 100 eBay listing IDs or seller inventory reference IDs (also known as an SKU or custom label). Also, a single promotion can have multiple rules.

Documentation changes and errata

More examples were added to the Configuring discounts for threshold promotions topic.

1.0.0

The following changes have been made in this release.

This is the initial release of the Marketing API, Version 1.