GET 3dCartWebAPI/v1/Promotions


Get all Promotions

Request Information

URI Parameters

NameDescriptionTypeAdditional information
limit

Maximum number of items that can be returned

integer

Default value is 10

offset

Starting point for the return data

integer

Default value is 1

promotion

Name of the Promotion

string

Default value is

countonly

Count the number of rows only

integer

Default value is 0

Body Parameters

None.


Sample Request



Response Information

Resource Description

Collection of Promotions
NameDescriptionTypeAdditional 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

integer

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.

Response Formats

application/json, text/json

Sample:
[
  {
    "PromotionID": 1,
    "PromotionName": "sample string 1",
    "PromotionDescription": "sample string 2",
    "PromotionStart": "10/16/2019 22:25",
    "PromotionEnd": "10/16/2019 22:25",
    "PromotionEnabled": 5,
    "PromotionByAmount": 1,
    "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": "10/16/2019 22:25",
    "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
  },
  {
    "PromotionID": 1,
    "PromotionName": "sample string 1",
    "PromotionDescription": "sample string 2",
    "PromotionStart": "10/16/2019 22:25",
    "PromotionEnd": "10/16/2019 22:25",
    "PromotionEnabled": 5,
    "PromotionByAmount": 1,
    "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": "10/16/2019 22:25",
    "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
  }
]

application/xml, text/xml

Sample:
<ArrayOfPromotions xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Promotions>
    <PromotionAmount>1.1</PromotionAmount>
    <PromotionBonusRewardPoints>1</PromotionBonusRewardPoints>
    <PromotionByAmount>1</PromotionByAmount>
    <PromotionByAmount2>1</PromotionByAmount2>
    <PromotionByCategory>sample string 6</PromotionByCategory>
    <PromotionByProduct>1</PromotionByProduct>
    <PromotionByQuantity>1</PromotionByQuantity>
    <PromotionByQuantity2>1.1</PromotionByQuantity2>
    <PromotionCategory>sample string 7</PromotionCategory>
    <PromotionCheckByAmount>1</PromotionCheckByAmount>
    <PromotionCheckByQuantity>1</PromotionCheckByQuantity>
    <PromotionCountry>sample string 16</PromotionCountry>
    <PromotionCoupon>sample string 10</PromotionCoupon>
    <PromotionDescription>sample string 2</PromotionDescription>
    <PromotionEnabled>5</PromotionEnabled>
    <PromotionEnd>2019-10-16T22:25:14.9209505-04:00</PromotionEnd>
    <PromotionExcludeManufacturers>sample string 18</PromotionExcludeManufacturers>
    <PromotionExcludePreorder>1</PromotionExcludePreorder>
    <PromotionExcludeSpecialOrder>1</PromotionExcludeSpecialOrder>
    <PromotionFreeProduct>sample string 9</PromotionFreeProduct>
    <PromotionFreeProductPrice>1.1</PromotionFreeProductPrice>
    <PromotionFreeShipping>1</PromotionFreeShipping>
    <PromotionGroupID>sample string 14</PromotionGroupID>
    <PromotionID>1</PromotionID>
    <PromotionLastUpdate>2019-10-16T22:25:14.9209505-04:00</PromotionLastUpdate>
    <PromotionMaxUses>12</PromotionMaxUses>
    <PromotionName>sample string 1</PromotionName>
    <PromotionNonStackable>1</PromotionNonStackable>
    <PromotionPerItem>1</PromotionPerItem>
    <PromotionPercentage>1</PromotionPercentage>
    <PromotionProduct>sample string 8</PromotionProduct>
    <PromotionProduct1ID>1</PromotionProduct1ID>
    <PromotionProduct1Quantity>1</PromotionProduct1Quantity>
    <PromotionProduct2ID>1</PromotionProduct2ID>
    <PromotionProduct2Quantity>1</PromotionProduct2Quantity>
    <PromotionProduct3ID>1</PromotionProduct3ID>
    <PromotionProduct3Quantity>1</PromotionProduct3Quantity>
    <PromotionProduct4Quantity>1</PromotionProduct4Quantity>
    <PromotionProductID>1</PromotionProductID>
    <PromotionRecurringOrders>1</PromotionRecurringOrders>
    <PromotionRulesRetailPrice>1</PromotionRulesRetailPrice>
    <PromotionShippingDiscount>1.1</PromotionShippingDiscount>
    <PromotionShippingOptions>sample string 19</PromotionShippingOptions>
    <PromotionStart>2019-10-16T22:25:14.9209505-04:00</PromotionStart>
    <PromotionState>sample string 17</PromotionState>
    <PromotionUserid>sample string 15</PromotionUserid>
    <PromotionUses>11</PromotionUses>
    <PromotionUsesPerCustomer>13</PromotionUsesPerCustomer>
  </Promotions>
  <Promotions>
    <PromotionAmount>1.1</PromotionAmount>
    <PromotionBonusRewardPoints>1</PromotionBonusRewardPoints>
    <PromotionByAmount>1</PromotionByAmount>
    <PromotionByAmount2>1</PromotionByAmount2>
    <PromotionByCategory>sample string 6</PromotionByCategory>
    <PromotionByProduct>1</PromotionByProduct>
    <PromotionByQuantity>1</PromotionByQuantity>
    <PromotionByQuantity2>1.1</PromotionByQuantity2>
    <PromotionCategory>sample string 7</PromotionCategory>
    <PromotionCheckByAmount>1</PromotionCheckByAmount>
    <PromotionCheckByQuantity>1</PromotionCheckByQuantity>
    <PromotionCountry>sample string 16</PromotionCountry>
    <PromotionCoupon>sample string 10</PromotionCoupon>
    <PromotionDescription>sample string 2</PromotionDescription>
    <PromotionEnabled>5</PromotionEnabled>
    <PromotionEnd>2019-10-16T22:25:14.9209505-04:00</PromotionEnd>
    <PromotionExcludeManufacturers>sample string 18</PromotionExcludeManufacturers>
    <PromotionExcludePreorder>1</PromotionExcludePreorder>
    <PromotionExcludeSpecialOrder>1</PromotionExcludeSpecialOrder>
    <PromotionFreeProduct>sample string 9</PromotionFreeProduct>
    <PromotionFreeProductPrice>1.1</PromotionFreeProductPrice>
    <PromotionFreeShipping>1</PromotionFreeShipping>
    <PromotionGroupID>sample string 14</PromotionGroupID>
    <PromotionID>1</PromotionID>
    <PromotionLastUpdate>2019-10-16T22:25:14.9209505-04:00</PromotionLastUpdate>
    <PromotionMaxUses>12</PromotionMaxUses>
    <PromotionName>sample string 1</PromotionName>
    <PromotionNonStackable>1</PromotionNonStackable>
    <PromotionPerItem>1</PromotionPerItem>
    <PromotionPercentage>1</PromotionPercentage>
    <PromotionProduct>sample string 8</PromotionProduct>
    <PromotionProduct1ID>1</PromotionProduct1ID>
    <PromotionProduct1Quantity>1</PromotionProduct1Quantity>
    <PromotionProduct2ID>1</PromotionProduct2ID>
    <PromotionProduct2Quantity>1</PromotionProduct2Quantity>
    <PromotionProduct3ID>1</PromotionProduct3ID>
    <PromotionProduct3Quantity>1</PromotionProduct3Quantity>
    <PromotionProduct4Quantity>1</PromotionProduct4Quantity>
    <PromotionProductID>1</PromotionProductID>
    <PromotionRecurringOrders>1</PromotionRecurringOrders>
    <PromotionRulesRetailPrice>1</PromotionRulesRetailPrice>
    <PromotionShippingDiscount>1.1</PromotionShippingDiscount>
    <PromotionShippingOptions>sample string 19</PromotionShippingOptions>
    <PromotionStart>2019-10-16T22:25:14.9209505-04:00</PromotionStart>
    <PromotionState>sample string 17</PromotionState>
    <PromotionUserid>sample string 15</PromotionUserid>
    <PromotionUses>11</PromotionUses>
    <PromotionUsesPerCustomer>13</PromotionUsesPerCustomer>
  </Promotions>
</ArrayOfPromotions>