externalPromotions

post

/ccadmin/v1/webhook/externalPromotions

This operation is triggered during pricing operations to make promotion related adjustments to an order's price, or individual item prices.

Request

Supported Media Types
Body ()
This functional webhook is triggered during pricing operations and allows external item and order promotions to be applied to an order
Root Schema : externalPromotions_request
Type: object
This functional webhook is triggered during pricing operations and allows external item and order promotions to be applied to an order
Show Source
Nested Schema : externalCoupons
Type: array
External coupons applied to order.
Show Source
Nested Schema : order
Type: object
Show Source
Nested Schema : profile
Type: object
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
Nested Schema : payments
Type: array
Show Source
Nested Schema : priceInfo
Type: object
Show Source
Nested Schema : shippingAddress
Type: object
Show Source
Nested Schema : shippingGroups
Type: array
Show Source
Nested Schema : shippingMethod
Type: object
Show Source
Nested Schema : shoppingCart
Type: object
Show Source
Nested Schema : taxPriceInfo
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Show Source
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
Nested Schema : discountInfo
Type: array
Whether this item is discounted.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The map values associated with an externalData item.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : sitePropertiesList
Type: array
The list of site related properties for the profile
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
The site related properties for the profile
Show Source
Nested Schema : site
Type: object
The site data
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : externalPromotions_response
Type: object
Show Source
Example:
{
    "promotionAdjustments":[
        {
            "commerceItemId":"ci6000413",
            "quantity":"2",
            "displayName":"AAAPromo",
            "description":"$2 discount on AAA batteries",
            "adjustmentOrdering":"highestFirst",
            "adjustmentAmount":"-2",
            "adjustmentOperation":"adjustItemPrice",
            "promotionId":"EP1001"
        },
        {
            "externalPromotionId":"EP1003",
            "displayName":"5DollarDiscount",
            "description":"$5 off order when total above $30",
            "adjustmentAmount":"-5",
            "adjustmentOperation":"adjustOrderPrice"
        }
    ],
    "responseCode":"6101"
}
Nested Schema : errors
Type: array
Coupon related error details.
Show Source
Nested Schema : promotionAdjustments
Type: array
The adjustments to be made to an order reflecting the application of promotions.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top