GET/item_price_markdown/{promotion_id}
Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made.
This method returns the complete details of the item price markdown discounnt that's indicated by the promotion_id path parameter.
Call getPromotions to retrieve the IDs of a seller's discounts.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
URI parameters
Parameter | Type | Description |
---|---|---|
promotion_id | string | This path parameter takes a concatenation of the ID of the discount you want to retrieve plus the marketplace ID on which the discount is hosted. Concatenate the two values by separating them with an "at sign" (@). The ID of the discount (promotionId) is a unique eBay-assigned value that's generated when the discount is created. The Marketplace ID is the ENUM value of eBay marketplace where the discoun is hosted. Use the getPromotions method to retrieve promotion Ids. See MarketplaceIdEnum for supported Marketplace ID values. Example: 1********5@EBAY_US Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.marketing
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
applyFreeShipping | boolean | If set to Occurrence: Conditional |
autoSelectFutureInventory | boolean | If set to Occurrence: Conditional |
blockPriceIncreaseInItemRevision | boolean | If set to Occurrence: Conditional |
description | string | This field is required if you are configuring an MARKDOWN_SALE discount. 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 Occurrence: Conditional |
endDate | string | The date and time the discount ends, in UTC format (
Occurrence: Conditional |
marketplaceId | MarketplaceIdEnum | The eBay marketplace ID of the site where the markdown discount is hosted. Markdown discounts are supported on all eBay marketplaces. Occurrence: Always |
name | string | The seller-defined name or 'title' of the discount that the seller can use to identify a discount. This label is not displayed in end-user flows. Occurrence: Conditional |
priority | PromotionPriorityEnum | This field is ignored in markdown discounts. Occurrence: Conditional |
promotionImageUrl | string | Required for CODED_COUPON, MARKDOWN_SALE, and ORDER_DISCOUNT discounts, populate this field with a URL that points to an image to be used with the discount. 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. Occurrence: Conditional |
promotionStatus | PromotionStatusEnum | The current status of the discount. When creating a new discount, you must set this value to either Occurrence: Always |
selectedInventoryDiscounts | array of SelectedInventoryDiscount | A list that defines the sets of selected items for the markdown discount. Occurrence: Conditional |
selectedInventoryDiscounts.discountBenefit | DiscountBenefit | This container defines the discount as either a monetary amount or a percentage applied to the sales price. Occurrence: Always |
selectedInventoryDiscounts.discountBenefit.amountOffItem | Amount | The monetary amount that is discounted off an item (or items) when the discount criteria is met.
Occurrence: Conditional |
selectedInventoryDiscounts.discountBenefit.amountOffItem.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
selectedInventoryDiscounts.discountBenefit.amountOffItem.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
selectedInventoryDiscounts.discountBenefit.amountOffOrder | Amount | Used for threshold discounts, this is the monetary amount that is discounted off an order when the discount criteria is met. Because this field is valid only for orders, it's not a valid combination to use with markdown discounts. Occurrence: Conditional |
selectedInventoryDiscounts.discountBenefit.amountOffOrder.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
selectedInventoryDiscounts.discountBenefit.amountOffOrder.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
selectedInventoryDiscounts.discountBenefit.percentageOffItem | string | The percentage applied to the sales price that is discounted off the discounted item (or items) when the discount criteria is met. Occurrence: Conditional |
selectedInventoryDiscounts.discountBenefit.percentageOffOrder | string | Used for threshold discounts, this is the percentage of the order price that is discounted off the order when the discount criteria is met. This field is not value for markdown discounts. Occurrence: Conditional |
selectedInventoryDiscounts.discountId | string | A unique, eBay-generated ID that you can use to identify the discount. This field is ignored in POST and PUT operations. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion | InventoryCriterion | A container that defines either the listing IDs or the selection rules that specify the items to include in the discount. Listing IDs can be either eBay listing IDs or a list of the seller's inventory reference IDs (know as SKUs or custom labels). See the selectionRules container for the rule criteria you can use to select inventory. Note: All listings in Discounts Manager discounts must support an electronic payment method. Occurrence: Always |
selectedInventoryDiscounts.inventoryCriterion.inventoryCriterionType | InventoryCriterionEnum | Indicates how the items to be discounted are selected. You can include inventory by ID, using rules, or globally include all your inventory. Occurrence: Always |
selectedInventoryDiscounts.inventoryCriterion.inventoryItems | array of InventoryItem | An array of containers for the seller's inventory reference IDs (also known as an "SKU" or "custom label") to be added to the discount. Note: The request can have either inventoryItems or listingIds, but not both. 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. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.inventoryItems.inventoryReferenceId | string | The unique identifier of a single-item listing or a multi-variation listing. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.inventoryItems.inventoryReferenceType | InventoryReferenceTypeEnum | Indicates the type of the inventoryReferenceId, which can be either Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.listingIds | array of string | An array of eBay listing IDs to be discounted. Note: The request can have either inventoryItems or listingIds, but not both. Required: All listings being discounted 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. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria | RuleCriteria | This container defines a set of inventory selection rules for a discount. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.excludeInventoryItems | array of InventoryItem | A list of seller inventory reference IDs to exclude from the discount. Note: The request can have either excludeInventoryItems or excludeListingIds but not both. Maximum: 100 parent itemsMaximum SKU or custom label length: 50 characters Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.excludeInventoryItems.inventoryReferenceId | string | The unique identifier of a single-item listing or a multi-variation listing. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.excludeInventoryItems.inventoryReferenceType | InventoryReferenceTypeEnum | Indicates the type of the inventoryReferenceId, which can be either Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.excludeListingIds | array of string | A list of eBay listing IDs to exclude from the discount. Note: The request can have either excludeInventoryItems or excludeListingIds but not both. Maximum: 100 parent itemsMaximum SKU or custom label length: 50 characters Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.markupInventoryItems | array of InventoryItem | A list of SKUs to remove from a markdown discount. The listed SKUs are 'marked up' to their standard price after being part of the markdown discount. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.markupInventoryItems.inventoryReferenceId | string | The unique identifier of a single-item listing or a multi-variation listing. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.markupInventoryItems.inventoryReferenceType | InventoryReferenceTypeEnum | Indicates the type of the inventoryReferenceId, which can be either Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.markupListingIds | array of string | A list of listing IDs to remove from a markdown discount. The listed items are 'marked up' to their standard price after being part of the markdown discount. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules | array of SelectionRule | The container for the rules that select the items to be discounted. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.brands | array of string | An array of product brands. For more details, see Using the selectionRules container. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.categoryIds | array of string | This field contains an array of the associated category ID(s). Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.categoryScope | CategoryScopeEnum | This enumerated value indicates if the category ID for the item is an identifier for eBay categories or for a seller's eBay store categories. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.listingConditionIds | array of string | A comma-separated list of unique identifiers for the conditions of listings to be included Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.maxPrice | Amount | This container sets the maximum price threshold. For more details, see Using the selectionRules container. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.maxPrice.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.maxPrice.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.minPrice | Amount | This container sets the minimum price threshold. For more details, see Using the selectionRules container. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.minPrice.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
selectedInventoryDiscounts.inventoryCriterion.ruleCriteria.selectionRules.minPrice.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
selectedInventoryDiscounts.ruleOrder | integer | For markdown discounts, this field is reserved for future use. Occurrence: Conditional |
startDate | string | The date and time the discount starts in UTC format ( Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
Status | Meaning |
---|---|
200 | Success |
400 | Bad Request |
404 | Not Found |
500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
38201 | API_MARKETING | APPLICATION | Internal server error encountered. If this problem persists, contact the eBay Developers Program for support. |
38203 | API_MARKETING | REQUEST | Resource not found. Check the ID and try the call again. |
38204 | API_MARKETING | REQUEST | The seller is not eligible for promotions because they do not have an eBay Store or they have not accepted the terms and conditions for creating a promotion on this Marketplace, see the documentation for this call. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Gets a specific markdown discount
This sample returns the details for the specified markdown discount.
Input
Specify the markdown discount you want to retrieve using the promotion ID concatenated with the marketplace ENUM as a URI query parameter. See the endpoint below for an example.
GEThttps://api.ebay.com/sell/marketing/v1/item_price_markdown/1********9@EBAY_US
Output
The output is the complete details of the markdown discount.