> For the complete documentation index, see [llms.txt](https://docs.2checkout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.2checkout.com/api-reference/reference/promotions.md). # Promotions ## GET /products/{ProductCode}/promotions/ > Retrieve all promotions set for a product ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/products/{ProductCode}/promotions/":{"get":{"tags":["Promotions"],"summary":"Retrieve all promotions set for a product","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"ProductCode","in":"path","description":"The editable code that you control at product-level, not the unique, system-generated product ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{}}}}}}}} ``` ## GET /products/{ProductCode}/promotions/{PromotionCode}/ > Retrieve a product's promotion ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/products/{ProductCode}/promotions/{PromotionCode}/":{"get":{"tags":["Promotions"],"summary":"Retrieve a product's promotion","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"ProductCode","in":"path","description":"The editable code that you control at product-level, not the unique, system-generated product ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"PromotionCode","in":"path","description":"Unique, system-generated identifier 2Checkout associates with promotion campaigns.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{}}}}}}}} ``` ## GET /promotions/ > Retrieve all active promotions ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/":{"get":{"tags":["Promotions"],"summary":"Retrieve all active promotions","parameters":[{"name":"Types","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["REGULAR","GLOBAL","RENEWAL","SPECIAL_PRICE","CUMULATIVE"]}},{"name":"Channel","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["ALL","CHANNEL_MANAGER","ECOMMERCE"]}},{"name":"Enabled","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"Coupons","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"ProductCode","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"Page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"}},{"name":"Limit","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"number"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPromotionsResponse"}}}}}}}},"components":{"schemas":{"GetPromotionsResponse":{"type":"object","properties":{"Items":{"$ref":"#/components/schemas/PromotionResponse"},"Pagination":{"$ref":"#/components/schemas/Pagination"}}},"PromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscount"},"Products":{"$ref":"#/components/schemas/PromotionProducts"},"PriceThreshold":{"$ref":"#/components/schemas/PromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}},"PromotionDiscount":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED / PERCENT)"},"Value":{"type":"number","description":"discount value"},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionProducts":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}},"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"description":"Pricing option codes that you control.","type":"array","items":{"type":"string"}}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}},"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer"},"Limit":{"type":"integer"},"Count":{"type":"integer"}}}}}} ``` ## POST /promotions/ > Add a new promotion ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/":{"post":{"tags":["Promotions"],"summary":"Add a new promotion","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/RegularPromotion"},{"$ref":"#/components/schemas/GlobalPromotion"},{"$ref":"#/components/schemas/SpecialPricePromotion"},{"$ref":"#/components/schemas/CumulativePromotion"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PromotionResponse"},{"$ref":"#/components/schemas/GlobalPromotionResponse"},{"$ref":"#/components/schemas/SpecialPricePromotionResponse"},{"$ref":"#/components/schemas/CumulativePromotionResponse"}]}}}}}}}},"components":{"schemas":{"RegularPromotion":{"type":"object","properties":{"ApplyRecurring":{"description":"Choose whether to apply the discount to renewal orders.","type":"string"},"ChannelType":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"description":"Promotion description","type":"string"},"Discount":{"$ref":"#/components/schemas/promotions_Discount"},"Enabled":{"description":"\"Possible values:","type":"boolean"},"EndDate":{"description":"Ending date. The date when you set the promotion to end. Is NULL for promotions that you want active indefinitely. Format: Y-m-d","type":"string"},"InstantDiscount":{"description":"Selecting the instant discount option will auto-apply the discount for ALL the selected products for all shoppers, without the need to enter the discount coupon.","type":"number"},"MaximumOrdersNumber":{"description":"2Checkout stops offering the discount when the promotion reaches the maximum number of orders. Can be NULL if you want the promotion to apply to an unlimited number of orders.","type":"number"},"MaximumQuantity":{"description":"Discount only applies to a specific number of products, smaller than the maximum quantity you defined. Can be NULL if you want the promotion to apply to an unlimited number of units. Any extra quantity added to the cart will be sold at full price.","type":"number"},"Name":{"description":"Promotion name","type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"PublishToAffiliatesNetwork":{"description":"• 1 - make promotion available in the Affiliates Network","type":"number"},"StartDate":{"description":"Starting date. The date when you set the promotion to start. Is NULL for promotions that start immediately after they're created. Format: Y-m-d","type":"string"},"Type":{"description":"\"Possible values:","type":"string"}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"description":"\"Varies according to type. Send:","type":"array","items":{"type":"string"}},"Type":{"description":"\"• SINGLE = one coupon code shared by all shoppers","type":"string"}}},"promotions_Discount":{"type":"object","properties":{"Type":{"description":"\"Discount type:","type":"string"},"Value":{"description":"• Value = Int, determines the discount percentage from 0 to 100","type":"number"}}},"promotions_Products":{"type":"object","properties":{"Code":{"description":"Code of the product that is used by promotion.","type":"string"}}},"GlobalPromotion":{"type":"object","properties":{"ApplyRecurring":{"description":"Choose whether to apply the discount to renewal orders.","type":"string"},"ChannelType":{"description":"\"Possible values:","type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"description":"Promotion description","type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscountFixed"},"PriceThreshold":{"$ref":"#/components/schemas/GlobalPromotionPriceThreshold"},"Enabled":{"description":"\"Possible values:","type":"boolean"},"EndDate":{"description":"Ending date. The date when you set the promotion to end. Is NULL for promotions that you want active indefinitely. Format: Y-m-d","type":"string"},"InstantDiscount":{"description":"Selecting the instant discount option will auto-apply the discount for ALL the selected products for all shoppers, without the need to enter the discount coupon.","type":"number"},"MaximumOrdersNumber":{"description":"2Checkout stops offering the discount when the promotion reaches the maximum number of orders. Can be NULL if you want the promotion to apply to an unlimited number of orders.","type":"number"},"MaximumQuantity":{"description":"Discount only applies to a specific number of products, smaller than the maximum quantity you defined. Can be NULL if you want the promotion to apply to an unlimited number of units. Any extra quantity added to the cart will be sold at full price.","type":"number"},"Name":{"description":"Promotion name","type":"string"},"PublishToAffiliatesNetwork":{"description":"• 1 - make promotion available in the Affiliates Network","type":"number"},"StartDate":{"description":"Starting date. The date when you set the promotion to start. Is NULL for promotions that start immediately after they're created. Format: Y-m-d","type":"string"},"Type":{"description":"\"Possible values:","type":"string"}}},"PromotionDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"description":"• Value = Int, determines the discount percentage from 0 to 100","type":"array","items":{"$ref":"#/components/schemas/PromotionDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"number","description":"price discount amount"}}},"GlobalPromotionPriceThreshold":{"type":"object","properties":{"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionPriceThreshold"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}},"SpecialPricePromotion":{"type":"object","properties":{"ApplyRecurring":{"description":"Choose whether to apply the discount to renewal orders.","type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"description":"Promotion description","type":"string"},"Enabled":{"description":"\"Possible values:","type":"boolean"},"EndDate":{"description":"Ending date. The date when you set the promotion to end. Is NULL for promotions that you want active indefinitely. Format: Y-m-d","type":"string"},"InstantDiscount":{"description":"Selecting the instant discount option will auto-apply the discount for ALL the selected products for all shoppers, without the need to enter the discount coupon.","type":"number"},"MaximumOrdersNumber":{"description":"2Checkout stops offering the discount when the promotion reaches the maximum number of orders. Can be NULL if you want the promotion to apply to an unlimited number of orders.","type":"number"},"MaximumQuantity":{"description":"Discount only applies to a specific number of products, smaller than the maximum quantity you defined. Can be NULL if you want the promotion to apply to an unlimited number of units. Any extra quantity added to the cart will be sold at full price.","type":"number"},"Name":{"description":"Promotion name","type":"string"},"StartDate":{"description":"Starting date. The date when you set the promotion to start. Is NULL for promotions that start immediately after they're created. Format: Y-m-d","type":"string"},"Type":{"description":"\"Possible values:","type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"description":"Required for SPECIAL_PRICE promotions, represents the default ISO currency of the promotion.","type":"string"},"PriceMatrix":{"description":"Only for this type of promotion; is generated by getPriceMatrix and is used to set promotion special prices.","type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"description":"Describes price configuration options identified by OptionHash.","type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"description":"Price option group name.","type":"string"},"OptionText":{"description":"Pricing option group description.","type":"string"}}}},"Prices":{"description":"Promotion prices by currency, price for default currency is required.","type":"array","items":{"type":"object","properties":{"Value":{"description":"The amount defined for each specific currency active for your account, when you use FIXED for Method.","type":"number"},"Currency":{"description":"Currency ISO code - ISO 4217.","type":"string"}}}}}},"CumulativePromotion":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Cumulative":{"type":"boolean"},"ProductTaxCategoryUUID":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"PromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscount"},"Products":{"$ref":"#/components/schemas/PromotionProducts"},"PriceThreshold":{"$ref":"#/components/schemas/PromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}},"PromotionDiscount":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED / PERCENT)"},"Value":{"type":"number","description":"discount value"},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionProducts":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}},"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"description":"Pricing option codes that you control.","type":"array","items":{"type":"string"}}}},"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}},"GlobalPromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscountFixed"},"PriceThreshold":{"$ref":"#/components/schemas/GlobalPromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"SpecialPricePromotionResponse":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"CumulativePromotionResponse":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Cumulative":{"type":"boolean"},"ProductTaxCategoryUUID":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}}}}} ``` ## GET /promotions/{PromotionCode}/ > Retrieve a promotion ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/":{"get":{"tags":["Promotions"],"summary":"Retrieve a promotion","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"PromotionCode","in":"path","description":"Unique, system-generated identifier 2Checkout associates with promotion campaigns.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PromotionResponse"},{"$ref":"#/components/schemas/GlobalPromotionResponse"},{"$ref":"#/components/schemas/SpecialPricePromotionResponse"},{"$ref":"#/components/schemas/CumulativePromotionResponse"}]}}}}}}}},"components":{"schemas":{"PromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscount"},"Products":{"$ref":"#/components/schemas/PromotionProducts"},"PriceThreshold":{"$ref":"#/components/schemas/PromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}},"PromotionDiscount":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED / PERCENT)"},"Value":{"type":"number","description":"discount value"},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionProducts":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}},"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"description":"Pricing option codes that you control.","type":"array","items":{"type":"string"}}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}},"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}},"GlobalPromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscountFixed"},"PriceThreshold":{"$ref":"#/components/schemas/GlobalPromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"PromotionDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"description":"• Value = Int, determines the discount percentage from 0 to 100","type":"array","items":{"$ref":"#/components/schemas/PromotionDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"number","description":"price discount amount"}}},"GlobalPromotionPriceThreshold":{"type":"object","properties":{"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionPriceThreshold"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"SpecialPricePromotionResponse":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"description":"\"Varies according to type. Send:","type":"array","items":{"type":"string"}},"Type":{"description":"\"• SINGLE = one coupon code shared by all shoppers","type":"string"}}},"promotions_Products":{"type":"object","properties":{"Code":{"description":"Code of the product that is used by promotion.","type":"string"}}},"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"description":"Describes price configuration options identified by OptionHash.","type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"description":"Price option group name.","type":"string"},"OptionText":{"description":"Pricing option group description.","type":"string"}}}},"Prices":{"description":"Promotion prices by currency, price for default currency is required.","type":"array","items":{"type":"object","properties":{"Value":{"description":"The amount defined for each specific currency active for your account, when you use FIXED for Method.","type":"number"},"Currency":{"description":"Currency ISO code - ISO 4217.","type":"string"}}}}}},"CumulativePromotionResponse":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Cumulative":{"type":"boolean"},"ProductTaxCategoryUUID":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}}}}} ``` ## PUT /promotions/{PromotionCode}/ > Update a promotion ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/":{"put":{"tags":["Promotions"],"summary":"Update a promotion","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"PromotionCode","in":"path","description":"Unique, system-generated identifier 2Checkout associates with promotion campaigns.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/RegularPromotion"},{"$ref":"#/components/schemas/GlobalPromotion"},{"$ref":"#/components/schemas/SpecialPricePromotion"},{"$ref":"#/components/schemas/CumulativePromotion"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PromotionResponse"},{"$ref":"#/components/schemas/GlobalPromotionResponse"},{"$ref":"#/components/schemas/SpecialPricePromotionResponse"},{"$ref":"#/components/schemas/CumulativePromotionResponse"}]}}}}}}}},"components":{"schemas":{"RegularPromotion":{"type":"object","properties":{"ApplyRecurring":{"description":"Choose whether to apply the discount to renewal orders.","type":"string"},"ChannelType":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"description":"Promotion description","type":"string"},"Discount":{"$ref":"#/components/schemas/promotions_Discount"},"Enabled":{"description":"\"Possible values:","type":"boolean"},"EndDate":{"description":"Ending date. The date when you set the promotion to end. Is NULL for promotions that you want active indefinitely. Format: Y-m-d","type":"string"},"InstantDiscount":{"description":"Selecting the instant discount option will auto-apply the discount for ALL the selected products for all shoppers, without the need to enter the discount coupon.","type":"number"},"MaximumOrdersNumber":{"description":"2Checkout stops offering the discount when the promotion reaches the maximum number of orders. Can be NULL if you want the promotion to apply to an unlimited number of orders.","type":"number"},"MaximumQuantity":{"description":"Discount only applies to a specific number of products, smaller than the maximum quantity you defined. Can be NULL if you want the promotion to apply to an unlimited number of units. Any extra quantity added to the cart will be sold at full price.","type":"number"},"Name":{"description":"Promotion name","type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"PublishToAffiliatesNetwork":{"description":"• 1 - make promotion available in the Affiliates Network","type":"number"},"StartDate":{"description":"Starting date. The date when you set the promotion to start. Is NULL for promotions that start immediately after they're created. Format: Y-m-d","type":"string"},"Type":{"description":"\"Possible values:","type":"string"}}},"promotions_Coupon":{"type":"object","properties":{"Codes":{"description":"\"Varies according to type. Send:","type":"array","items":{"type":"string"}},"Type":{"description":"\"• SINGLE = one coupon code shared by all shoppers","type":"string"}}},"promotions_Discount":{"type":"object","properties":{"Type":{"description":"\"Discount type:","type":"string"},"Value":{"description":"• Value = Int, determines the discount percentage from 0 to 100","type":"number"}}},"promotions_Products":{"type":"object","properties":{"Code":{"description":"Code of the product that is used by promotion.","type":"string"}}},"GlobalPromotion":{"type":"object","properties":{"ApplyRecurring":{"description":"Choose whether to apply the discount to renewal orders.","type":"string"},"ChannelType":{"description":"\"Possible values:","type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"description":"Promotion description","type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscountFixed"},"PriceThreshold":{"$ref":"#/components/schemas/GlobalPromotionPriceThreshold"},"Enabled":{"description":"\"Possible values:","type":"boolean"},"EndDate":{"description":"Ending date. The date when you set the promotion to end. Is NULL for promotions that you want active indefinitely. Format: Y-m-d","type":"string"},"InstantDiscount":{"description":"Selecting the instant discount option will auto-apply the discount for ALL the selected products for all shoppers, without the need to enter the discount coupon.","type":"number"},"MaximumOrdersNumber":{"description":"2Checkout stops offering the discount when the promotion reaches the maximum number of orders. Can be NULL if you want the promotion to apply to an unlimited number of orders.","type":"number"},"MaximumQuantity":{"description":"Discount only applies to a specific number of products, smaller than the maximum quantity you defined. Can be NULL if you want the promotion to apply to an unlimited number of units. Any extra quantity added to the cart will be sold at full price.","type":"number"},"Name":{"description":"Promotion name","type":"string"},"PublishToAffiliatesNetwork":{"description":"• 1 - make promotion available in the Affiliates Network","type":"number"},"StartDate":{"description":"Starting date. The date when you set the promotion to start. Is NULL for promotions that start immediately after they're created. Format: Y-m-d","type":"string"},"Type":{"description":"\"Possible values:","type":"string"}}},"PromotionDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"description":"• Value = Int, determines the discount percentage from 0 to 100","type":"array","items":{"$ref":"#/components/schemas/PromotionDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"number","description":"price discount amount"}}},"GlobalPromotionPriceThreshold":{"type":"object","properties":{"Values":{"type":"array","items":{"$ref":"#/components/schemas/PromotionPriceThreshold"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionPriceThreshold":{"type":"object","properties":{"Currency":{"type":"string","description":"price threshold currency"},"Amount":{"type":"number","description":"price threshold amount"}}},"SpecialPricePromotion":{"type":"object","properties":{"ApplyRecurring":{"description":"Choose whether to apply the discount to renewal orders.","type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"description":"Promotion description","type":"string"},"Enabled":{"description":"\"Possible values:","type":"boolean"},"EndDate":{"description":"Ending date. The date when you set the promotion to end. Is NULL for promotions that you want active indefinitely. Format: Y-m-d","type":"string"},"InstantDiscount":{"description":"Selecting the instant discount option will auto-apply the discount for ALL the selected products for all shoppers, without the need to enter the discount coupon.","type":"number"},"MaximumOrdersNumber":{"description":"2Checkout stops offering the discount when the promotion reaches the maximum number of orders. Can be NULL if you want the promotion to apply to an unlimited number of orders.","type":"number"},"MaximumQuantity":{"description":"Discount only applies to a specific number of products, smaller than the maximum quantity you defined. Can be NULL if you want the promotion to apply to an unlimited number of units. Any extra quantity added to the cart will be sold at full price.","type":"number"},"Name":{"description":"Promotion name","type":"string"},"StartDate":{"description":"Starting date. The date when you set the promotion to start. Is NULL for promotions that start immediately after they're created. Format: Y-m-d","type":"string"},"Type":{"description":"\"Possible values:","type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"description":"Required for SPECIAL_PRICE promotions, represents the default ISO currency of the promotion.","type":"string"},"PriceMatrix":{"description":"Only for this type of promotion; is generated by getPriceMatrix and is used to set promotion special prices.","type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"priceMatrixPrice":{"type":"object","properties":{"ProductCode":{"type":"string","description":"product code"},"PricingConfigurationCode":{"type":"string","description":"pricing configuration code"},"OptionHash":{"type":"string","description":"hash generated based on price options"},"Options":{"description":"Describes price configuration options identified by OptionHash.","type":"array","items":{"type":"object","description":"price options info","properties":{"GroupName":{"description":"Price option group name.","type":"string"},"OptionText":{"description":"Pricing option group description.","type":"string"}}}},"Prices":{"description":"Promotion prices by currency, price for default currency is required.","type":"array","items":{"type":"object","properties":{"Value":{"description":"The amount defined for each specific currency active for your account, when you use FIXED for Method.","type":"number"},"Currency":{"description":"Currency ISO code - ISO 4217.","type":"string"}}}}}},"CumulativePromotion":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Cumulative":{"type":"boolean"},"ProductTaxCategoryUUID":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"PromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscount"},"Products":{"$ref":"#/components/schemas/PromotionProducts"},"PriceThreshold":{"$ref":"#/components/schemas/PromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}},"PromotionDiscount":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED / PERCENT)"},"Value":{"type":"number","description":"discount value"},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionProducts":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}},"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"description":"Pricing option codes that you control.","type":"array","items":{"type":"string"}}}},"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}},"GlobalPromotionResponse":{"type":"object","properties":{"Code":{"type":"string","description":"promotion code"},"Name":{"type":"string","description":"promotion name"},"Description":{"type":"string","description":"promotion description"},"StartDate":{"type":"string","description":"promotion start date"},"EndDate":{"type":"string","description":"promotion end date"},"MaximumOrdersNumber":{"type":"number","description":"promotion maximum number of orders"},"MaximumQuantity":{"type":"number","description":"promotion maximum number of products"},"InstantDiscount":{"type":"boolean","description":"instant discount applied to the promotion"},"Coupon":{"$ref":"#/components/schemas/PromotionCoupon"},"Enabled":{"type":"boolean"},"ChannelType":{"type":"string"},"Type":{"type":"string"},"Discount":{"$ref":"#/components/schemas/PromotionDiscountFixed"},"PriceThreshold":{"$ref":"#/components/schemas/GlobalPromotionPriceThreshold"},"Translations":{"$ref":"#/components/schemas/PromotionTranslations"},"Sources":{"type":"array","items":{"type":"string"}},"PublishToAffiliatesNetwork":{"type":"number"},"ApplyRecurring":{"type":"string"},"RecurringChargesNumber":{"type":"number","description":"number of recurring charges to apply the promotion to"}}},"SpecialPricePromotionResponse":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}},"CumulativePromotionResponse":{"type":"object","properties":{"ApplyRecurring":{"type":"string"},"Coupon":{"$ref":"#/components/schemas/promotions_Coupon"},"Description":{"type":"string"},"Enabled":{"type":"boolean"},"EndDate":{"type":"string"},"InstantDiscount":{"type":"number"},"MaximumOrdersNumber":{"type":"number"},"MaximumQuantity":{"type":"number"},"Name":{"type":"string"},"StartDate":{"type":"string"},"Type":{"type":"string"},"Cumulative":{"type":"boolean"},"ProductTaxCategoryUUID":{"type":"string"},"Products":{"type":"array","items":{"$ref":"#/components/schemas/promotions_Products"}},"DefaultCurrency":{"type":"string"},"PriceMatrix":{"type":"array","items":{"$ref":"#/components/schemas/priceMatrixPrice"}}}}}}} ``` ## POST /promotions/{PromotionCode}/coupons/ > Add promotion coupon ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/coupons/":{"post":{"tags":["Promotions"],"summary":"Add promotion coupon","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/body_14"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{}}}}}}},"components":{"schemas":{"body_14":{"type":"object","properties":{"Code":{"description":"\"Varies according to type. Send:","type":"string"},"Type":{"description":"\"Coupon type:","type":"string"}}}}}} ``` ## PUT /promotions/{PromotionCode}/coupons/ > Update promotion coupon ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/coupons/":{"put":{"tags":["Promotions"],"summary":"Update promotion coupon","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PromotionCoupon"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{}}}}}}},"components":{"schemas":{"PromotionCoupon":{"type":"object","properties":{"Type":{"type":"string","description":"coupon type (SINGLE or MULTIPLE)"},"Code":{"type":"string","description":"coupon code"}}}}}} ``` ## DELETE /promotions/{PromotionCode}/coupons/ > Delete promotion coupons ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/coupons/":{"delete":{"tags":["Promotions"],"summary":"Delete promotion coupons","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{}}}}}}}} ``` ## POST /promotions/{PromotionCode}/products/ > Add products to a promotion ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/products/":{"post":{"tags":["Promotions"],"summary":"Add products to a promotion","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PromotionProduct"}}}}}}}}},"components":{"schemas":{"PromotionProduct":{"type":"object","properties":{"Code":{"type":"string","description":"Promotion code."},"PricingConfigurationCode":{"type":"string","description":"Pricing configuration code."},"PricingOptionCodes":{"description":"Pricing option codes that you control.","type":"array","items":{"type":"string"}}}}}}} ``` ## DELETE /promotions/{PromotionCode}/products/ > Remove products from a promotion ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/products/":{"delete":{"tags":["Promotions"],"summary":"Remove products from a promotion","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## POST /promotions/{PromotionCode}/sources/ > Add promotion sources ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/sources/":{"post":{"tags":["Promotions"],"summary":"Add promotion sources","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionSources"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{}}}}}}},"components":{"schemas":{"PromotionSources":{"type":"object","properties":{"SOURCE_1":{"type":"string"},"SOURCE_2":{"type":"string"},"SOURCE_3":{"type":"string"}}}}}} ``` ## DELETE /promotions/{PromotionCode}/sources/ > Delete promotion sources ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/sources/":{"delete":{"tags":["Promotions"],"summary":"Delete promotion sources","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{}}}}}}}} ``` ## PUT /promotions/{PromotionCode}/translations/ > Add promotion translations ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/translations/":{"put":{"tags":["Promotions"],"summary":"Add promotion translations","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionTranslations"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionTranslations"}}}}}}}},"components":{"schemas":{"PromotionTranslations":{"type":"array","items":{"$ref":"#/components/schemas/PromotionTranslation"}},"PromotionTranslation":{"type":"object","properties":{"Name":{"type":"string","description":"Translation text."},"Language":{"type":"string","description":"Translation language code."}}}}}} ``` ## DELETE /promotions/{PromotionCode}/translations/ > Delete promotion translations ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/promotions/{PromotionCode}/translations/":{"delete":{"tags":["Promotions"],"summary":"Delete promotion translations","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{}}}}}}}} ``` ## PUT /{PromotionCode}/discounts/ > Update the discounts for a promotion ```json {"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/{PromotionCode}/discounts/":{"put":{"tags":["Promotions"],"summary":"Update the discounts for a promotion","parameters":[{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"PromotionCode","in":"path","description":"Unique system generated promotion code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PromotionDiscountFixed"},{"$ref":"#/components/schemas/PromotionDiscountPercent"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PromotionDiscountFixed"},{"$ref":"#/components/schemas/PromotionDiscountPercent"}]}}}}}}}},"components":{"schemas":{"PromotionDiscountFixed":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (FIXED)"},"Values":{"description":"• Value = Int, determines the discount percentage from 0 to 100","type":"array","items":{"$ref":"#/components/schemas/PromotionDiscountAmount"}},"DefaultCurrency":{"type":"string","description":"promotion currency"}}},"PromotionDiscountAmount":{"type":"object","properties":{"Currency":{"type":"string","description":"price discount currency"},"Amount":{"type":"number","description":"price discount amount"}}},"PromotionDiscountPercent":{"type":"object","properties":{"Type":{"type":"string","description":"discount type (PERCENT)"},"Value":{"type":"integer","description":"the value of the percentage discount"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.2checkout.com/api-reference/reference/promotions.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.