returnRequestValidation

post

/ccadmin/v1/webhook/returnRequestValidation

This webhook will get called to validate the return request. The webhook will be called whenever the system needs to determine that the exchange/return is returnable

Request

Supported Media Types
Body ()
This webhook will get triggered wherever we need to test the returnability of the order.
Root Schema : returnRequestValidation_request
Type: object
This webhook will get triggered wherever we need to test the returnability of the order.
Show Source
Example:
{
    "context":"Initiate_Return",
    "returnRequests":[
        {
            "returnItemList":[
                {
                    "quantityToReturn":0,
                    "commerceItemId":"ci3000416",
                    "quantityAvailable":20,
                    "quantityShipped":20,
                    "productId":"Product_27Fxyzii",
                    "nonreturnable":true,
                    "returnReason":null,
                    "shippingGroupId":"sg40414",
                    "catalogRefId":"Sku_27Gxyzii",
                    "nonReturnableReason":"This is a non-returnable item."
                },
                {
                    "quantityToReturn":0,
                    "commerceItemId":"ci3000417",
                    "quantityAvailable":15,
                    "quantityShipped":20,
                    "productId":"Product_36Exy",
                    "nonreturnable":false,
                    "returnReason":null,
                    "shippingGroupId":"sg40414",
                    "catalogRefId":"Sku_36Fxy",
                    "nonReturnableReason":null
                }
            ],
            "order":{
                "approverIds":[
                ],
                "gwp":false,
                "secondaryCurrencyCode":null,
                "lastModifiedTime":1.513930292E12,
                "priceGroupId":"defaultPriceGroup",
                "creationTime":1.50390023E12,
                "sourceSystem":"Cloud Commerce",
                "gwpMarkers":[
                ],
                "salesChannel":"default",
                "submittedDate":"2017-08-28T06:03:51.000Z",
                "locale":"en",
                "paymentGroups":[
                    {
                        "PONumber":"857",
                        "amountAuthorized":1052.56,
                        "amount":1052.56,
                        "paymentMethod":"invoiceRequest",
                        "billingAddress":{
                            "lastName":"Anderson",
                            "country":"US",
                            "firstName":"Kim",
                            "phoneNumber":"212-555-1977",
                            "address2":null,
                            "city":"Syracuse",
                            "address1":"21 Cedar Ave",
                            "postalCode":"13202",
                            "state":"NY",
                            "email":"kim@example.com"
                        },
                        "state":10,
                        "id":"pg30416",
                        "currencyCode":"USD"
                    }
                ],
                "configuratorId":null,
                "organizationId":null,
                "relationships":[
                    {
                        "paymentGroupId":"pg30416",
                        "amount":1052.56,
                        "relationshipType":"ORDERAMOUNTREMAINING",
                        "id":"r40399"
                    }
                ],
                "priceInfo":{
                    "amount":939.6,
                    "total":1052.56,
                    "shipping":35,
                    "discountAmount":0,
                    "tax":77.96,
                    "rawSubtotal":939.6,
                    "currencyCode":"USD"
                },
                "catalogId":null,
                "exchangeRate":null,
                "totalCommerceItemCount":35,
                "id":"o30411",
                "state":"NO_PENDING_ACTION",
                "externalContext":false,
                "quoteInfo":null,
                "taxCalculated":true,
                "commerceItems":[
                    {
                        "deactivationDate":null,
                        "returnedQuantity":0,
                        "availabilityDate":null,
                        "billingProfileId":null,
                        "externalData":[
                        ],
                        "billingAccountId":null,
                        "preOrderQuantity":0,
                        "assetKey":null,
                        "priceInfo":{
                            "discounted":false,
                            "amount":0,
                            "secondaryCurrencyShippingSurcharge":0,
                            "rawTotalPrice":100,
                            "salePrice":80,
                            "priceListId":"salePrices",
                            "quantityDiscounted":0,
                            "amountIsFinal":false,
                            "onSale":true,
                            "shippingSurcharge":0,
                            "discountable":true,
                            "currentPriceDetailsSorted":[
                                {
                                    "secondaryCurrencyTaxAmount":0,
                                    "discounted":false,
                                    "amount":0,
                                    "quantity":1,
                                    "amountIsFinal":false,
                                    "range":{
                                        "lowBound":0,
                                        "highBound":0,
                                        "size":1
                                    },
                                    "orderDiscountShare":0,
                                    "tax":0,
                                    "detailedUnitPrice":0,
                                    "currencyCode":"USD"
                                }
                            ],
                            "currencyCode":"USD",
                            "listPrice":100
                        },
                        "catalogId":null,
                        "assetId":null,
                        "externalRecurringChargeDetails":{
                            "externalRecurringCharge":20,
                            "externalRecurringChargeFrequency":"Monthly",
                            "externalRecurringChargeDuration":"12"
                        },
                        "externalPriceDetails":null,
                        "actionCode":null,
                        "id":"ci3000416",
                        "serviceId":null,
                        "serviceAccountId":null,
                        "quantity":1,
                        "productId":"Product_27Fxyzii",
                        "parentAssetKey":null,
                        "externalId":null,
                        "rootAssetKey":null,
                        "transactionDate":null,
                        "catalogRefId":"Sku_27Gxyzii",
                        "customerAccountId":null,
                        "recurringChargePriceInfo":{
                            "discounted":false,
                            "amount":20,
                            "secondaryCurrencyShippingSurcharge":0,
                            "rawTotalPrice":80,
                            "salePrice":0,
                            "priceListId":null,
                            "quantityDiscounted":0,
                            "amountIsFinal":false,
                            "onSale":false,
                            "shippingSurcharge":0,
                            "discountable":true,
                            "currentPriceDetailsSorted":[
                                {
                                    "secondaryCurrencyTaxAmount":0,
                                    "discounted":false,
                                    "amount":20,
                                    "quantity":1,
                                    "amountIsFinal":false,
                                    "range":{
                                        "lowBound":0,
                                        "highBound":0,
                                        "size":1
                                    },
                                    "orderDiscountShare":0,
                                    "tax":0,
                                    "detailedUnitPrice":20,
                                    "currencyCode":"USD"
                                }
                            ],
                            "currencyCode":"USD",
                            "listPrice":0
                        },
                        "lineAttributes":[
                        ],
                        "productDisplayName":"Sky Blue",
                        "catalogKey":null,
                        "shopperInput":{
                        },
                        "activationDate":null,
                        "asset":false,
                        "backOrderQuantity":0
                    },
                    {
                        "priceInfo":{
                            "amount":439.8,
                            "currencyCode":"USD"
                        },
                        "quantity":15,
                        "productId":"Product_36Exy",
                        "productDisplayName":"The Girl with the Dragon Tattoo",
                        "id":"ci3000417",
                        "catalogRefId":"Sku_36Fxy"
                    }
                ],
                "taxPriceInfo":{
                    "secondaryCurrencyTaxAmount":0,
                    "cityTax":0,
                    "valueAddedTax":0,
                    "amount":77.96,
                    "countyTax":38.98,
                    "isTaxIncluded":false,
                    "miscTax":0,
                    "districtTax":0,
                    "stateTax":38.98,
                    "miscTaxInfo":{
                    },
                    "currencyCode":"USD",
                    "countryTax":0
                },
                "freezeDate":null,
                "shippingGroups":[
                    {
                        "lastName":"Anderson",
                        "shippingMethod":"inStorePickupShippingGroup",
                        "description":"sg40492",
                        "submittedDate":null,
                        "firstName":"Kim",
                        "priceInfo":{
                            "secondaryCurrencyTaxAmount":0.68,
                            "discounted":false,
                            "shippingTax":1.7,
                            "secondaryCurrencyShippingAmount":8.4,
                            "amount":21,
                            "rawShipping":11,
                            "amountIsFinal":false,
                            "currencyCode":"L10174"
                        },
                        "phoneNumber":"212-555-1977",
                        "shipOnDate":null,
                        "actualShipDate":null,
                        "specialInstructions":{
                        },
                        "commerceItemRelationships":[
                            {
                                "availablePickupDate":"2018-05-19T13:00:00.000Z",
                                "commerceItemId":"ci3000500",
                                "inventoryLocationId":"SiteUS-GlenAllen186",
                                "amount":0,
                                "quantity":1,
                                "relationshipType":"SHIPPINGQUANTITY",
                                "returnedQuantity":0,
                                "preferredPickupDate":"2018-05-19T13:00:00.000Z",
                                "range":{
                                    "lowBound":0,
                                    "highBound":0,
                                    "size":1
                                },
                                "commerceItemExternalId":null,
                                "state":"INITIAL",
                                "id":"r40526"
                            }
                        ],
                        "state":"INITIAL",
                        "id":"sg40492",
                        "stateDetail":null,
                        "trackingNumber":null,
                        "email":"kim@example.com",
                        "handlingInstructions":[
                        ],
                        "shippingGroupClassType":"inStorePickupShippingGroup"
                    }
                ],
                "taxExempt":false,
                "profile":{
                    "lastName":"Anderson",
                    "firstName":"Kim",
                    "loyaltyPrograms":[
                    ],
                    "shippingAddress":{
                        "country":"US",
                        "phoneNumber":"212-555-1977",
                        "address3":null,
                        "address2":null,
                        "city":"Syracuse",
                        "address1":"21 Cedar Ave",
                        "postalCode":"13202",
                        "county":null,
                        "state":"NY"
                    },
                    "middleName":null,
                    "parentOrganization":null,
                    "email":"kim@example.com"
                },
                "approverMessages":[
                ],
                "paymentInitiatedEmailSent":false,
                "shippingGroupCount":1,
                "taxExemptionCode":null,
                "paymentGroupCount":1,
                "site":{
                    "productionURL":null,
                    "name":"Commerce Cloud Site",
                    "id":"siteUS"
                },
                "recurringChargePriceInfo":null,
                "profileId":"se-570031",
                "organization":null,
                "siteId":"siteUS",
                "activeQuoteOrderId":null
            }
        }
    ]
}
Nested Schema : agentProfile
Type: object
Show Source
Nested Schema : returnRequests
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : order
Type: object
Show Source
Nested Schema : returnItemList
Type: array
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 : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
the value of the dynamic Properties
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
Show Source
Nested Schema : paymentGroups
Type: array
Show Source
Nested Schema : priceInfo
Type: object
Show Source
Nested Schema : pricingMessages
Type: object
Nested Schema : profile
Type: object
Basic profile information.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : relationships
Type: array
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
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. Depending on the shippingMethod i.e. hardgoodShippingGroups, inStorePickupShippingGroup different proporties will be defined with shippingGroups.
Show Source
Nested Schema : shoppingCart
Type: object
Show Source
Nested Schema : site
Type: object
Site information
Show Source
Nested Schema : taxPriceInfo
Type: object
Show Source
Nested Schema : items
Type: object
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Show Source
Nested Schema : priceInfo
Type: object
Details about pricing.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Details about recurring charge pricing.
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 map values associated with an externalData item.
Show Source
Nested Schema : currentPriceDetailsSorted
Type: array
The current price details.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : range
Type: object
Represents which specific items are covered by this price info.
Show Source
Nested Schema : currentPriceDetailsSorted
Type: array
The current price details.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : range
Type: object
Represents which specific items are covered by this price info.
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
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : authorizationStatus
Type: array
Show Source
Nested Schema : billingAddress
Type: object
Show Source
Nested Schema : debitStatus
Type: array
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 : parentOrganization
Type: object
Parent Organization.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address
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