External Price Validation

post

/ccadmin/v1/webhook/externalPricing

This web hook is triggered when a request is made to place the order and it performs a validation of the external price details in the cart. If the external prices sent by the external system is different to that in the request , a price change message will be displayed on the storefront and the new external price info will be set on the corresponding commerce items. Storefront will display a message listing failed items if there are unpriced items in the cart. A response code of 5001 is returned for valid external prices and 5002 otherwise.

Request

Supported Media Types
Body ()
This web hook is triggered when a request is made to place the current order and it performs a validation of the external price details in the cart. A response code of 5001 is returned for valid external prices and 5002 otherwise
Root Schema : externalPricing_request
Type: object
This web hook is triggered when a request is made to place the current order and it performs a validation of the external price details in the cart. A response code of 5001 is returned for valid external prices and 5002 otherwise
Show Source
Example:
{
    "profile":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "loyaltyPrograms":[
        ],
        "receiveEmail":"no",
        "middleName":null,
        "id":"se-570031",
        "locale":"en",
        "sitePropertiesList":[
            {
                "site":{
                    "id":"siteUS"
                },
                "properties":{
                    "GDPRProfileP13nConsentDate":null,
                    "GDPRProfileP13nConsentGranted":false,
                    "receiveEmail":"no",
                    "receiveEmailDate":null
                }
            }
        ],
        "email":"kim@example.com",
        "daytimeTelephoneNumber":null
    },
    "externalPrices":[
        {
            "commerceItemId":"ci3000446",
            "externalPriceQuantity":2,
            "childItems":[
                {
                    "commerceItemId":"ci3000447",
                    "catRefId":"childSku1"
                },
                {
                    "commerceItemId":"ci3000448",
                    "catRefId":"childSku2"
                }
            ],
            "catRefId":"sku50001",
            "externalPrice":30
        }
    ],
    "currencyCode":"USD",
    "operation":"externalPricing",
    "order":{
        "taxPriceInfo":{
            "cityTax":0,
            "secondaryCurrencyTaxAmount":0,
            "amount":0,
            "valueAddedTax":0,
            "countyTax":0,
            "isTaxIncluded":false,
            "miscTax":0,
            "districtTax":0,
            "stateTax":0,
            "countryTax":0
        },
        "shippingGroups":[
            {
                "lastName":"Muir",
                "firstName":"John",
                "phoneNumber":"123456789",
                "discountInfo":{
                    "orderDiscount":0,
                    "shippingDiscount":0,
                    "discountDescList":[
                    ]
                },
                "shippingMethod":{
                    "secondaryCurrencyTaxAmount":0,
                    "shippingTax":0,
                    "cost":0,
                    "taxCode":"",
                    "value":"standardShippingMethod",
                    "shippingMethodDescription":"Standard"
                },
                "shippingGroupId":"sg40431",
                "shippingAddress":{
                    "lastName":"Anderson",
                    "country":"US",
                    "address3":"",
                    "address2":"",
                    "city":"Syracuse",
                    "prefix":"",
                    "address1":"21 Cedar Ave",
                    "postalCode":"13202",
                    "companyName":"",
                    "jobTitle":"",
                    "county":"",
                    "suffix":"",
                    "firstName":"Kim",
                    "phoneNumber":"212-555-1977",
                    "faxNumber":"",
                    "alias":"Home",
                    "middleName":"",
                    "state":"NY",
                    "email":"kim@example.com"
                },
                "store":{
                    "country":"USA",
                    "hours":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM",
                    "address3":null,
                    "address2":"4th Floor",
                    "city":"Boston",
                    "address1":"One Beacon Street",
                    "postalCode":"2108",
                    "county":null,
                    "stateAddress":"MA",
                    "phoneNumber":"(617) 386-1200",
                    "locationId":"Boston138",
                    "name":"CRS Home - Boston #138",
                    "faxNumber":"(617) 386-1200",
                    "email":"store138@example.com"
                },
                "type":"inStorePickupShippingGroup",
                "items":[
                    {
                        "availablePickupDate":"2018-05-19T13:00:00.000Z",
                        "rawTotalPrice":0,
                        "returnedQuantity":0,
                        "dynamicProperties":[
                            {
                                "id":"customCommerceItemShortTextProp",
                                "label":"Custom ShortText Property at the Commerce Item level",
                                "value":"TESTVALUE"
                            },
                            {
                                "id":"customCommerceItemNumberProp",
                                "label":"Custom Number Property at the Commerce Item level",
                                "value":1234
                            }
                        ],
                        "shippingSurchargeValue":0,
                        "externalData":[
                        ],
                        "discountAmount":0,
                        "preOrderQuantity":0,
                        "childItems":[
                            {
                                "unitPrice":0,
                                "addOnItem":false,
                                "amount":0,
                                "quantity":2,
                                "productId":"prod40001",
                                "rawTotalPrice":0,
                                "salePrice":0,
                                "displayName":"Laptop Parts1",
                                "detailedItemPriceInfo":[
                                ],
                                "externalData":[
                                ],
                                "catRefId":"childSku1",
                                "commerceItemId":"ci3000447",
                                "route":"/laptop-parts1/product/prod40001",
                                "selectedOptions":[
                                ],
                                "id":"ci3000447",
                                "shopperInput":{
                                },
                                "listPrice":0
                            },
                            {
                                "unitPrice":0,
                                "addOnItem":false,
                                "amount":0,
                                "quantity":21,
                                "productId":"prod40002",
                                "rawTotalPrice":0,
                                "salePrice":0,
                                "displayName":"Laptop Parts2",
                                "detailedItemPriceInfo":[
                                ],
                                "externalData":[
                                ],
                                "catRefId":"childSku2",
                                "commerceItemId":"ci3000448",
                                "route":"/laptop-parts2/product/prod40002",
                                "selectedOptions":[
                                ],
                                "id":"ci3000448",
                                "shopperInput":{
                                },
                                "listPrice":0
                            }
                        ],
                        "configuratorId":"18225092",
                        "externalPrice":30,
                        "commerceItemId":"ci1528990958825",
                        "price":0,
                        "onSale":false,
                        "stateDetailsAsUser":"The item has been initialized within the shipping group",
                        "commerceId":"ci3000446",
                        "unitPrice":0,
                        "amount":0,
                        "quantity":1,
                        "productId":"prod50001",
                        "salePrice":0,
                        "preferredPickupDate":"2018-05-19T13:00:00.000Z",
                        "externalPriceQuantity":2,
                        "catRefId":"sku50001",
                        "discountInfo":[
                        ],
                        "shopperInput":{
                        },
                        "backOrderQuantity":0,
                        "listPrice":0,
                        "status":"INITIAL"
                    }
                ],
                "email":"john.muir@example.com"
            }
        ],
        "creationTime":1.52899109387E12,
        "orderId":"o30427",
        "lastModifiedDate":"2018-06-14T15:44:53.870Z",
        "dynamicProperties":[
        ],
        "payments":[
        ],
        "shippingMethod":{
            "shippingTax":0,
            "cost":0,
            "value":"standardShippingMethod"
        },
        "priceListGroup":{
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup"
        },
        "orderStatus":"Incomplete",
        "cartName":"My Cart",
        "creationDate":"2018-06-14T15:44:53.870Z",
        "orderProfileId":"120102",
        "priceInfo":{
            "amount":0,
            "total":0,
            "shipping":0,
            "shippingSurchargeValue":0,
            "tax":0,
            "subTotal":0,
            "currencyCode":null,
            "totalWithoutTax":0
        },
        "discountInfo":{
            "unclaimedCouponMultiPromotions":{
            },
            "orderCouponsMap":{
            },
            "orderDiscount":0,
            "shippingDiscount":0,
            "orderImplicitDiscountList":[
            ],
            "unclaimedCouponsMap":{
            },
            "claimedCouponMultiPromotions":{
            }
        },
        "shoppingCart":{
            "numberOfItems":1,
            "items":[
                {
                    "primaryThumbImageURL":"/img/no-image.jpg",
                    "rawTotalPrice":0,
                    "displayName":"Laptop1",
                    "dynamicProperties":[
                        {
                            "id":"customCommerceItemShortTextProp",
                            "label":"Custom ShortText Property at the Commerce Item level",
                            "value":"TESTVALUE"
                        },
                        {
                            "id":"customCommerceItemNumberProp",
                            "label":"Custom Number Property at the Commerce Item level",
                            "value":1234
                        }
                    ],
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "isItemValid":true,
                    "childItems":[
                        {
                            "unitPrice":0,
                            "addOnItem":false,
                            "amount":0,
                            "quantity":2,
                            "productId":"prod40001",
                            "rawTotalPrice":0,
                            "salePrice":0,
                            "displayName":"Laptop Parts1",
                            "detailedItemPriceInfo":[
                            ],
                            "externalData":[
                            ],
                            "catRefId":"childSku1",
                            "commerceItemId":"ci3000447",
                            "route":"/laptop-parts1/product/prod40001",
                            "selectedOptions":[
                            ],
                            "id":"ci3000447",
                            "shopperInput":{
                            },
                            "listPrice":0
                        },
                        {
                            "unitPrice":0,
                            "addOnItem":false,
                            "amount":0,
                            "quantity":21,
                            "productId":"prod40002",
                            "rawTotalPrice":0,
                            "salePrice":0,
                            "displayName":"Laptop Parts2",
                            "detailedItemPriceInfo":[
                            ],
                            "externalData":[
                            ],
                            "catRefId":"childSku2",
                            "commerceItemId":"ci3000448",
                            "route":"/laptop-parts2/product/prod40002",
                            "selectedOptions":[
                            ],
                            "id":"ci3000448",
                            "shopperInput":{
                            },
                            "listPrice":0
                        }
                    ],
                    "configuratorId":"18225092",
                    "externalPrice":30,
                    "commerceItemId":"ci1528990958825",
                    "price":0,
                    "variant":[
                    ],
                    "onSale":false,
                    "id":"ci3000446",
                    "unitPrice":0,
                    "amount":0,
                    "quantity":1,
                    "productId":"prod50001",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                    ],
                    "giftWithPurchaseCommerceItemMarkers":[
                    ],
                    "externalPriceQuantity":2,
                    "catRefId":"sku50001",
                    "skuProperties":[
                        {
                            "propertyType":"sku-base",
                            "name":"Not Returnable",
                            "id":"nonreturnable",
                            "value":false
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Name",
                            "id":"displayName",
                            "value":null
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Active",
                            "id":"active",
                            "value":true
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Id",
                            "id":"id",
                            "value":"sku50001"
                        }
                    ],
                    "discountInfo":[
                    ],
                    "shopperInput":{
                    },
                    "listPrice":0
                }
            ]
        },
        "giftWithPurchaseInfo":[
        ],
        "siteId":"siteUS",
        "shippingAddress":{
            "lastName":"Anderson",
            "country":"US",
            "address3":"",
            "address2":"",
            "city":"Syracuse",
            "prefix":"",
            "address1":"21 Cedar Ave",
            "postalCode":"13202",
            "companyName":"",
            "jobTitle":"",
            "county":"",
            "suffix":"",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "faxNumber":"",
            "alias":"Home",
            "middleName":"",
            "state":"NY",
            "email":"kim@example.com"
        }
    }
}
Nested Schema : externalPrices
Type: array
Show Source
Nested Schema : order
Type: object
Show Source
Nested Schema : externalPriceRequestOrganization
Type: object
Show Source
Nested Schema : profile
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Show Source
Nested Schema : externalPriceRequestChild
Type: object
Show Source
Nested Schema : childItems
Type: array
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 : recurringChargePriceInfo
Type: object
Recurring charge price information.
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 : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
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 : childItems
Type: array
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge 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 : store
Type: object
The store is present in the request if the type is inStorePickupShippingGroup.
Show Source
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedItemPriceInfo
Type: array
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 : values
Type: object
The map values associated with an externalData item.
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
Nested Schema : promotions
Type: array
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 : promotionInfo
Type: array
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 : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: array
Whether this item is discounted.
Show Source
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
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 : giftWithPurchaseDiscountInfo
Type: array
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 : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type: object
Show Source