cancelPCI

post

/ccadmin/v1/webhook/cancelPCI

This webhook is triggered by a cancel order event.

Request

Supported Media Types
Body ()
Root Schema : cancelPCI_request
Type: object
Show Source
Example:
{
    "site":{
        "siteURL":"http://localhost:8080",
        "siteName":"Commerce Cloud Site"
    },
    "cancellationSource":"shopper",
    "discountInfo":{
        "unclaimedCouponMultiPromotions":{
        },
        "orderCouponsMap":{
        },
        "orderDiscount":0,
        "secondaryCurrencyShippingDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
        ],
        "unclaimedCouponsMap":{
        },
        "claimedCouponMultiPromotions":{
        }
    },
    "order":{
        "approverIds":[
        ],
        "gwp":false,
        "secondaryCurrencyCode":"USD",
        "lastModifiedTime":1.511257005212E12,
        "priceGroupId":"priceListGroup_1511256910174",
        "creationTime":1.511256995939E12,
        "sourceSystem":"Cloud Commerce",
        "gwpMarkers":[
        ],
        "submittedDate":"2017-11-21T09:36:45.088Z",
        "salesChannel":"default",
        "locale":"en",
        "paymentGroups":[
            {
                "amountAuthorized":100,
                "amount":100,
                "gatewayName":"loyaltyPointsPaymentGateway",
                "paymentProps":{
                },
                "submittedDate":"2017-11-21T09:36:43.385Z",
                "authorizationStatus":[
                    {
                        "authorizationDecision":"ACCEPT",
                        "amount":100,
                        "statusProps":{
                        },
                        "transactionSuccess":true,
                        "errorMessage":null,
                        "currency":"USD",
                        "reasonCode":"100",
                        "transactionId":"MERCH-TX-1511257003292"
                    }
                ],
                "iin":"4123",
                "token":"9997000128471543",
                "paymentType":"loyaltyPoints",
                "paymentMethod":"customCurrencyPaymentGroup",
                "id":"pg30507",
                "billingAddress":{
                    "lastName":"Anderson",
                    "country":"US",
                    "address3":"",
                    "address2":"",
                    "city":"Syracuse",
                    "prefix":"",
                    "address1":"21 Cedar Ave",
                    "postalCode":"13202",
                    "companyName":"",
                    "jobTitle":"",
                    "county":"",
                    "suffix":"",
                    "ownerId":null,
                    "firstName":"Kim",
                    "phoneNumber":"212-555-1977",
                    "faxNumber":"",
                    "middleName":"",
                    "state":"NY",
                    "email":"kim@example.com"
                },
                "state":"AUTHORIZED",
                "debitStatus":[
                ],
                "currencyCode":"L10174"
            },
            {
                "amountAuthorized":12.28,
                "amount":12.28,
                "paymentMethod":"tokenizedCreditCard",
                "id":"pg30508",
                "billingAddress":{
                    "lastName":"Test",
                    "country":"US",
                    "address3":null,
                    "address2":null,
                    "city":"Montgomery",
                    "prefix":null,
                    "address1":"Line 1",
                    "postalCode":"36123",
                    "companyName":null,
                    "jobTitle":null,
                    "county":null,
                    "suffix":null,
                    "ownerId":null,
                    "firstName":"Steve",
                    "phoneNumber":"45454545",
                    "faxNumber":null,
                    "middleName":null,
                    "state":"AL",
                    "email":"steve.test@oracle.com"
                },
                "currencyCode":"USD"
            }
        ],
        "configuratorId":"36379716",
        "payTaxInSecondaryCurrency":true,
        "organizationId":null,
        "relationships":[
            {
                "paymentGroupId":"pg30507",
                "amount":100,
                "relationshipType":"ORDERAMOUNT",
                "id":"r40528"
            },
            {
                "paymentGroupId":"pg30508",
                "amount":12.28,
                "relationshipType":"ORDERAMOUNT",
                "id":"r40529"
            }
        ],
        "priceInfo":{
            "secondaryCurrencyTaxAmount":3.88,
            "discounted":false,
            "frequencyAmountTotals":{
            },
            "secondaryCurrencyShippingAmount":8.4,
            "amount":100,
            "secondaryCurrencyTotal":12.28,
            "manualAdjustmentTotal":0,
            "discountAmount":0,
            "tax":9.7,
            "rawSubtotal":100,
            "frequencyTaxTotals":{
            },
            "total":130.7,
            "shipping":21,
            "primaryCurrencyTotal":100,
            "amountIsFinal":false,
            "currencyCode":"L10174"
        },
        "catalogId":null,
        "exchangeRate":0.4,
        "totalCommerceItemCount":1,
        "id":"o30465",
        "state":"SUBMITTED",
        "externalContext":false,
        "quoteInfo":{
            "providerNote":"Approved the quote",
            "rejectionDate":null,
            "requestDate":"2017-11-23T11:29:40.000Z",
            "errorInfo":null,
            "externalId":null,
            "rejectionNote":null,
            "quoteDate":"2017-11-23T11:29:41.000Z",
            "expirationDate":"2029-05-31T00:55:57.000Z",
            "requesterNote":"Please give Discount"
        },
        "taxCalculated":true,
        "commerceItems":[
            {
                "deactivationDate":null,
                "returnedQuantity":0,
                "availabilityDate":null,
                "externalData":[
                ],
                "billingProfileId":null,
                "billingAccountId":null,
                "preOrderQuantity":0,
                "assetKey":null,
                "priceInfo":{
                    "discounted":false,
                    "amount":100,
                    "secondaryCurrencyShippingSurcharge":4,
                    "rawTotalPrice":100,
                    "salePrice":0,
                    "priceListId":"priceListGroup_1511256910174_listPrices",
                    "quantityDiscounted":0,
                    "amountIsFinal":false,
                    "onSale":false,
                    "shippingSurcharge":10,
                    "discountable":true,
                    "currentPriceDetailsSorted":[
                        {
                            "secondaryCurrencyTaxAmount":3.2,
                            "discounted":false,
                            "amount":100,
                            "quantity":1,
                            "amountIsFinal":false,
                            "range":{
                                "lowBound":0,
                                "highBound":0,
                                "size":1
                            },
                            "tax":8,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":100,
                            "currencyCode":"L10174"
                        }
                    ],
                    "currencyCode":"L10174",
                    "listPrice":100
                },
                "catalogId":null,
                "assetId":null,
                "externalRecurringChargeDetails":null,
                "externalPriceDetails":{
                    "externalPriceQuantity":1,
                    "externalPrice":100
                },
                "actionCode":null,
                "id":"ci3000500",
                "serviceId":null,
                "commerceItems":[
                    {
                        "quantity":1,
                        "productId":"prod10037",
                        "catRefId":"sku10043",
                        "configuratorId":"conf10002",
                        "commerceItems":[
                            {
                                "quantity":1,
                                "productId":"Product_27Fxyzii",
                                "catRefId":"Sku_27Gxyzii"
                            }
                        ]
                    }
                ],
                "serviceAccountId":null,
                "quantity":1,
                "productId":"Product_1511256910174",
                "parentAssetKey":null,
                "externalId":null,
                "rootAssetKey":null,
                "transactionDate":null,
                "catalogRefId":"Sku_1511256910174",
                "customerAccountId":null,
                "recurringChargePriceInfo":null,
                "lineAttributes":[
                ],
                "catalogKey":null,
                "productDisplayName":"Product_1511256910171",
                "asset":false,
                "activationDate":null,
                "backOrderQuantity":0
            }
        ],
        "taxPriceInfo":{
            "secondaryCurrencyTaxAmount":3.88,
            "discounted":false,
            "valueAddedTax":0,
            "amount":9.7,
            "countyTax":10.85,
            "isTaxIncluded":false,
            "miscTax":0,
            "districtTax":0,
            "stateTax":10.85,
            "miscTaxInfo":{
            },
            "countryTax":0,
            "cityTax":0,
            "amountIsFinal":false,
            "currencyCode":"L10174"
        },
        "shippingGroups":[
            {
                "shippingMethod":"groundShippingMethod",
                "description":"sg40492",
                "submittedDate":null,
                "priceInfo":{
                    "secondaryCurrencyTaxAmount":0.68,
                    "discounted":false,
                    "shippingTax":1.7,
                    "secondaryCurrencyShippingAmount":8.4,
                    "amount":21,
                    "rawShipping":11,
                    "amountIsFinal":false,
                    "currencyCode":"L10174"
                },
                "shipOnDate":null,
                "actualShipDate":null,
                "specialInstructions":{
                },
                "shippingAddress":{
                    "lastName":"Anderson",
                    "country":"US",
                    "address3":"",
                    "address2":"",
                    "city":"Syracuse",
                    "prefix":"",
                    "address1":"21 Cedar Ave",
                    "postalCode":"13202",
                    "companyName":"",
                    "jobTitle":"",
                    "county":"",
                    "suffix":"",
                    "ownerId":null,
                    "firstName":"Kim",
                    "phoneNumber":"212-555-1977",
                    "faxNumber":"",
                    "middleName":"",
                    "state":"NY",
                    "email":"kim@example.com"
                },
                "commerceItemRelationships":[
                    {
                        "commerceItemId":"ci3000500",
                        "amount":0,
                        "quantity":1,
                        "relationshipType":"SHIPPINGQUANTITY",
                        "returnedQuantity":0,
                        "range":{
                            "lowBound":0,
                            "highBound":0,
                            "size":1
                        },
                        "commerceItemExternalId":null,
                        "state":"INITIAL",
                        "id":"r40526"
                    }
                ],
                "state":"INITIAL",
                "id":"sg40492",
                "stateDetail":null,
                "trackingNumber":null,
                "handlingInstructions":[
                ],
                "shippingGroupClassType":"hardgoodShippingGroup"
            }
        ],
        "freezeDate":null,
        "taxExempt":false,
        "profile":{
            "lastName":"test",
            "firstName":"test",
            "loyaltyPrograms":[
            ],
            "shippingAddress":{
                "country":"US",
                "phoneNumber":"9700707812",
                "address3":"",
                "address2":"IND#56789",
                "city":"BOSTON",
                "address1":"11C Great Medow LN",
                "postalCode":"02201",
                "county":"",
                "state":"MA"
            },
            "middleName":null,
            "customProperty1":null,
            "customProperty2":null,
            "parentOrganization":null,
            "email":"test1511256994101@user.com"
        },
        "approverMessages":[
        ],
        "customProperty1":null,
        "paymentInitiatedEmailSent":false,
        "customProperty2":null,
        "payShippingInSecondaryCurrency":true,
        "shippingGroupCount":1,
        "taxExemptionCode":null,
        "paymentGroupCount":2,
        "originOfOrder":"punchOut",
        "recurringChargePriceInfo":null,
        "profileId":"110352",
        "organization":null,
        "siteId":"siteUS",
        "activeQuoteOrderId":null
    }
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : order
Type: object
Show Source
Nested Schema : site
Type: object
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed
Show Source
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
The implicit order discounts with the order.
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
The unclaimed coupons with the order.
Show Source
Nested Schema : coupon_code
Type: array
Coupon Code, corresponding to which promotions were applied
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 : coupon_code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon_code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : commerceItems
Type: array
The commerce items (sometimes referred to as "line items") represent which actual skus are included in the order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.
Show Source
Nested Schema : paymentGroups
Type: array
The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
Show Source
Nested Schema : priceInfo
Type: object
Pricing information, an instance of OrderPriceInfo.
Show Source
Nested Schema : profile
Type: object
Basic profile information. (read-only)
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : shippingGroups
Type: array
Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
Nested Schema : items
Type: object
Show Source