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

return

post

/ccadmin/v1/webhook/return

This Event is triggered when a return request is initiated

Request

Supported Media Types
Body ()
This Event is triggered when a return request is initiated
Root Schema : return_request
Type: object
This Event is triggered when a return request is initiated
Show Source
Example:
{
    "op":"createExchangeRequest",
    "return":{
        "agentId":"service",
        "authorizationDate":"2018-03-05T13:03:07.698Z",
        "refundSubtotal":25,
        "relatedReplacementOrders":[
            {
                "approverIds":[
                ],
                "gwp":false,
                "secondaryCurrencyCode":null,
                "lastModifiedTime":1.520254987961E12,
                "priceGroupId":"defaultPriceGroup",
                "creationTime":1.520254983031E12,
                "sourceSystem":"Cloud Commerce",
                "gwpMarkers":[
                ],
                "paymentGroups":[
                    {
                        "amountAuthorized":106.25,
                        "amount":25,
                        "paymentMethod":"tokenizedCreditCard",
                        "id":"pg30412",
                        "billingAddress":{
                            "country":"US",
                            "lastName":"MILLER",
                            "address3":null,
                            "city":"Springfield",
                            "address2":null,
                            "prefix":null,
                            "address1":"Address Line 1",
                            "companyName":null,
                            "postalCode":"01144",
                            "jobTitle":null,
                            "county":null,
                            "suffix":null,
                            "ownerId":null,
                            "kumar":null,
                            "firstName":"JESSICA",
                            "phoneNumber":"12345678",
                            "faxNumber":null,
                            "middleName":null,
                            "state":"MA",
                            "email":"JESSICA.MILLER@test.com"
                        },
                        "currencyCode":"USD"
                    }
                ],
                "locale":null,
                "submittedDate":"2018-03-05T13:03:07.537Z",
                "salesChannel":"default",
                "configuratorId":null,
                "payTaxInSecondaryCurrency":null,
                "organizationId":null,
                "priceInfo":{
                    "secondaryCurrencyTaxAmount":0,
                    "discounted":false,
                    "amount":25,
                    "secondaryCurrencyShippingAmount":0,
                    "secondaryCurrencyTotal":0,
                    "manualAdjustmentTotal":0,
                    "discountAmount":0,
                    "tax":0,
                    "rawSubtotal":25,
                    "total":25,
                    "shipping":0,
                    "primaryCurrencyTotal":25,
                    "amountIsFinal":false,
                    "currencyCode":"USD"
                },
                "relationships":[
                    {
                        "paymentGroupId":"pg30412",
                        "amount":25,
                        "relationshipType":"ORDERAMOUNT",
                        "id":"r40386"
                    }
                ],
                "catalogId":null,
                "exchangeRate":null,
                "totalCommerceItemCount":1,
                "id":"o30412",
                "externalContext":false,
                "state":"PENDING_CUSTOMER_RETURN",
                "quoteInfo":null,
                "taxCalculated":false,
                "commerceItems":[
                    {
                        "deactivationDate":null,
                        "returnedQuantity":0,
                        "availabilityDate":null,
                        "externalData":[
                        ],
                        "billingAccountId":null,
                        "preOrderQuantity":0,
                        "assetKey":null,
                        "itemDiscountInfos":[
                        ],
                        "priceInfo":{
                            "discounted":false,
                            "amount":25,
                            "secondaryCurrencyShippingSurcharge":0,
                            "rawTotalPrice":99.99,
                            "salePrice":25,
                            "priceListId":"salePrices",
                            "quantityDiscounted":0,
                            "amountIsFinal":true,
                            "onSale":true,
                            "shippingSurcharge":0,
                            "discountable":true,
                            "currentPriceDetailsSorted":[
                                {
                                    "secondaryCurrencyTaxAmount":0,
                                    "discounted":false,
                                    "amount":25,
                                    "quantity":1,
                                    "amountIsFinal":false,
                                    "range":{
                                        "lowBound":0,
                                        "highBound":0,
                                        "size":1
                                    },
                                    "orderDiscountShare":0,
                                    "tax":0,
                                    "detailedUnitPrice":25,
                                    "currencyCode":"USD"
                                }
                            ],
                            "currencyCode":"USD",
                            "listPrice":99.99
                        },
                        "catalogId":null,
                        "externalRecurringChargeDetails":null,
                        "externalPriceDetails":null,
                        "actionCode":null,
                        "id":"ci3000412",
                        "serviceId":null,
                        "serviceAccountId":null,
                        "quantity":1,
                        "productId":"prod10013",
                        "orderDiscountInfos":[
                        ],
                        "parentAssetKey":null,
                        "externalId":null,
                        "rootAssetKey":null,
                        "transactionDate":null,
                        "catalogRefId":"sku10030",
                        "customerAccountId":null,
                        "recurringChargePriceInfo":null,
                        "lineAttributes":[
                        ],
                        "productDisplayName":"Playstation",
                        "catalogKey":null,
                        "siteId":"siteUS",
                        "shopperInput":{
                        },
                        "activationDate":null,
                        "asset":false,
                        "backOrderQuantity":0
                    }
                ],
                "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":true,
                    "currencyCode":"USD"
                },
                "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"
                    }
                ],
                "freezeDate":null,
                "taxExempt":false,
                "lastModifiedDate":"2018-03-05T13:03:07.961Z",
                "approvalSystemMessages":[
                ],
                "profile":{
                    "lastName":"Anderson",
                    "firstName":"Kim",
                    "loyaltyPrograms":[
                    ],
                    "shippingAddress":{
                        "country":"US",
                        "lastName":"Anderson",
                        "address3":null,
                        "city":"Syracuse",
                        "address2":null,
                        "prefix":null,
                        "address1":"21 Cedar Ave",
                        "companyName":null,
                        "postalCode":"13202",
                        "jobTitle":null,
                        "county":null,
                        "suffix":null,
                        "ownerId":null,
                        "version":2,
                        "kumar":null,
                        "firstName":"Kim",
                        "phoneNumber":"212-555-1977",
                        "repositoryId":"se-980031",
                        "faxNumber":null,
                        "middleName":null,
                        "id":"se-980031",
                        "state":"NY"
                    },
                    "middleName":null,
                    "login":"kim@example.com",
                    "parentOrganization":null,
                    "email":"kim@example.com"
                },
                "approverMessages":[
                ],
                "paymentInitiatedEmailSent":false,
                "payShippingInSecondaryCurrency":null,
                "shippingGroupCount":1,
                "taxExemptionCode":null,
                "paymentGroupCount":1,
                "recurringChargePriceInfo":null,
                "profileId":"se-570031",
                "organization":null,
                "siteId":"siteUS",
                "activeQuoteOrderId":null
            }
        ],
        "refundMethodList":[
            {
                "refundType":"manualRefund",
                "amount":25,
                "maximumRefundAmount":-1
            }
        ],
        "allocatedAmount":25,
        "originatingOrder":{
            "approverIds":[
            ],
            "gwp":false,
            "secondaryCurrencyCode":null,
            "lastModifiedTime":1.520254987918E12,
            "priceGroupId":"defaultPriceGroup",
            "creationTime":1.400515604E12,
            "sourceSystem":"Cloud Commerce",
            "gwpMarkers":[
            ],
            "paymentGroups":[
                {
                    "amountAuthorized":106.25,
                    "amount":106.25,
                    "paymentMethod":"tokenizedCreditCard",
                    "id":"pg10401",
                    "billingAddress":{
                        "country":"US",
                        "lastName":"MILLER",
                        "address3":null,
                        "city":"Springfield",
                        "address2":null,
                        "prefix":null,
                        "address1":"Address Line 1",
                        "companyName":null,
                        "postalCode":"01144",
                        "jobTitle":null,
                        "county":null,
                        "suffix":null,
                        "ownerId":null,
                        "kumar":null,
                        "firstName":"JESSICA",
                        "phoneNumber":"12345678",
                        "faxNumber":null,
                        "middleName":null,
                        "state":"MA",
                        "email":"JESSICA.MILLER@test.com"
                    },
                    "currencyCode":"USD"
                }
            ],
            "locale":null,
            "submittedDate":"2014-05-19T16:06:45.000Z",
            "salesChannel":"default",
            "configuratorId":null,
            "payTaxInSecondaryCurrency":null,
            "organizationId":null,
            "priceInfo":{
                "secondaryCurrencyTaxAmount":0,
                "discounted":false,
                "amount":75,
                "secondaryCurrencyShippingAmount":0,
                "secondaryCurrencyTotal":0,
                "manualAdjustmentTotal":0,
                "discountAmount":0,
                "tax":6.25,
                "rawSubtotal":75,
                "total":106.25,
                "shipping":25,
                "primaryCurrencyTotal":75,
                "amountIsFinal":false,
                "orderTotalBySite":{
                    "siteUS":106.25
                },
                "currencyCode":"USD"
            },
            "relationships":[
                {
                    "paymentGroupId":"pg10401",
                    "amount":106.25,
                    "relationshipType":"ORDERAMOUNTREMAINING",
                    "id":"r10374"
                }
            ],
            "catalogId":null,
            "exchangeRate":null,
            "totalCommerceItemCount":2,
            "id":"o10401",
            "externalContext":false,
            "state":"NO_PENDING_ACTION",
            "quoteInfo":null,
            "taxCalculated":false,
            "commerceItems":[
                {
                    "deactivationDate":null,
                    "returnedQuantity":1,
                    "availabilityDate":null,
                    "externalData":[
                    ],
                    "billingAccountId":null,
                    "preOrderQuantity":0,
                    "assetKey":null,
                    "itemDiscountInfos":[
                    ],
                    "priceInfo":{
                        "discounted":false,
                        "amount":75,
                        "secondaryCurrencyShippingSurcharge":0,
                        "rawTotalPrice":299.97,
                        "salePrice":25,
                        "priceListId":"salePrices",
                        "quantityDiscounted":0,
                        "amountIsFinal":false,
                        "onSale":true,
                        "shippingSurcharge":0,
                        "discountable":true,
                        "currentPriceDetailsSorted":[
                            {
                                "secondaryCurrencyTaxAmount":0,
                                "discounted":false,
                                "amount":75,
                                "quantity":3,
                                "amountIsFinal":false,
                                "range":{
                                    "lowBound":0,
                                    "highBound":2,
                                    "size":3
                                },
                                "orderDiscountShare":0,
                                "tax":6.25,
                                "detailedUnitPrice":25,
                                "currencyCode":"USD"
                            }
                        ],
                        "currencyCode":"USD",
                        "listPrice":99.99
                    },
                    "catalogId":null,
                    "externalRecurringChargeDetails":null,
                    "externalPriceDetails":null,
                    "actionCode":null,
                    "id":"ci1000401",
                    "serviceId":null,
                    "serviceAccountId":null,
                    "quantity":2,
                    "productId":"prod10013",
                    "orderDiscountInfos":[
                    ],
                    "parentAssetKey":null,
                    "externalId":null,
                    "rootAssetKey":null,
                    "transactionDate":null,
                    "catalogRefId":"sku10030",
                    "customerAccountId":null,
                    "recurringChargePriceInfo":null,
                    "lineAttributes":[
                    ],
                    "productDisplayName":"Playstation",
                    "catalogKey":null,
                    "siteId":"siteUS",
                    "shopperInput":{
                    },
                    "activationDate":null,
                    "asset":false,
                    "backOrderQuantity":0
                }
            ],
            "taxPriceInfo":{
                "secondaryCurrencyTaxAmount":0,
                "discounted":false,
                "valueAddedTax":0,
                "amount":6.25,
                "countyTax":0,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":6.25,
                "miscTaxInfo":{
                },
                "countryTax":0,
                "cityTax":0,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "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"
                }
            ],
            "freezeDate":null,
            "taxExempt":false,
            "lastModifiedDate":"2018-03-05T13:03:07.918Z",
            "creationSiteId":"siteUS",
            "approvalSystemMessages":[
            ],
            "profile":{
                "lastName":"Anderson",
                "firstName":"Kim",
                "customerContactId":"CRMID_12345",
                "loyaltyPrograms":[
                ],
                "shippingAddress":{
                    "country":"US",
                    "lastName":"Anderson",
                    "address3":null,
                    "city":"Syracuse",
                    "address2":null,
                    "prefix":null,
                    "address1":"21 Cedar Ave",
                    "companyName":null,
                    "postalCode":"13202",
                    "jobTitle":null,
                    "county":null,
                    "suffix":null,
                    "ownerId":null,
                    "version":2,
                    "kumar":null,
                    "externalAddressId":"externalId",
                    "firstName":"Kim",
                    "phoneNumber":"212-555-1977",
                    "repositoryId":"se-980031",
                    "faxNumber":null,
                    "middleName":null,
                    "id":"se-980031",
                    "state":"NY"
                },
                "middleName":null,
                "login":"kim@example.com",
                "parentOrganization":null,
                "email":"kim@example.com"
            },
            "approverMessages":[
            ],
            "paymentInitiatedEmailSent":false,
            "payShippingInSecondaryCurrency":null,
            "shippingGroupCount":1,
            "taxExemptionCode":null,
            "paymentGroupCount":1,
            "recurringChargePriceInfo":null,
            "profileId":"se-570031",
            "organization":null,
            "siteId":"siteUS",
            "activeQuoteOrderId":null
        },
        "suggestedShippingRefund":0,
        "returnPaymentState":"None",
        "processName":"Exchange",
        "orderCurrencyCode":"USD",
        "processImmediately":false,
        "returnAdjustedOrderId":null,
        "returnCalculationOrder":null,
        "state":"PENDING_CUSTOMER_ACTION",
        "unAdjustedRefundSubtotal":25,
        "returnItemCount":1,
        "trackingNumber":null,
        "totalOrderPromotionValueAdjustmentChange":0,
        "comments":null,
        "profile":{
            "lastName":"Anderson",
            "firstName":"Kim",
            "customerContactId":"CRMID_12345",
            "loyaltyPrograms":[
            ],
            "shippingAddress":{
                "country":"US",
                "lastName":"Anderson",
                "firstName":"Kim",
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "postalCode":"13202",
                "repositoryId":"se-980031",
                "middleName":null,
                "state":"NY"
            },
            "middleName":null,
            "id":"se-570031",
            "parentOrganization":null,
            "login":"kim@example.com",
            "email":"kim@example.com"
        },
        "suggestedTaxRefund":0,
        "nonReturnItemCostAdjustments":[
        ],
        "replacementOrder":{
            "approverIds":[
            ],
            "gwp":false,
            "secondaryCurrencyCode":null,
            "lastModifiedTime":1.520254987961E12,
            "priceGroupId":"defaultPriceGroup",
            "creationTime":1.520254983031E12,
            "sourceSystem":"Cloud Commerce",
            "gwpMarkers":[
            ],
            "paymentGroups":[
                {
                    "amountAuthorized":106.25,
                    "amount":25,
                    "paymentMethod":"tokenizedCreditCard",
                    "id":"pg30412",
                    "billingAddress":{
                        "country":"US",
                        "lastName":"MILLER",
                        "address3":null,
                        "city":"Springfield",
                        "address2":null,
                        "prefix":null,
                        "address1":"Address Line 1",
                        "companyName":null,
                        "postalCode":"01144",
                        "jobTitle":null,
                        "county":null,
                        "suffix":null,
                        "ownerId":null,
                        "kumar":null,
                        "firstName":"JESSICA",
                        "phoneNumber":"12345678",
                        "faxNumber":null,
                        "middleName":null,
                        "state":"MA",
                        "email":"JESSICA.MILLER@test.com"
                    },
                    "currencyCode":"USD"
                }
            ],
            "locale":null,
            "submittedDate":"2018-03-05T13:03:07.537Z",
            "salesChannel":"default",
            "configuratorId":null,
            "payTaxInSecondaryCurrency":null,
            "organizationId":null,
            "priceInfo":{
                "secondaryCurrencyTaxAmount":0,
                "discounted":false,
                "amount":25,
                "secondaryCurrencyShippingAmount":0,
                "secondaryCurrencyTotal":0,
                "manualAdjustmentTotal":0,
                "discountAmount":0,
                "tax":0,
                "rawSubtotal":25,
                "total":25,
                "shipping":0,
                "primaryCurrencyTotal":25,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "relationships":[
                {
                    "paymentGroupId":"pg30412",
                    "amount":25,
                    "relationshipType":"ORDERAMOUNT",
                    "id":"r40386"
                }
            ],
            "catalogId":null,
            "exchangeRate":null,
            "totalCommerceItemCount":1,
            "id":"o30412",
            "externalContext":false,
            "state":"PENDING_CUSTOMER_RETURN",
            "quoteInfo":null,
            "taxCalculated":false,
            "commerceItems":[
                {
                    "deactivationDate":null,
                    "returnedQuantity":0,
                    "availabilityDate":null,
                    "externalData":[
                    ],
                    "billingAccountId":null,
                    "preOrderQuantity":0,
                    "assetKey":null,
                    "itemDiscountInfos":[
                    ],
                    "priceInfo":{
                        "discounted":false,
                        "amount":25,
                        "secondaryCurrencyShippingSurcharge":0,
                        "rawTotalPrice":99.99,
                        "salePrice":25,
                        "priceListId":"salePrices",
                        "quantityDiscounted":0,
                        "amountIsFinal":true,
                        "onSale":true,
                        "shippingSurcharge":0,
                        "discountable":true,
                        "currentPriceDetailsSorted":[
                            {
                                "secondaryCurrencyTaxAmount":0,
                                "discounted":false,
                                "amount":25,
                                "quantity":1,
                                "amountIsFinal":false,
                                "range":{
                                    "lowBound":0,
                                    "highBound":0,
                                    "size":1
                                },
                                "orderDiscountShare":0,
                                "tax":0,
                                "detailedUnitPrice":25,
                                "currencyCode":"USD"
                            }
                        ],
                        "currencyCode":"USD",
                        "listPrice":99.99
                    },
                    "catalogId":null,
                    "externalRecurringChargeDetails":null,
                    "externalPriceDetails":null,
                    "actionCode":null,
                    "id":"ci3000412",
                    "serviceId":null,
                    "serviceAccountId":null,
                    "quantity":1,
                    "productId":"prod10013",
                    "orderDiscountInfos":[
                    ],
                    "parentAssetKey":null,
                    "externalId":null,
                    "rootAssetKey":null,
                    "transactionDate":null,
                    "catalogRefId":"sku10030",
                    "customerAccountId":null,
                    "recurringChargePriceInfo":null,
                    "lineAttributes":[
                    ],
                    "productDisplayName":"Playstation",
                    "catalogKey":null,
                    "siteId":"siteUS",
                    "shopperInput":{
                    },
                    "activationDate":null,
                    "asset":false,
                    "backOrderQuantity":0
                }
            ],
            "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":true,
                "currencyCode":"USD"
            },
            "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"
                }
            ],
            "freezeDate":null,
            "taxExempt":false,
            "lastModifiedDate":"2018-03-05T13:03:07.961Z",
            "creationSiteId":"siteUS",
            "approvalSystemMessages":[
            ],
            "profile":{
                "lastName":"Anderson",
                "firstName":"Kim",
                "loyaltyPrograms":[
                ],
                "shippingAddress":{
                    "country":"US",
                    "lastName":"Anderson",
                    "address3":null,
                    "city":"Syracuse",
                    "address2":null,
                    "prefix":null,
                    "address1":"21 Cedar Ave",
                    "companyName":null,
                    "postalCode":"13202",
                    "jobTitle":null,
                    "county":null,
                    "suffix":null,
                    "ownerId":null,
                    "version":2,
                    "kumar":null,
                    "firstName":"Kim",
                    "phoneNumber":"212-555-1977",
                    "repositoryId":"se-980031",
                    "faxNumber":null,
                    "middleName":null,
                    "id":"se-980031",
                    "state":"NY"
                },
                "middleName":null,
                "login":"kim@example.com",
                "parentOrganization":null,
                "email":"kim@example.com"
            },
            "approverMessages":[
            ],
            "paymentInitiatedEmailSent":false,
            "payShippingInSecondaryCurrency":null,
            "shippingGroupCount":1,
            "taxExemptionCode":null,
            "paymentGroupCount":1,
            "recurringChargePriceInfo":null,
            "profileId":"se-570031",
            "organization":null,
            "siteId":"siteUS",
            "activeQuoteOrderId":null
        },
        "actualShippingRefund":0,
        "actualTaxRefund":0,
        "otherRefund":0,
        "returnLabel":null,
        "processed":false,
        "totalItemRefund":25,
        "returningItems":true,
        "authorizationNumber":"100001",
        "exchangeProcess":true,
        "replacingItems":false,
        "returnFee":0,
        "totalReturnItemRefund":25,
        "submitExchangeAllowed":false,
        "originOfReturn":"contactCenter",
        "totalRefundAmount":25,
        "unallocatedAmount":0,
        "additionalProperties":{
        },
        "originatingOrderId":"o10401",
        "nonReturnItemSubtotalAdjustment":0,
        "adjustmentAmount":0,
        "replaceItemCount":0,
        "returnItemList":[
            {
                "quantityReturned":1,
                "quantityToReturn":1,
                "quantityAvailable":0,
                "returnItemId":"100001",
                "suggestedTaxRefundShare":0,
                "shippingGroupId":"sg10401",
                "itemCurrencyCode":"USD",
                "quantityToExchange":0,
                "description":null,
                "catalogRefId":"sku10030",
                "suggestedShippingRefundShare":0,
                "commerceItemId":"ci1000401",
                "disposition":null,
                "quantityShipped":1,
                "returnReason":"defective",
                "itemCostAdjustments":[
                ],
                "actualShippingRefundShare":0,
                "suggestedRefundAmount":25,
                "actualTaxRefundShare":0,
                "quantityReceived":0,
                "refundAmount":25
            }
        ]
    }
}
Nested Schema : return
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : nonReturnItemCostAdjustments
Type: array
Show Source
Nested Schema : return_order
Type: object
Show Source
Nested Schema : profile
Type: object
Show Source
Nested Schema : refundMethodList
Type: array
Show Source
Nested Schema : relatedReplacementOrders
Type: array
Show Source
Nested Schema : returnItemList
Type: array
List of returnable Items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : approvalSystemMessages
Type: array
Show Source
Nested Schema : approverIds
Type: array
Show Source
Nested Schema : approverMessages
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 thef 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. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : gwpMarkers
Type: array
gwpOrderMarker information
Show Source
Nested Schema : organization
Type: object
Show Source
Nested Schema : paymentGroups
Type: array
The array of payment groups represent the payment(s) that paid for the order.
Show Source
Nested Schema : priceInfo
Type: object
Pricing information, an instance of OrderPriceInfo.
Show Source
Nested Schema : profile
Type: object
Basic profile information.
Show Source
Nested Schema : quoteInfo
Type: object
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : relationships
Type: array
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.
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
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
Details about external recurring pricing.
Show Source
Nested Schema : itemDiscountInfos
Type: array
Array of item promotions affecting this item.
Show Source
Nested Schema : lineAttributes
Type: array
Show Source
Nested Schema : orderDiscountInfos
Type: array
Array of order promotions affecting this item.
Show Source
Nested Schema : priceInfo
Type: object
Details about pricing.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
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 : items
Type: object
Show Source
Nested Schema : couponCodes
Type: array
One or more coupon codes used to grant the item promotion providing the discount.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCodes
Type: array
One or more coupon codes used to grant the order promotion providing the discount.
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 recurring charge price info.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
The billing address details
Show Source
Nested Schema : orderTotalBySite
Type: object
The map containing order totals by site for all sites in a given order.
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : parentOrganization
Type: object
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address
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 : commerceItemRelationships
Type: array
The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order.
Show Source
Nested Schema : handlingInstructions
Type: array
Handling instructions.
Show Source
Nested Schema : priceInfo
Type: object
The pricing details about this shipping group.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address for this shipping group.
Show Source
Nested Schema : specialInstructions
Type: object
Special instructions for the shipping group. Keys and values are strings.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : range
Type: object
The range covered by these commerce items
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 : miscTaxInfo
Type: object
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : parentOrganization
Type: object
Show Source
Nested Schema : return_address
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : contract
Type: object
Show Source
Nested Schema : secondaryAddresses
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : returnItem_def
Type: object
return Item
Show Source
Nested Schema : childReturnItems
Type: array
List of child return Items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
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

No response is returned as this is an event webhook
Body ()
Root Schema : emptyResponse
Show Source
Back to Top