marketing APIv1.10.0

getItemPromotion

GET
/item_promotion/{promotion_id}
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.

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/item_promotion/{promotion_id}

URI parameters

ParameterTypeDescription
promotion_idstringThis path parameter takes a concatenation of the ID of the promotion you want to retrieve plus the marketplace ID on which the promotion is hosted. Concatenate the two values by separating them with an "at sign" (@).

The ID of the promotion (promotionId) is a unique eBay-assigned value that's generated when the promotion is created. The Marketplace ID is the ENUM value of eBay marketplace where the promotion is hosted.

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.

OAuth scope

This request requires an access token created with the authorization code 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.readonly

https://api.ebay.com/oauth/api_scope/sell.marketing

See OAuth access tokens for more information.

Output

HTTP response headers

{ /* ItemPromotionResponse */
"name" : "string",
}
Output container/fieldTypeDescription
applyDiscountToSingleItemOnlybooleanIf 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.

Occurrence: Conditional

budgetAmountThis sets the budget for the CODED_COUPON promotion type. Supported values range from 100-1000000. Supported currency codes include USD, GBP, EUR, and AUD.

Note: The budget value for an active or paused promotion can not be decreased.

Note: The Currency Code for 'budget' must be the same as the Currency Code for 'maxDiscountAmount'.

Occurrence: Conditional

budget.currencyCurrencyCodeEnumThe 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: Conditional

budget.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

couponConfigurationCouponConfigurationThe configuration of a coded coupon promotion.

Occurrence: Conditional

couponConfiguration.couponCodestringA 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.

Occurrence: Conditional

couponConfiguration.couponTypeCouponTypeEnumThis indicates the type of Coded Coupon promotion, and is required when the promotion type is CODED_COUPON.

Supported types:
  • 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.

Occurrence: Conditional

couponConfiguration.maxCouponRedemptionPerUserintegerThis 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.

Occurrence: Conditional

descriptionstringRequired for CODED_COUPON promotions, 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 under the offer tile that is shown on the seller's All Offers page and on the event page for the promotion. This tag line is not used with volume pricing promotions.

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, "Extra 20% off when you buy 3+".


Maximum length: 50

Occurrence: Conditional

discountRulesarray of DiscountRuleA list containing the promotion benefits (discountRule) and the rules that define when the benefit is applied (discountSpecification).

Occurrence: Always

discountRules.discountBenefitDiscountBenefitThis container defines the promotional discount as either a monetary amount or a percentage of the sales price.

Note: When configuring promotion benefits, populate just one of the following fields in the discountBenefit container:

  • amountOffItem
  • amountOffOrder
  • percentageOffItem
  • percentageOffOrder

For volume pricing, only percentageOffOrder is applicable as a discountBenefit. Also, the first discountBenefit container in a volume pricing configuration must set percentageOffOrder to 0.

Tip: Refer to Configuring discounts for threshold promotions for information and examples on how to combine discountBenefit and discountSpecification to create different types of promotions.

Occurrence: Always

discountRules.discountBenefit.amountOffItemAmountThe 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: Conditional

discountRules.discountBenefit.amountOffItem.currencyCurrencyCodeEnumThe 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: Conditional

discountRules.discountBenefit.amountOffItem.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

discountRules.discountBenefit.amountOffOrderAmountUsed 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: Conditional

discountRules.discountBenefit.amountOffOrder.currencyCurrencyCodeEnumThe 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: Conditional

discountRules.discountBenefit.amountOffOrder.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

discountRules.discountBenefit.percentageOffItemstringThe 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

Occurrence: Conditional

discountRules.discountBenefit.percentageOffOrderstringUsed 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.

Occurrence: Conditional

discountRules.discountSpecificationDiscountSpecificationThis container defines the criteria for when the discounts of a promotion trigger, such as the minimum quantity that the buyer must purchase before the promotion kicks in. The promotional discount is applied each time the criteria defined by this container is met.

When configuring the rules that govern when the discounts are applied, populate just one of the following fields in the discountSpecification container:

  • minAmount
  • minQuantity
  • forEachQuantity
  • 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.

Occurrence: Always

discountRules.discountSpecification.forEachAmountAmountThe 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: Conditional

discountRules.discountSpecification.forEachAmount.currencyCurrencyCodeEnumThe 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: Conditional

discountRules.discountSpecification.forEachAmount.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

discountRules.discountSpecification.forEachQuantityintegerThe 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

Occurrence: Conditional

discountRules.discountSpecification.minAmountAmountKnown as the "threshold amount", the minimum dollar amount that needs to be spent on promoted items in order to qualify for the promotion's discount.

Valid values for the associated minAmount.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: Conditional

discountRules.discountSpecification.minAmount.currencyCurrencyCodeEnumThe 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: Conditional

discountRules.discountSpecification.minAmount.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

discountRules.discountSpecification.minQuantityintegerThe 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: Conditional

discountRules.discountSpecification.numberOfDiscountedItemsintegerUse 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: Conditional

discountRules.maxDiscountAmountAmountThe limit on how much a buyer can save using a CODED_COUPON promotion type. Permitted values are 1-1000. Supported currency codes include USD, GBP, EUR, and AUD.

Note: The Currency Code for 'maxDiscountAmount' must be the same as the Currency Code for 'budget'.

Occurrence: Always

discountRules.maxDiscountAmount.currencyCurrencyCodeEnumThe 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: Conditional

discountRules.maxDiscountAmount.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

discountRules.ruleOrderintegerThis field indicates the order in which the discountRules are presented. The value specified for this field must equal the associated minQuantity value.

Required if you are creating a volume pricing promotion.

Occurrence: Conditional

endDatestringThe 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.

Occurrence: Always

inventoryCriterionInventoryCriterionReturns either an array of listing IDs or the selection rules used to specify the items included in the promotion. Listing IDs can be either eBay listing IDs or an array of 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.

Occurrence: Always

inventoryCriterion.inventoryCriterionTypeInventoryCriterionEnumIndicates how the items to include in the promotion are selected. You can include inventory by ID, using rules, or globally include all your inventory.

Occurrence: Always

inventoryCriterion.inventoryItemsarray of InventoryItemAn 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.

Occurrence: Conditional

inventoryCriterion.inventoryItems.inventoryReferenceIdstringThe 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.

Occurrence: Conditional

inventoryCriterion.inventoryItems.inventoryReferenceTypeInventoryReferenceTypeEnumIndicates the type of the inventoryReferenceId, which can be either an individual item or a multi-SKU item (INVENTORY_ITEM and INVENTORY_ITEM_GROUP, respectively).

Note: This value is not currently returned in the response.

Occurrence: Conditional

inventoryCriterion.listingIdsarray of stringAn 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.

Occurrence: Conditional

inventoryCriterion.ruleCriteriaRuleCriteriaThis container defines a set of inventory selection rules for a promotion.

When defining rule criteria, you must limit item exclusions to 100 IDs when you choose from live inventory.

Required if InventoryCriterionEnum is set to INVENTORY_BY_RULE or INVENTORY_ANY.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.excludeInventoryItemsarray of InventoryItemA 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 items
Maximum SKU or custom label length: 50 characters

Occurrence: Conditional

inventoryCriterion.ruleCriteria.excludeInventoryItems.inventoryReferenceIdstringThe 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.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.excludeInventoryItems.inventoryReferenceTypeInventoryReferenceTypeEnumIndicates the type of the inventoryReferenceId, which can be either an individual item or a multi-SKU item (INVENTORY_ITEM and INVENTORY_ITEM_GROUP, respectively).

Note: This value is not currently returned in the response.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.excludeListingIdsarray of stringA 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

Occurrence: Conditional

inventoryCriterion.ruleCriteria.markupInventoryItemsarray of InventoryItemA 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.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.markupInventoryItems.inventoryReferenceIdstringThe 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.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.markupInventoryItems.inventoryReferenceTypeInventoryReferenceTypeEnumIndicates the type of the inventoryReferenceId, which can be either an individual item or a multi-SKU item (INVENTORY_ITEM and INVENTORY_ITEM_GROUP, respectively).

Note: This value is not currently returned in the response.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.markupListingIdsarray of stringA 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.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRulesarray of SelectionRuleThe container for the rules that select the items to include in a promotion.

Required if inventoryCriterionType is set to INVENTORY_BY_RULE.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRules.brandsarray of stringThe list of brands in the seller's inventory to include in the promotion.

This field is applicable only when categoryScope is set to MARKETPLACE.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRules.categoryIdsarray of stringEach 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.

Marketplace (eBay) category IDs
While we do not publish a list of eBay category IDs, you can retrieve the list of IDs as follows:
  • Get the category ID from the marketplace site:
    1. Use the Taxonomy API to retrieve a list of category IDs for any marketplace.
    2. For any marketplace, add /sch/allcategories/all-categories to the URL of the marketplace and navigate to that page.
      For example: http://www.ebay.com.au/sch/allcategories/all-categories
    3. Navigate to the category that you want and copy the ID from the URL.
  • For the US: See Category Changes for the latest list of category IDs.
Store category IDs
Store category IDs are unique to each seller, so the service cannot provide a list of them. To retrieve a list of seller Store category IDs:
  1. Go to Seller Hub > Marketing.
  2. Click Manage store categories.
    You will see a list of your store categories.
  3. At the bottom of the list, click All Categories.
    A complete list of your Store categories and their associated Store category IDs displays.
Note: You must always specify both categoryIds and categoryScope fields in each selectionRules container. If you specify multiple selectionRules containers, the categoryScope in each must match (they must all be either MARKETPLACE or STORE).

Required if inventoryCriterionType is set to INVENTORY_BY_RULE.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRules.categoryScopeCategoryScopeEnumThe 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.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRules.listingConditionIdsarray of stringA list of IDs that describe the condition of the items included in the promotion. For more information, see Item condition ID and name values.

Note: As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the Cell Phones & Smartphones category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030).

Note: In all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified - Refurbished', and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature.

Note: This value is not currently returned in the response.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRules.maxPriceAmountThis 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.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRules.maxPrice.currencyCurrencyCodeEnumThe 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: Conditional

inventoryCriterion.ruleCriteria.selectionRules.maxPrice.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRules.minPriceAmountThis 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.

Occurrence: Conditional

inventoryCriterion.ruleCriteria.selectionRules.minPrice.currencyCurrencyCodeEnumThe 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: Conditional

inventoryCriterion.ruleCriteria.selectionRules.minPrice.valuestringThe monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

marketplaceIdMarketplaceIdEnumThe eBay marketplace ID of the site where the threshold promotion is hosted. Threshold promotions are currently supported on a limited number of eBay marketplaces.

Valid values:

  • EBAY_AU = Australia
  • EBAY_DE = Germany
  • EBAY_ES = Spain
  • EBAY_FR = France
  • EBAY_GB = Great Britain
  • EBAY_IT = Italy
  • EBAY_US = United States

Occurrence: Always

namestringThe 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.

Maximum length: 90

Occurrence: Always

priorityPromotionPriorityEnumApplicable for only ORDER_DISCOUNT promotions, this field indicates the precedence of the promotion, which eBay uses to determine the position of a promotion on the seller's All Offers page. If an item is associated with multiple promotions, the promotion with the higher priority takes precedence.

Occurrence: Conditional

promotionIdstringA unique eBay-assigned ID for the promotion that's generated when the promotion is created.

Occurrence: Always

promotionImageUrlstringRequired for CODED_COUPON and MARKDOWN_SALE promotions, optional for ORDER_DISCOUNT promotions, and not applicable for VOLUME_DISCOUNT promotions, this field is a URL that points to an image for 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.

Occurrence: Conditional

promotionStatusPromotionStatusEnumThe current status of the promotion. When creating a new promotion, this value must be set to either DRAFT or SCHEDULED.

Occurrence: Always

promotionTypePromotionTypeEnumIndicates the type of the promotion, either CODED_COUPON, MARKDOWN_SALE, ORDER_DISCOUNT, or VOLUME_DISCOUNT.

Occurrence: Conditional

startDatestringThe 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.

Occurrence: Always

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.

StatusMeaning
200Success
400Bad Request
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
38201API_MARKETINGAPPLICATIONInternal server error encountered. If this problem persists, contact the eBay Developers Program for support.
38203API_MARKETINGREQUESTResource not found. Check the ID and try the call again.
38204API_MARKETINGREQUESTThe 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.
345076API_MARKETINGREQUESTYou cannot get the details of a promotion that was not created through the API.

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 promotion

This sample returns the details for the specified promotion.

Input

Specify the markdown promotion 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.
GET
https://api.ebay.com/sell/marketing/v1/item_promotion/1********5@EBAY_US

Output

The output is the complete details of the item promotion.