PUT 3dCartWebAPI/v1/Promotions/{promotionid}
This method is used to update a single promotion record in the database. The {promotionid} parameter specifies which promotion to update.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
promotionid |
Promotion ID |
integer |
Required |
Body Parameters
A Json or XML object containing the new promotion
PromotionsName | Description | Type | Additional information |
---|---|---|---|
PromotionID |
Primary key. Auto-incremented. database reference = promotions.id |
integer |
None. |
PromotionName |
database reference = promotions.promotion_name |
string |
String length: inclusive between 0 and 150 |
PromotionDescription |
database reference = promotions.promotion_description |
string |
String length: inclusive between 0 and 65535 |
PromotionStart |
database reference = promotions.promotion_start |
date |
None. |
PromotionEnd |
database reference = promotions.promotion_end |
date |
None. |
PromotionEnabled |
database reference = promotions.promotion_enabled |
integer |
None. |
PromotionByAmount |
database reference = promotions.by_amount |
decimal number |
None. |
PromotionCheckByAmount |
database reference = promotions.chk_byamount |
integer |
None. |
PromotionByQuantity |
database reference = promotions.by_quantity |
integer |
None. |
PromotionCheckByQuantity |
database reference = promotions.chk_byquantity |
integer |
None. |
PromotionByProduct |
database reference = promotions.by_product |
integer |
None. |
PromotionByCategory |
database reference = promotions.by_category |
string |
String length: inclusive between 0 and 65535 |
PromotionAmount |
database reference = promotions.promotion_amount |
decimal number |
None. |
PromotionPercentage |
database reference = promotions.promotion_percentage |
integer |
None. |
PromotionPerItem |
database reference = promotions.promotion_peritem |
integer |
None. |
PromotionCategory |
database reference = promotions.promotion_category |
string |
String length: inclusive between 0 and 65535 |
PromotionProduct |
database reference = promotions.promotion_product |
string |
String length: inclusive between 0 and 150 |
PromotionFreeShipping |
database reference = promotions.promotion_freeshipping |
integer |
None. |
PromotionFreeProduct |
database reference = promotions.promotion_freeproduct |
string |
String length: inclusive between 0 and 150 |
PromotionProduct1ID |
database reference = promotions.prod1_id |
integer |
None. |
PromotionProduct1Quantity |
database reference = promotions.prod1_qty |
integer |
None. |
PromotionProduct2ID |
database reference = promotions.prod2_id |
integer |
None. |
PromotionProduct2Quantity |
database reference = promotions.prod2_qty |
integer |
None. |
PromotionProduct3ID |
database reference = promotions.prod3_id |
integer |
None. |
PromotionProduct3Quantity |
database reference = promotions.prod3_qty |
integer |
None. |
PromotionProductID |
database reference = promotions.prod4_id |
integer |
None. |
PromotionProduct4Quantity |
database reference = promotions.prod4_qty |
integer |
None. |
PromotionCoupon |
database reference = promotions.coupon |
string |
String length: inclusive between 0 and 50 |
PromotionUses |
database reference = promotions.promotion_uses |
integer |
None. |
PromotionMaxUses |
database reference = promotions.promotion_maxuses |
integer |
None. |
PromotionUsesPerCustomer |
database reference = promotions.promotion_usespercust |
integer |
None. |
PromotionGroupID |
database reference = promotions.coupon_group |
string |
String length: inclusive between 0 and 255 |
PromotionUserid |
database reference = promotions.userid |
string |
String length: inclusive between 0 and 50 |
PromotionLastUpdate |
database reference = promotions.last_update |
date |
None. |
PromotionByAmount2 |
database reference = promotions.by_amount2 |
decimal number |
None. |
PromotionByQuantity2 |
database reference = promotions.by_quantity2 |
decimal number |
None. |
PromotionCountry |
database reference = promotions.promotion_country |
string |
String length: inclusive between 0 and 50 |
PromotionState |
database reference = promotions.promotion_state |
string |
String length: inclusive between 0 and 50 |
PromotionNonStackable |
database reference = promotions.nonstackable |
integer |
None. |
PromotionRulesRetailPrice |
database reference = promotions.rules_retailprice |
integer |
None. |
PromotionExcludeManufacturers |
database reference = promotions.exc_manufacturer |
string |
String length: inclusive between 0 and 65535 |
PromotionFreeProductPrice |
database reference = promotions.promotion_freeproduct_price |
decimal number |
None. |
PromotionExcludePreorder |
database reference = promotions.exc_preorder |
integer |
None. |
PromotionExcludeSpecialOrder |
database reference = promotions.exc_specialorder |
integer |
None. |
PromotionShippingDiscount |
database reference = promotions.shipping_discount |
decimal number |
None. |
PromotionShippingOptions |
database reference = promotions.shipping_options |
string |
String length: inclusive between 0 and 150 |
PromotionRecurringOrders |
database reference = promotions.recurringorders |
integer |
None. |
PromotionBonusRewardPoints |
database reference = promotions.bonus_reward_points |
integer |
None. |
PromotionByReward |
database reference = promotions.by_reward |
integer |
None. |
PromotionByReward2 |
database reference = promotions.by_reward2 |
integer |
None. |
Request Formats
application/json, text/json
{ "PromotionID": 1, "PromotionName": "sample string 1", "PromotionDescription": "sample string 2", "PromotionStart": "03/28/2024 05:00", "PromotionEnd": "03/28/2024 05:00", "PromotionEnabled": 5, "PromotionByAmount": 1.0, "PromotionCheckByAmount": 1, "PromotionByQuantity": 1, "PromotionCheckByQuantity": 1, "PromotionByProduct": 1, "PromotionByCategory": "sample string 6", "PromotionAmount": 1.1, "PromotionPercentage": 1, "PromotionPerItem": 1, "PromotionCategory": "sample string 7", "PromotionProduct": "sample string 8", "PromotionFreeShipping": 1, "PromotionFreeProduct": "sample string 9", "PromotionProduct1ID": 1, "PromotionProduct1Quantity": 1, "PromotionProduct2ID": 1, "PromotionProduct2Quantity": 1, "PromotionProduct3ID": 1, "PromotionProduct3Quantity": 1, "PromotionProductID": 1, "PromotionProduct4Quantity": 1, "PromotionCoupon": "sample string 10", "PromotionUses": 11, "PromotionMaxUses": 12, "PromotionUsesPerCustomer": 13, "PromotionGroupID": "sample string 14", "PromotionUserid": "sample string 15", "PromotionLastUpdate": "03/28/2024 05:00", "PromotionByAmount2": 1.0, "PromotionByQuantity2": 1.1, "PromotionCountry": "sample string 16", "PromotionState": "sample string 17", "PromotionNonStackable": 1, "PromotionRulesRetailPrice": 1, "PromotionExcludeManufacturers": "sample string 18", "PromotionFreeProductPrice": 1.1, "PromotionExcludePreorder": 1, "PromotionExcludeSpecialOrder": 1, "PromotionShippingDiscount": 1.1, "PromotionShippingOptions": "sample string 19", "PromotionRecurringOrders": 1, "PromotionBonusRewardPoints": 1, "PromotionByReward": 1, "PromotionByReward2": 1 }
application/xml, text/xml
<Promotions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <PromotionID>1</PromotionID> <PromotionName>sample string 1</PromotionName> <PromotionDescription>sample string 2</PromotionDescription> <PromotionStart>2024-03-28T05:00:53.1951261-04:00</PromotionStart> <PromotionEnd>2024-03-28T05:00:53.1951261-04:00</PromotionEnd> <PromotionEnabled>5</PromotionEnabled> <PromotionByAmount>1</PromotionByAmount> <PromotionCheckByAmount>1</PromotionCheckByAmount> <PromotionByQuantity>1</PromotionByQuantity> <PromotionCheckByQuantity>1</PromotionCheckByQuantity> <PromotionByProduct>1</PromotionByProduct> <PromotionByCategory>sample string 6</PromotionByCategory> <PromotionAmount>1.1</PromotionAmount> <PromotionPercentage>1</PromotionPercentage> <PromotionPerItem>1</PromotionPerItem> <PromotionCategory>sample string 7</PromotionCategory> <PromotionProduct>sample string 8</PromotionProduct> <PromotionFreeShipping>1</PromotionFreeShipping> <PromotionFreeProduct>sample string 9</PromotionFreeProduct> <PromotionProduct1ID>1</PromotionProduct1ID> <PromotionProduct1Quantity>1</PromotionProduct1Quantity> <PromotionProduct2ID>1</PromotionProduct2ID> <PromotionProduct2Quantity>1</PromotionProduct2Quantity> <PromotionProduct3ID>1</PromotionProduct3ID> <PromotionProduct3Quantity>1</PromotionProduct3Quantity> <PromotionProductID>1</PromotionProductID> <PromotionProduct4Quantity>1</PromotionProduct4Quantity> <PromotionCoupon>sample string 10</PromotionCoupon> <PromotionUses>11</PromotionUses> <PromotionMaxUses>12</PromotionMaxUses> <PromotionUsesPerCustomer>13</PromotionUsesPerCustomer> <PromotionGroupID>sample string 14</PromotionGroupID> <PromotionUserid>sample string 15</PromotionUserid> <PromotionLastUpdate>2024-03-28T05:00:53.1951261-04:00</PromotionLastUpdate> <PromotionByAmount2>1</PromotionByAmount2> <PromotionByQuantity2>1.1</PromotionByQuantity2> <PromotionCountry>sample string 16</PromotionCountry> <PromotionState>sample string 17</PromotionState> <PromotionNonStackable>1</PromotionNonStackable> <PromotionRulesRetailPrice>1</PromotionRulesRetailPrice> <PromotionExcludeManufacturers>sample string 18</PromotionExcludeManufacturers> <PromotionFreeProductPrice>1.1</PromotionFreeProductPrice> <PromotionExcludePreorder>1</PromotionExcludePreorder> <PromotionExcludeSpecialOrder>1</PromotionExcludeSpecialOrder> <PromotionShippingDiscount>1.1</PromotionShippingDiscount> <PromotionShippingOptions>sample string 19</PromotionShippingOptions> <PromotionRecurringOrders>1</PromotionRecurringOrders> <PromotionBonusRewardPoints>1</PromotionBonusRewardPoints> <PromotionByReward>1</PromotionByReward> <PromotionByReward2>1</PromotionByReward2> </Promotions>
Sample Request |
|
Response Information
application/json, text/json
[ { "Key":"PromotionID", "Value":"1234", "Status":"200", "Message":"updated successfully", } ]
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |