PUT /item_price_markdown/{promotion_id}
This method updates the specified item price markdown promotion with the new configuration that you supply in the payload of the request. Specify the promotion you want to update using the promotion_id path parameter. Call getPromotions to retrieve the IDs of a seller's promotions.
When updating a promotion, supply all the fields that you used to configure the original promotion (and not just the fields you are updating). eBay replaces the specified promotion with the values you supply in the update request and if you don't pass a field that currently has a value, the update request fails.
The parameters you are allowed to update with this request depend on the status of the promotion you're updating:
- DRAFT or SCHEDULED promotions: You can update any of the parameters in these promotions that have not yet started to run, including the discountRules.
- RUNNING promotions: You can change the endDate and the item's inventory but you cannot change the promotional discount or the promotion's start date.
- ENDED promotions: Nothing can be changed.
Servers
- https://api.ebay.com{basePath}
Path parameters
Name | Type | Required | Description |
---|---|---|---|
promotion_id |
String | Yes |
This path parameter takes a concatenation of the ID of the promotion you want to update plus the marketplace ID on which the promotion is hosted. Concatenate the two values by separating them with an "at sign" (@). |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
promotionStatus |
String | No |
The current status of the promotion. When creating a new promotion, you must set this value to either |
autoSelectFutureInventory |
Boolean | No |
If set to |
priority |
String | No |
This field is ignored in markdown promotions. For implementation help, refer to eBay API documentation |
endDate |
String | No |
The date and time the promotion ends, in UTC format (
|
name |
String | No |
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. |
description |
String | No |
This field is required if you are configuring an MARKDOWN_SALE 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". Maximum length: 50 |
selectedInventoryDiscounts[] |
Array | No |
A list that defines the sets of selected items for the markdown promotion and the discount specified for promotion. |
selectedInventoryDiscounts[].discountId |
String | No |
A unique, eBay-generated ID that you can use to identify the discount. This field is ignored in POST and PUT operations. |
selectedInventoryDiscounts[].discountBenefit |
Object | No |
This container defines the promotional discount as either a monetary amount or a percentage of the sales price. Important!: You must populate one and only one of the fields in this container:
Tip: Refer to Configuring discounts for threshold promotions for information and examples on how to combine discountBenefit and discountSpecification values to create different types of promotions. |
selectedInventoryDiscounts[].discountBenefit.percentageOffItem |
String | No |
The percentage applied to the sales price that is discounted off the promoted item (or items) when the promotion criteria is met. |
selectedInventoryDiscounts[].discountBenefit.amountOffItem |
Object | No |
A complex type that describes the value of a monetary amount as represented by a global currency. |
selectedInventoryDiscounts[].discountBenefit.amountOffItem.value |
String | No |
The monetary amount in the specified currency. |
selectedInventoryDiscounts[].discountBenefit.amountOffItem.currency |
String | No |
The base currency applied to the value field to establish a monetary amount. |
selectedInventoryDiscounts[].discountBenefit.percentageOffOrder |
String | No |
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. |
selectedInventoryDiscounts[].discountBenefit.amountOffOrder |
Object | No |
A complex type that describes the value of a monetary amount as represented by a global currency. |
selectedInventoryDiscounts[].discountBenefit.amountOffOrder.value |
String | No |
The monetary amount in the specified currency. |
selectedInventoryDiscounts[].discountBenefit.amountOffOrder.currency |
String | No |
The base currency applied to the value field to establish a monetary amount. |
selectedInventoryDiscounts[].ruleOrder |
Integer | No |
For markdown promotions, this field is reserved for future use. |
selectedInventoryDiscounts[].inventoryCriterion |
Object | No |
This type defines either the selections rules or the list of listing IDs for the promotion. The "listing IDs" are are either the seller's item IDs or the eBay listing IDs. |
selectedInventoryDiscounts[].inventoryCriterion.inventoryCriterionType |
String | No |
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. For implementation help, refer to eBay API documentation |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria |
Object | No |
This type defines the fields for a set of inventory selection rules. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.excludeListingIds[] |
Array | No |
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 itemsMaximum SKU or custom label length: 50 characters |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[] |
Array | No |
The container for the rules that select the items to include in a promotion. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].maxPrice |
Object | No |
A complex type that describes the value of a monetary amount as represented by a global currency. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].maxPrice.value |
String | No |
The monetary amount in the specified currency. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].maxPrice.currency |
String | No |
The base currency applied to the value field to establish a monetary amount. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].categoryIds[] |
Array | No |
A list of category IDs associated with the listings to be included in the campaign. Ads are created for all the seller's items listed in the specified categories, up to a maximum of 50,000 items. The IDs can be either a list of eBay category IDs (from the site where the item is hosted), or a list of category IDs defined and used by the seller's store. eBay Marketplace category IDs
Seller store category IDs
|
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].categoryScope |
String | No |
The enumeration values returned in this field indicate if the category IDs in the corresponding categoryIds array are identifiers for eBay categories or for a seller's eBay store categories. This field is always returned if one or more category IDs are used as a filter. For implementation help, refer to eBay API documentation |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].listingConditionIds[] |
Array | No |
A comma-separated list of unique identifiers for the conditions of listings to be included in the campaign. Up to four IDs can be specified.
|
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].minPrice |
Object | No |
A complex type that describes the value of a monetary amount as represented by a global currency. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].minPrice.value |
String | No |
The monetary amount in the specified currency. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].minPrice.currency |
String | No |
The base currency applied to the value field to establish a monetary amount. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.selectionRules[].brands[] |
Array | No |
An array of product brands used as an inclusion filter. A product's brand is defined in a listing's item specifics. This array will be returned if one or more product brands were used as a filter. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.markupListingIds[] |
Array | No |
A list of listing IDs to remove from a markdown promotion. The listed items are 'marked up' to their standard price after being part of the markdown promotion. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.excludeInventoryItems[] |
Array | No |
A list of seller inventory reference IDs to exclude from the promotion. Note: The request can have either excludeInventoryItems or excludeListingIds but not both. Maximum: 100 parent itemsMaximum SKU or custom label length: 50 characters |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.excludeInventoryItems[].inventoryReferenceId |
String | No |
The seller's inventory reference ID for a listing. Also known as the "SKU" or "custom label," an inventory reference ID is either the ID of the listing or, if the listing has variations (such as a shirt that's available in multiple sizes and colors), the ID of the parent listing. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.markupInventoryItems[] |
Array | No |
A list of SKUs to remove from a markdown promotion. The listed SKUs are 'marked up' to their standard price after being part of the markdown promotion. |
selectedInventoryDiscounts[].inventoryCriterion.ruleCriteria.markupInventoryItems[].inventoryReferenceId |
String | No |
The seller's inventory reference ID for a listing. Also known as the "SKU" or "custom label," an inventory reference ID is either the ID of the listing or, if the listing has variations (such as a shirt that's available in multiple sizes and colors), the ID of the parent listing. |
selectedInventoryDiscounts[].inventoryCriterion.inventoryItems[] |
Array | No |
An array of containers for the seller's inventory reference IDs (also known as an "SKU" or "custom label") 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.
|
selectedInventoryDiscounts[].inventoryCriterion.inventoryItems[].inventoryReferenceId |
String | No |
The seller's inventory reference ID for a listing. Also known as the "SKU" or "custom label," an inventory reference ID is either the ID of the listing or, if the listing has variations (such as a shirt that's available in multiple sizes and colors), the ID of the parent listing. |
selectedInventoryDiscounts[].inventoryCriterion.listingIds[] |
Array | No |
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.
|
applyFreeShipping |
Boolean | No |
If set to |
startDate |
String | No |
The date and time the promotion starts in UTC format ( |
blockPriceIncreaseInItemRevision |
Boolean | No |
If set to |
marketplaceId |
String | No |
The eBay marketplace ID of the site where the markdown promotion is hosted. Markdown promotions are supported on all eBay marketplaces. For implementation help, refer to eBay API documentation |
promotionImageUrl |
String | No |
Required for CODED_COUPON, MARKDOWN_SALE, and 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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.