1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Webhook
  4. Appeasement Validation

appeasementValidation

post

/ccadmin/v1/webhook/appeasementValidation

This webhook is invoked when an appeasement is submitted in OCC, to validate it with an external system. The external system responds whether this appeasement is valid. If the external system responds that the appeasement is invalid, then the appeasement submission throws a 400 error with the reason for validation failure provided by the external system.

Request

Supported Media Types
Body ()
The request payload contains complete details about the current appeasement, agent's profile, order and profile against which the appeasement is being provided, returns related to the order, previous appeasements related to the profile either directly or indirectly through orders, site and organization on which the appeasement is being submitted. By default only the latest 50 previous appeasements of that order are included in the payload.
Root Schema : appeasementValidation_request
Type: object
The request payload contains complete details about the current appeasement, agent's profile, order and profile against which the appeasement is being provided, returns related to the order, previous appeasements related to the profile either directly or indirectly through orders, site and organization on which the appeasement is being submitted. By default only the latest 50 previous appeasements of that order are included in the payload.
Show Source
Example:
{
    "appeasement":{
        "reason":{
            "readableDescription":"Item Arrived Damaged",
            "id":"itemArrivedDamaged"
        },
        "agentId":"service",
        "notes":"Customer complained that the order has arrived damaged, and asked for a refund. Providing 15 USD.",
        "orderId":"o30444",
        "damagedLineItemId":"ci123547",
        "lastModifiedDate":"2020-04-05T15:52:22.622Z",
        "appeasementRefunds":[
            {
                "paymentGroupId":null,
                "refundType":"externalRefund",
                "amount":5,
                "customerPreferredGiftCardId":null,
                "id":"3200006",
                "state":"INCOMPLETE",
                "currencyCode":"USD"
            },
            {
                "paymentGroupId":"pg123434",
                "refundType":"externalRefund",
                "amount":10,
                "customerPreferredGiftCardId":null,
                "id":"3200007",
                "state":"INCOMPLETE",
                "currencyCode":"USD"
            }
        ],
        "submittedDate":"2020-04-05T15:52:22.622Z",
        "type":{
            "displayName":"Order",
            "description":"Appeasement to be applied on a given order",
            "id":"order"
        },
        "creationDate":"2020-04-05T15:52:22.622Z",
        "profileId":"120222",
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccagentui/v1/appeasements/submit"
            }
        ],
        "state":"SUBMITTED",
        "id":"app370003",
        "originOfAppeasement":"agent"
    },
    "site":{
        "name":"Commerce Cloud Site",
        "id":"siteUS",
        "url":"http://blr2213262.in.oracle.com:8080"
    },
    "agentInfo":{
        "firstName":"Damon",
        "lastName":"Weber",
        "roles":[
            {
                "name":"CS Agent Supervisor",
                "description":"CS Agent Supervisor Role",
                "id":"csAgentSupervisorRole",
                "accessRights":[
                ],
                "category":"Agent App"
            }
        ],
        "id":"service",
        "email":"damon.weber@example.com"
    },
    "profile":{
        "lastPurchaseDate":"2020-03-31T10:04:07.140Z",
        "dynamicPropertyMapLong":{
        },
        "GDPRProfileP13nConsentDate":null,
        "GDPRProfileP13nConsentGranted":false,
        "secondaryAddresses":{
            "Office":{
                "country":"US",
                "lastName":"Anderson",
                "address3":"",
                "city":"Los Angeles",
                "address2":"Street 32",
                "prefix":"",
                "address1":"Oracle Office",
                "postalCode":"90001",
                "companyName":"",
                "county":"LA",
                "suffix":"",
                "firstName":"Jim",
                "phoneNumber":"9123284734",
                "item-id":null,
                "repositoryId":"130231",
                "faxNumber":"",
                "middleName":"",
                "state":"CA"
            },
            "home":{
                "country":"US",
                "lastName":"Anderson",
                "address3":"",
                "city":"Los Angeles",
                "address2":"",
                "prefix":"",
                "address1":"Down street 31",
                "postalCode":"90001",
                "companyName":"",
                "county":"LA",
                "suffix":"",
                "firstName":"Jim",
                "phoneNumber":"91243667889800",
                "item-id":null,
                "repositoryId":"130230",
                "faxNumber":"",
                "middleName":"",
                "state":"CA"
            }
        },
        "shippingSurchargePriceList":null,
        "firstPurchaseDate":"2020-03-31T10:04:07.140Z",
        "profileType":null,
        "loyaltyPrograms":[
        ],
        "lastPurchaseAmount":136.47,
        "registrationDate":"2020-03-31T10:00:10.790Z",
        "sessionOrganization":null,
        "lifetimeAOV":136.47,
        "id":"120222",
        "derivedSalePriceList":null,
        "homeAddress":{
            "country":null,
            "lastName":null,
            "address3":null,
            "city":null,
            "address2":null,
            "prefix":null,
            "address1":null,
            "postalCode":null,
            "companyName":null,
            "county":null,
            "suffix":null,
            "firstName":null,
            "phoneNumber":null,
            "item-id":null,
            "repositoryId":"130224",
            "faxNumber":null,
            "middleName":null,
            "state":null
        },
        "daytimeTelephoneNumber":null,
        "customerContactId":null,
        "taxExempt":false,
        "dynamicPropertyMapBigString":{
        },
        "active":true,
        "lastVisitDate":null,
        "taxExemptionCode":null,
        "previousVisitDate":null,
        "version":11,
        "abandonedOrderCount":0,
        "firstName":"Jim",
        "defaultCreditCard":null,
        "lifetimeCurrencyCode":"USD",
        "derivedTaxExemptionCode":null,
        "currentOrganization":null,
        "secondaryOrganizations":[
        ],
        "shippingAddresses":[
            {
                "country":"US",
                "lastName":"Anderson",
                "address3":"",
                "city":"Los Angeles",
                "address2":"",
                "prefix":"",
                "address1":"Down street 31",
                "postalCode":"90001",
                "companyName":"",
                "county":"LA",
                "suffix":"",
                "firstName":"Jim",
                "phoneNumber":"91243667889800",
                "item-id":null,
                "repositoryId":"130230",
                "faxNumber":"",
                "middleName":"",
                "state":"CA"
            },
            {
                "country":"US",
                "lastName":"Anderson",
                "address3":"",
                "city":"Los Angeles",
                "address2":"Street 32",
                "prefix":"",
                "address1":"Oracle Office",
                "postalCode":"90001",
                "companyName":"",
                "county":"LA",
                "suffix":"",
                "firstName":"Jim",
                "phoneNumber":"9123284734",
                "item-id":null,
                "repositoryId":"130231",
                "faxNumber":"",
                "middleName":"",
                "state":"CA"
            }
        ],
        "derivedPriceListGroup":null,
        "lastName":"Anderson",
        "roles":[
        ],
        "numberOfOrders":1,
        "locale":"en",
        "login":"jim.anderson@example.com",
        "receiveEmailDate":"2020-03-31T10:00:10.290Z",
        "sitePropertiesList":[
            {
                "site":{
                    "id":"siteUS"
                },
                "properties":{
                    "numberOfVisits":0,
                    "GDPRProfileP13nConsentDate":null,
                    "GDPRProfileP13nConsentGranted":false,
                    "receiveEmail":"yes",
                    "receiveEmailDate":"2020-03-31T10:00:10.290Z"
                }
            }
        ],
        "lifetimeSpend":136.47,
        "dynamicPropertyMapString":{
        },
        "email":"jim.anderson@example.com",
        "numberOfVisits":0,
        "siteProperties":{
            "siteUS":{
                "numberOfVisits":0,
                "GDPRProfileP13nConsentDate":null,
                "GDPRProfileP13nConsentGranted":false,
                "receiveEmail":"yes",
                "receiveEmailDate":"2020-03-31T10:00:10.290Z"
            }
        },
        "comments":[
            {
                "owner":"120222",
                "agent":"service",
                "item-id":"/atg/userprofiling/ProfileAdapterRepository_production/agentComment/100001",
                "comment":"Note: This is a VIP customer.",
                "id":"100001",
                "creationDate":"2020-03-31T10:03:45.111Z",
                "version":1
            }
        ],
        "receiveEmail":"yes",
        "priceListGroup":null,
        "dateOfBirth":null,
        "shippingAddress":{
            "country":"US",
            "lastName":"Anderson",
            "address3":"",
            "city":"Los Angeles",
            "address2":"",
            "prefix":"",
            "address1":"Down street 31",
            "postalCode":"90001",
            "companyName":"",
            "county":"LA",
            "suffix":"",
            "firstName":"Jim",
            "phoneNumber":"91243667889800",
            "item-id":null,
            "repositoryId":"130230",
            "faxNumber":"",
            "middleName":"",
            "state":"CA"
        },
        "firstVisitDate":null,
        "middleName":null,
        "lastActivity":"2020-03-31T10:00:10.836Z",
        "billingAddress":null,
        "dynamicPropertyMapDouble":{
        },
        "derivedShippingSurchargePriceList":null,
        "abandonedOrders":[
        ]
    },
    "previousAppeasements":[
        {
            "reason":{
                "readableDescription":"Order Arrived Late",
                "key":"orderArrivedLate"
            },
            "agentId":"service",
            "notes":"Customer complained that the order has arrived late, and asked for a refund of shipping amount. Providing 25 USD.",
            "orderId":"o30556",
            "damagedLineItemId":null,
            "lastModifiedDate":"2020-04-05T15:52:22.622Z",
            "preferredGiftCardId":null,
            "appeasementRefunds":[
                {
                    "paymentGroupId":null,
                    "refundType":"externalRefund",
                    "amount":10,
                    "customerPreferredGiftCardId":null,
                    "id":"283723",
                    "state":"INCOMPLETE",
                    "currencyCode":"USD"
                },
                {
                    "paymentGroupId":"pg1223",
                    "refundType":"externalRefund",
                    "amount":15,
                    "customerPreferredGiftCardId":null,
                    "id":"329382",
                    "state":"INCOMPLETE",
                    "currencyCode":"USD"
                }
            ],
            "submittedDate":"2020-04-05T15:52:22.622Z",
            "type":{
                "displayName":"Order",
                "description":"Appeasement to be applied on a given order",
                "key":"order"
            },
            "creationDate":"2020-04-05T15:52:22.622Z",
            "profileId":"120222",
            "links":[
                {
                    "rel":"self",
                    "href":"http://localhost:9080/ccagentui/v1/appeasements/submit"
                }
            ],
            "state":"SUBMITTED",
            "id":"app74957",
            "originOfAppeasement":"contactCenter"
        }
    ],
    "returnsRelatedToOrder":[
        {
            "agentId":"service",
            "authorizationDate":"2020-03-31T10:12:55.672Z",
            "refundSubtotal":58.49,
            "refundMethodList":[
                {
                    "refundType":"manualRefund",
                    "amount":58.49,
                    "maximumRefundAmount":-1
                }
            ],
            "allocatedAmount":58.49,
            "suggestedShippingRefund":12.5,
            "returnPaymentState":"Refund",
            "processName":"Return",
            "processImmediately":false,
            "orderCurrencyCode":"USD",
            "returnAdjustedOrderId":null,
            "returnCalculationOrder":null,
            "state":"COMPLETE",
            "unAdjustedRefundSubtotal":45.99,
            "returnItemCount":1,
            "trackingNumber":null,
            "totalOrderPromotionValueAdjustmentChange":0,
            "comments":null,
            "suggestedTaxRefund":0,
            "nonReturnItemCostAdjustments":[
            ],
            "actualShippingRefund":12.5,
            "otherRefund":0,
            "actualTaxRefund":0,
            "totalItemRefund":45.99,
            "processed":false,
            "returnLabel":null,
            "authorizationNumber":"100003",
            "returningItems":true,
            "replacingItems":false,
            "returnFee":0,
            "exchangeProcess":false,
            "totalReturnItemRefund":45.99,
            "submitExchangeAllowed":false,
            "totalRefundAmount":58.49,
            "originOfReturn":"contactCenter",
            "unallocatedAmount":0,
            "additionalProperties":{
            },
            "nonReturnItemSubtotalAdjustment":0,
            "originatingOrderId":"o30444",
            "replaceItemCount":0,
            "adjustmentAmount":12.5,
            "returnItemList":[
                {
                    "quantityReturned":1,
                    "quantityToReturn":1,
                    "quantityAvailable":0,
                    "returnItemId":"100003",
                    "suggestedTaxRefundShare":0,
                    "quantityToExchange":0,
                    "itemCurrencyCode":"USD",
                    "shippingGroupId":"sg40460",
                    "description":null,
                    "catalogRefId":"Sku_22Dxy",
                    "suggestedShippingRefundShare":12.5,
                    "commerceItemId":"ci3000473",
                    "disposition":"acceptedWithRefund",
                    "quantityShipped":0,
                    "returnReason":"incorrectColor",
                    "itemCostAdjustments":[
                        {
                            "commerceItemId":"ci3000473",
                            "shippingGroupId":"sg40460",
                            "amountAdjustment":-45.99,
                            "shippingShareAdjustment":0,
                            "quantityAdjusted":1,
                            "orderDiscountShareAdjustment":0,
                            "manualAdjustmentShareAdjustment":0,
                            "taxShareAdjustment":0
                        },
                        {
                            "commerceItemId":"ci3000473",
                            "shippingGroupId":"sg40460",
                            "amountAdjustment":0,
                            "shippingShareAdjustment":-12.5,
                            "quantityAdjusted":0,
                            "orderDiscountShareAdjustment":0,
                            "manualAdjustmentShareAdjustment":0,
                            "taxShareAdjustment":0
                        }
                    ],
                    "actualShippingRefundShare":12.5,
                    "suggestedRefundAmount":45.99,
                    "actualTaxRefundShare":0,
                    "quantityReceived":1,
                    "refundAmount":45.99
                }
            ]
        }
    ],
    "order":{
        "gwp":false,
        "secondaryCurrencyCode":null,
        "submittedDate":"2020-03-31T10:07:18.000Z",
        "salesChannel":"default",
        "configuratorId":null,
        "uuid":"1fbd6870-3d45-43bf-9034-e924253a22a2",
        "organizationId":null,
        "relationships":[
            {
                "paymentGroupId":"pg30494",
                "amount":36.47,
                "relationshipType":"ORDERAMOUNT",
                "id":"r40638"
            },
            {
                "paymentGroupId":"pg30495",
                "amount":100,
                "relationshipType":"ORDERAMOUNT",
                "id":"r40639"
            }
        ],
        "exchangeRate":null,
        "id":"o30444",
        "state":"SUBMITTED",
        "taxCalculated":false,
        "combinedPriceInfos":null,
        "commerceItems":[
            {
                "deactivationDate":null,
                "returnedQuantity":0,
                "availabilityDate":null,
                "billingProfileId":null,
                "externalData":[
                ],
                "billingAccountId":null,
                "preOrderQuantity":0,
                "assetKey":null,
                "commerceItemId":"ci3000473",
                "priceInfo":{
                    "discounted":false,
                    "amount":91.98,
                    "secondaryCurrencyShippingSurcharge":0,
                    "rawTotalPrice":91.98,
                    "salePrice":0,
                    "orderDiscountInfos":[
                    ],
                    "priceListId":"listPrices",
                    "quantityDiscounted":0,
                    "amountIsFinal":false,
                    "onSale":false,
                    "shippingSurcharge":0,
                    "discountable":true,
                    "currentPriceDetailsSorted":[
                        {
                            "secondaryCurrencyTaxAmount":0,
                            "discounted":false,
                            "amount":91.98,
                            "quantity":2,
                            "amountIsFinal":false,
                            "range":{
                                "lowBound":0,
                                "highBound":1,
                                "size":2
                            },
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":45.99,
                            "currencyCode":"USD"
                        }
                    ],
                    "currencyCode":"USD",
                    "listPrice":45.99
                },
                "catalogId":null,
                "externalRecurringChargeDetails":null,
                "externalPriceDetails":null,
                "actionCode":null,
                "id":"ci3000473",
                "state":"INITIAL",
                "serviceId":null,
                "locationInventoryInfoMap":{
                },
                "serviceAccountId":null,
                "quantity":2,
                "pointOfNoRevision":false,
                "productId":"Product_22Cxyi",
                "parentAssetKey":null,
                "externalId":null,
                "originalCommerceItemId":null,
                "rootAssetKey":null,
                "transactionDate":null,
                "catalogRefId":"Sku_22Dxy",
                "customerAccountId":null,
                "recurringChargePriceInfo":null,
                "lineAttributes":[
                ],
                "catalogKey":null,
                "productDisplayName":"Hannah Montana - Season 1",
                "shopperInput":{
                },
                "activationDate":null,
                "asset":false,
                "backOrderQuantity":0
            },
            {
                "deactivationDate":null,
                "returnedQuantity":0,
                "availabilityDate":null,
                "billingProfileId":null,
                "externalData":[
                ],
                "billingAccountId":null,
                "preOrderQuantity":0,
                "assetKey":null,
                "commerceItemId":"ci3000474",
                "priceInfo":{
                    "discounted":false,
                    "amount":14.99,
                    "secondaryCurrencyShippingSurcharge":0,
                    "rawTotalPrice":14.99,
                    "salePrice":0,
                    "orderDiscountInfos":[
                    ],
                    "priceListId":"listPrices",
                    "quantityDiscounted":0,
                    "amountIsFinal":false,
                    "onSale":false,
                    "shippingSurcharge":0,
                    "discountable":true,
                    "currentPriceDetailsSorted":[
                        {
                            "secondaryCurrencyTaxAmount":0,
                            "discounted":false,
                            "amount":14.99,
                            "quantity":1,
                            "amountIsFinal":false,
                            "range":{
                                "lowBound":0,
                                "highBound":0,
                                "size":1
                            },
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":14.99,
                            "currencyCode":"USD"
                        }
                    ],
                    "currencyCode":"USD",
                    "listPrice":14.99
                },
                "catalogId":null,
                "externalRecurringChargeDetails":null,
                "externalPriceDetails":null,
                "actionCode":null,
                "id":"ci3000474",
                "state":"INITIAL",
                "serviceId":null,
                "locationInventoryInfoMap":{
                },
                "serviceAccountId":null,
                "quantity":1,
                "pointOfNoRevision":false,
                "productId":"Product_18Cxi",
                "parentAssetKey":null,
                "externalId":null,
                "originalCommerceItemId":null,
                "rootAssetKey":null,
                "transactionDate":null,
                "catalogRefId":"Sku_18Dxi",
                "customerAccountId":null,
                "recurringChargePriceInfo":null,
                "lineAttributes":[
                ],
                "catalogKey":null,
                "productDisplayName":"Dr. Dolittle",
                "shopperInput":{
                },
                "activationDate":null,
                "asset":false,
                "backOrderQuantity":0
            }
        ],
        "shippingGroups":[
            {
                "shippingMethod":"twoDayShippingMethod",
                "description":"sg40460",
                "submittedDate":null,
                "priceInfo":{
                    "secondaryCurrencyTaxAmount":0,
                    "discounted":false,
                    "shippingTax":0,
                    "secondaryCurrencyShippingAmount":0,
                    "amount":25,
                    "rawShipping":25,
                    "amountIsFinal":false,
                    "currencyCode":"USD"
                },
                "shipOnDate":null,
                "actualShipDate":null,
                "specialInstructions":{
                },
                "shippingAddress":{
                    "country":"US",
                    "lastName":"Anderson",
                    "address3":null,
                    "city":"Los Angeles",
                    "address2":null,
                    "prefix":null,
                    "address1":"Down street 31",
                    "companyName":null,
                    "jobTitle":null,
                    "postalCode":"90001",
                    "county":"LA",
                    "ownerId":null,
                    "suffix":null,
                    "firstName":"Jim",
                    "phoneNumber":"91243667889800",
                    "faxNumber":null,
                    "middleName":null,
                    "state":"CA",
                    "email":"jim.anderson@example.com"
                },
                "commerceItemRelationships":[
                    {
                        "availablePickupDate":null,
                        "inventoryLocationId":null,
                        "amount":0,
                        "quantity":2,
                        "pointOfNoRevision":false,
                        "relationshipType":"SHIPPINGQUANTITY",
                        "returnedQuantity":0,
                        "preferredPickupDate":null,
                        "range":{
                            "lowBound":0,
                            "highBound":1,
                            "size":2
                        },
                        "commerceItemExternalId":null,
                        "commerceItemId":"ci3000473",
                        "state":"INITIAL",
                        "id":"r40634"
                    }
                ],
                "state":"INITIAL",
                "id":"sg40460",
                "stateDetail":null,
                "trackingNumber":null,
                "handlingInstructions":[
                ],
                "shippingGroupClassType":"hardgoodShippingGroup"
            },
            {
                "shippingMethod":"groundShippingMethod",
                "description":"sg40465",
                "submittedDate":null,
                "priceInfo":{
                    "secondaryCurrencyTaxAmount":0,
                    "discounted":false,
                    "shippingTax":0,
                    "secondaryCurrencyShippingAmount":0,
                    "amount":4.5,
                    "rawShipping":4.5,
                    "amountIsFinal":false,
                    "currencyCode":"USD"
                },
                "shipOnDate":null,
                "actualShipDate":null,
                "specialInstructions":{
                },
                "shippingAddress":{
                    "country":"US",
                    "lastName":"Anderson",
                    "address3":null,
                    "city":"Los Angeles",
                    "address2":"Street 32",
                    "prefix":null,
                    "address1":"Oracle Office",
                    "companyName":null,
                    "jobTitle":null,
                    "postalCode":"90001",
                    "county":"LA",
                    "ownerId":null,
                    "suffix":null,
                    "firstName":"Jim",
                    "phoneNumber":"9123284734",
                    "faxNumber":null,
                    "middleName":null,
                    "state":"CA",
                    "email":"jim.anderson@example.com"
                },
                "commerceItemRelationships":[
                    {
                        "availablePickupDate":null,
                        "inventoryLocationId":null,
                        "amount":0,
                        "quantity":1,
                        "pointOfNoRevision":false,
                        "relationshipType":"SHIPPINGQUANTITY",
                        "returnedQuantity":0,
                        "preferredPickupDate":null,
                        "range":{
                            "lowBound":0,
                            "highBound":0,
                            "size":1
                        },
                        "commerceItemExternalId":null,
                        "commerceItemId":"ci3000474",
                        "state":"INITIAL",
                        "id":"r40635"
                    }
                ],
                "state":"INITIAL",
                "id":"sg40465",
                "stateDetail":null,
                "trackingNumber":null,
                "handlingInstructions":[
                ],
                "shippingGroupClassType":"hardgoodShippingGroup"
            }
        ],
        "freezeDate":null,
        "taxExempt":false,
        "profile":{
            "lastName":"Anderson",
            "firstName":"Jim",
            "loyaltyPrograms":[
            ],
            "shippingAddress":{
                "country":"US",
                "lastName":"Anderson",
                "address3":"",
                "city":"Los Angeles",
                "address2":"",
                "prefix":"",
                "address1":"Down street 31",
                "postalCode":"90001",
                "jobTitle":"",
                "companyName":"",
                "county":"LA",
                "ownerId":null,
                "suffix":"",
                "version":4,
                "firstName":"Jim",
                "phoneNumber":"91243667889800",
                "repositoryId":"130230",
                "faxNumber":"",
                "middleName":"",
                "state":"CA",
                "id":"130230"
            },
            "middleName":null,
            "login":"jim.anderson@example.com",
            "parentOrganization":null,
            "email":"jim.anderson@example.com"
        },
        "queuedOrderSubmitData":null,
        "cartName":"o30444",
        "paymentInitiatedEmailSent":false,
        "payShippingInSecondaryCurrency":null,
        "shippingGroupCount":2,
        "taxExemptionCode":null,
        "createdByOrderId":null,
        "orderAction":"order",
        "submissionErrorMessages":[
        ],
        "profileId":"120222",
        "activeQuoteOrderId":null,
        "approverIds":[
        ],
        "agentId":"service",
        "lastModifiedTime":1.585649238E12,
        "priceGroupId":"defaultPriceGroup",
        "creationTime":1.585649047E12,
        "sourceSystem":"Cloud Commerce",
        "gwpMarkers":[
        ],
        "locale":"en",
        "paymentGroups":[
            {
                "paymentGroupClassType":"physicalGiftCard",
                "amountAuthorized":36.47,
                "amount":36.47,
                "gatewayName":"chaseGiftCard",
                "paymentProps":{
                    "retryTrace":"4941585649237824"
                },
                "paymentMethod":"physicalGiftCard",
                "state":"AUTHORIZED",
                "id":"pg30494",
                "submittedDate":"2020-03-31T10:07:17.000Z",
                "debitStatus":[
                ],
                "authorizationStatus":[
                    {
                        "amount":36.47,
                        "statusProps":{
                            "RespCode":"00",
                            "AuthCode":"025322",
                            "TerminalID":"001",
                            "responseMsg":"Approved"
                        },
                        "transactionSuccess":true,
                        "errorMessage":null,
                        "externalStatusProps":[
                        ],
                        "transactionId":"55B921ABC20A72FAC0212F0B42A6DECE65E05359",
                        "transactionTimestamp":"2020-03-31T10:07:17.000Z"
                    }
                ],
                "currencyCode":"USD"
            },
            {
                "expirationYear":"2022",
                "amountAuthorized":100,
                "amount":100,
                "gatewayName":"chaseCreditCard",
                "paymentProps":{
                    "OrbitalOrderID":"771F-o30444",
                    "retryTrace":"4951585649237953"
                },
                "expirationMonth":"02",
                "submittedDate":"2020-03-31T10:07:18.000Z",
                "authorizationStatus":[
                    {
                        "amount":100,
                        "statusProps":{
                            "RespCode":"00",
                            "cvvRespCode":"M",
                            "AuthCode":"tst953",
                            "RespTime":"014936",
                            "TerminalID":"001",
                            "responseMsg":"Approved"
                        },
                        "transactionSuccess":true,
                        "errorMessage":null,
                        "transactionId":"55BB0C6FC76AC30CAF122089ED81701D77D4538E"
                    }
                ],
                "IIN":"411111",
                "paymentGroupClassType":"creditCard",
                "creditCardNumber":"1111",
                "paymentMethod":"creditCard",
                "state":"AUTHORIZED",
                "id":"pg30495",
                "billingAddress":{
                    "country":"US",
                    "lastName":"Anderson",
                    "address3":null,
                    "city":"Los Angeles",
                    "address2":null,
                    "prefix":null,
                    "address1":"Down street 31",
                    "companyName":null,
                    "jobTitle":null,
                    "postalCode":"90001",
                    "county":"LA",
                    "ownerId":null,
                    "suffix":null,
                    "firstName":"Jim",
                    "phoneNumber":"91243667889800",
                    "faxNumber":null,
                    "middleName":null,
                    "state":"CA",
                    "email":"jim.anderson@example.com"
                },
                "debitStatus":[
                ],
                "currencyCode":"USD"
            }
        ],
        "payTaxInSecondaryCurrency":null,
        "priceInfo":{
            "secondaryCurrencyTaxAmount":0,
            "discounted":false,
            "secondaryCurrencyShippingAmount":0,
            "amount":106.97,
            "secondaryCurrencyTotal":0,
            "manualAdjustmentTotal":0,
            "discountAmount":0,
            "tax":0,
            "rawSubtotal":106.97,
            "total":136.47,
            "shipping":29.5,
            "primaryCurrencyTotal":106.97,
            "amountIsFinal":false,
            "currencyCode":"USD"
        },
        "submissionProgress":[
        ],
        "catalogId":null,
        "totalCommerceItemCount":3,
        "externalContext":false,
        "cancelReason":null,
        "quoteInfo":null,
        "taxPriceInfo":{
            "secondaryCurrencyTaxAmount":0,
            "discounted":false,
            "valueAddedTax":0,
            "amount":0,
            "countyTax":0,
            "isTaxIncluded":false,
            "miscTax":0,
            "districtTax":0,
            "stateTax":0,
            "miscTaxInfo":{
            },
            "countryTax":0,
            "cityTax":0,
            "amountIsFinal":false,
            "currencyCode":"USD"
        },
        "lastModifiedDate":"2020-03-31T10:07:18.000Z",
        "approvalSystemMessages":[
        ],
        "approverMessages":[
        ],
        "paymentGroupCount":2,
        "submissionErrorCodes":[
        ],
        "recurringChargePriceInfo":null,
        "organization":null,
        "siteId":"siteUS"
    }
}
Nested Schema : agentInfo
Type: object
Show Source
Nested Schema : appeasement
Type: object
Details of an appeasement
Show Source
Nested Schema : order
Type: object
The current order representation.
Show Source
Nested Schema : organization
Type: object
Show Source
Nested Schema : previousAppeasements
Type: array
Show Source
Nested Schema : profile
Type: object
Complete details of a profile
Show Source
Nested Schema : returnsRelatedToOrder
Type: array
Show Source
  • returnRequest
    Complete details of a ReturnRequest, except the properties - relatedReplacementOrders, replacementOrder, originatingOrder, profile
Nested Schema : site
Type: object
Show Source
Nested Schema : roles
Type: array
Array of roles assigned to this profile.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : accessRights
Type: array
Array of accessRights assigned to this role.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : appeasementRefunds
Type: object
Properties of the appeasemen refund.
Show Source
Nested Schema : reason
Type: object
Reason used for the appeasement. Detailed information
Show Source
Nested Schema : type
Type: object
Type of appeasement, among the configured appeasement type in the system.
Show Source
Nested Schema : discountInfo
Type: object
Discount Information
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
giftWithPurchaseOrderMarker information.
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
Nested Schema : priceListGroup
Type: object
The price list group object.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping Method information of the order.
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information.
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
Implicit Promotions for the order
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
The coupons that were not claimed
Show Source
Nested Schema : couponCode
Type: array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: object
Coupon Code.
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 : items
Type: array
The array of products in the shipping group.
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
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
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: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
giftWithPurchaseCommerceItemMarker information.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator 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 : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
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 : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : comments
Type: array
the notes on the customer.
Show Source
Nested Schema : currentOrganization
Type: object
The current Organization
Show Source
Nested Schema : derivedPriceListGroup
Type: object
Show Source
Nested Schema : derivedSalePriceList
Type: object
Show Source
Nested Schema : derivedShippingSurchargePriceList
Type: object
Show Source
Nested Schema : homeAddress
Type: object
Home address
Show Source
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : priceListGroup
Type: object
Show Source
Nested Schema : relativeTo
Type: array
If not provided organization id will be cosidered as its parent organization ID.
Show Source
Nested Schema : roles
Type: array
List of user roles.
Show Source
Nested Schema : secondaryOrganizations
Type: array
List of secondary organizations that need to associate with the user.
Show Source
Nested Schema : sessionOrganization
Type: object
The session Organization
Show Source
Nested Schema : shippingAddress
Type: object
Shipping address
Show Source
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Show Source
Nested Schema : sitePropertiesList
Type: array
The list of site related properties for the profile
Show Source
Nested Schema : items
Type: object
The info of the customer
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : listPriceList
Type: object
Show Source
Nested Schema : salePriceList
Type: object
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : listPriceList
Type: object
Show Source
Nested Schema : salePriceList
Type: object
Show Source
Nested Schema : shippingSurchargePriceList
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 : 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
Nested Schema : returnRequest
Type: object
Complete details of a ReturnRequest, except the properties - relatedReplacementOrders, replacementOrder, originatingOrder, profile
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : nonReturnItemCostAdjustments
Type: array
Show Source
Nested Schema : refundMethodList
Type: array
Show Source
Nested Schema : returnItemList
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 : itemCostAdjustments
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : appeasementValidation_response
Type: object
Response indicates whether this appeasement is valid and can be submitted in OCC. If the appeasement is invalid, reason for validation failure would be provided.
Show Source
  • Indicates the reason why this appeasement is invalid. It is mandatory to provide a reason when 8002 is used as the response code. This reason should be user-readable as this is thrown as an error to the end user (i.e., Agent)
  • Response code indicating if the appeasement is valid or invalid. Possible values for ResponseCode: 8001 - indicates that the appeasement is valid. 8002 - indicates that the appeasement is invalid.
Example:
{
    "reasonForValidationFailure":"An appeasement of more than 10 USD cannot be given to this order",
    "responseCode":"8002"
}
Back to Top