initiateCancelOrder

post

/ccagent/v1/orders/initiateCancelOrder

Initiate Cancel.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : initiateCancelOrder_request
Type: object
Show Source
Example:
{
    "orderId":"o90419",
    "cancelReason":"betterCompetitorPrice"
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : initiateCancelOrder_response
Type: object
Show Source
Example:
{
    "taxPriceInfo":{
        "discounted":false,
        "cityTax":0,
        "secondaryCurrencyTaxAmount":1.5,
        "amount":6.3,
        "countyTax":0.9,
        "amountIsFinal":false,
        "districtTax":0,
        "stateTax":5.4,
        "currencyCode":"USD",
        "countryTax":0
    },
    "shippingGroups":[
        {
            "shippingMethod":"freeShippingMethod",
            "description":"sg10076",
            "submittedDate":null,
            "priceInfo":{
                "discounted":false,
                "secondaryCurrencyTaxAmount":1.5,
                "amount":0,
                "secondaryCurrencyShippingAmount":6,
                "rawShipping":0,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "shipOnDate":null,
            "actualShipDate":null,
            "trackingInfo":[
                {
                    "carrierName":"USPS",
                    "trackingUrl":"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=ABC123",
                    "carrierId":"USPS",
                    "trackingNumber":"ABC123"
                }
            ],
            "specialInstructions":{
            },
            "shippingAddress":{
                "lastName":"FLORES",
                "country":"US",
                "address3":null,
                "city":"Branford",
                "address2":null,
                "prefix":null,
                "address1":"203 Main Street",
                "companyName":null,
                "jobTitle":null,
                "postalCode":"32008",
                "county":null,
                "suffix":null,
                "ownerId":null,
                "firstName":"FLORENCE",
                "phoneNumber":"9087654321",
                "faxNumber":null,
                "middleName":null,
                "state":"FL",
                "id":"sg10076",
                "email":"FLORENCE.FLORES@test.com"
            },
            "commerceItemRelationships":[
                {
                    "commerceItemId":"ci1000076",
                    "amount":0,
                    "quantity":3,
                    "pointOfNoRevision":false,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "returnedQuantity":0,
                    "commerceItemExternalId":null,
                    "id":"r10066"
                }
            ],
            "state":"INITIAL",
            "id":"sg10076",
            "stateDetail":null,
            "trackingNumber":"USPS-ABC123",
            "handlingInstructions":[
            ],
            "shippingGroupClassType":"hardgoodShippingGroup"
        }
    ],
    "priceGroupId":"defaultPriceGroup",
    "taxExempt":false,
    "lastModifiedTime":1.409947606E12,
    "creationTime":1.409947604E12,
    "sourceSystem":"Cloud Commerce",
    "profile":{
        "lastName":"FLORES",
        "firstName":"FLORENCE",
        "shippingAddress":{
            "country":"US",
            "phoneNumber":null,
            "address3":null,
            "address2":null,
            "city":"Branford",
            "address1":"203 Main Street",
            "postalCode":"32008",
            "county":null,
            "state":null
        },
        "middleName":null,
        "email":"FLORENCE.FLORES@test.com"
    },
    "locale":"en",
    "salesChannel":"default",
    "shippingGroupCount":1,
    "paymentGroups":[
        {
            "PONumber":"9874",
            "expirationYear":"2016",
            "amountAuthorized":96.27,
            "amount":96.27,
            "expirationMonth":"05",
            "submittedDate":"2014-09-04T11:46:01.000Z",
            "authorizationStatus":[
                {
                    "transactionUuid":"fbd1adb5b1cc40209e8d39324d7f7f6d",
                    "authorizationDecision":"ACCEPT",
                    "amount":96.27,
                    "transactionSuccess":true,
                    "errorMessage":"Request was processed successfully.",
                    "currency":"USD",
                    "reasonCode":"100",
                    "transactionId":"4098167595050176195662"
                }
            ],
            "token":"9997000128471543",
            "paymentGroupClassType":"tokenizedCreditCard",
            "creditCardNumber":"1111",
            "paymentMethod":"tokenizedCreditCard",
            "billingAddress":{
                "lastName":"FLORES",
                "country":"US",
                "address3":null,
                "city":"Branford",
                "address2":null,
                "prefix":null,
                "address1":"Address Line 1",
                "companyName":null,
                "jobTitle":null,
                "postalCode":"32008",
                "county":null,
                "suffix":null,
                "ownerId":null,
                "firstName":"FLORENCE",
                "phoneNumber":"12345678",
                "faxNumber":null,
                "middleName":null,
                "state":"FL",
                "id":"pg10076",
                "email":"FLORENCE.FLORES@test.com"
            },
            "id":"pg10076",
            "currencyCode":"USD"
        }
    ],
    "orderAction":"order",
    "paymentGroupCount":1,
    "organizationId":"100001",
    "relationships":[
        {
            "paymentGroupId":"pg10076",
            "amount":96.27,
            "relationshipType":"ORDERAMOUNTREMAINING",
            "id":"r10068"
        }
    ],
    "priceInfo":{
        "discounted":false,
        "secondaryCurrencyTaxAmount":1.5,
        "amount":89.97,
        "secondaryCurrencyShippingAmount":6,
        "secondaryCurrencyTotal":7.5,
        "manualAdjustmentTotal":0,
        "discountAmount":0,
        "tax":6.3,
        "rawSubtotal":89.97,
        "total":96.27,
        "shipping":0,
        "primaryCurrencyTotal":89.97,
        "amountIsFinal":false,
        "currencyCode":"USD"
    },
    "recurringChargePriceInfo":{
        "discounted":false,
        "amount":30,
        "total":32.4,
        "shipping":0,
        "subTotalByFrequency":[
            {
                "amount":30,
                "frequency":"Monthly"
            }
        ],
        "taxByFrequency":[
            {
                "amount":2.4,
                "frequency":"Monthly"
            }
        ],
        "manualAdjustmentTotal":0,
        "amountIsFinal":false,
        "discountAmount":0,
        "tax":2.4,
        "rawSubtotal":30,
        "currencyCode":"USD"
    },
    "profileId":"se-570031",
    "siteId":"siteUS",
    "totalCommerceItemCount":3,
    "state":"SUBMITTED",
    "id":"o10076",
    "commerceItems":[
        {
            "deactivationDate":"2018-06-27T12:59:59Z",
            "returnedQuantity":0,
            "availabilityDate":null,
            "externalData":[
            ],
            "billingAccountId":"billingAcc-123",
            "preOrderQuantity":0,
            "configuratorId":"123455",
            "assetKey":null,
            "priceInfo":{
                "discounted":false,
                "amount":89.97,
                "rawTotalPrice":89.97,
                "salePrice":0,
                "priceListId":"listPrices",
                "quantityDiscounted":0,
                "amountIsFinal":false,
                "onSale":false,
                "shippingSurcharge":10,
                "discountable":true,
                "currencyCode":"USD",
                "currentPriceDetailsSorted":[
                    {
                        "discounted":false,
                        "amount":89.97,
                        "quantity":3,
                        "amountIsFinal":false,
                        "range":{
                            "lowBound":0,
                            "highBound":2,
                            "size":3
                        },
                        "tax":6.3,
                        "detailedUnitPrice":29.99,
                        "currencyCode":"USD"
                    }
                ],
                "listPrice":29.99
            },
            "catalogId":null,
            "assetId":"asset10001",
            "externalRecurringChargeDetails":{
                "externalRecurringCharge":10,
                "externalRecurringChargeFrequency":"Monthly",
                "externalRecurringChargeDuration":"12"
            },
            "externalPriceDetails":{
                "externalPriceQuantity":1,
                "externalPrice":100
            },
            "actionCode":"Add",
            "id":"ci1000076",
            "serviceId":"service-123",
            "commerceItems":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "addOnItem":false,
                    "quantity":1,
                    "productId":"prod40001",
                    "externalData":[
                    ],
                    "parentAssetKey":null,
                    "billingAccountId":"billingAcc-123",
                    "originalCommerceItemId":"o30417",
                    "rootAssetKey":null,
                    "catalogRefId":"sku40001",
                    "assetKey":null,
                    "customerAccountId":"customerAcc-123",
                    "recurringChargePriceInfo":{
                        "discounted":false,
                        "amount":10,
                        "rawTotalPrice":10,
                        "salePrice":0,
                        "priceListId":null,
                        "quantityDiscounted":0,
                        "amountIsFinal":false,
                        "onSale":false,
                        "shippingSurcharge":0,
                        "discountable":true,
                        "currentPriceDetailsSorted":[
                            {
                                "discounted":false,
                                "amount":10,
                                "quantity":1,
                                "amountIsFinal":false,
                                "range":{
                                    "lowBound":0,
                                    "highBound":0,
                                    "size":1
                                },
                                "tax":0,
                                "orderDiscountShare":0,
                                "detailedUnitPrice":10,
                                "currencyCode":"USD"
                            }
                        ],
                        "currencyCode":"USD",
                        "listPrice":0
                    },
                    "assetId":"asset10001",
                    "externalRecurringChargeDetails":{
                        "externalRecurringCharge":10,
                        "externalRecurringChargeFrequency":"Monthly",
                        "externalRecurringChargeDuration":"12"
                    },
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                },
                {
                    "serviceAccountId":"serviceAcc-123",
                    "configurationOptionId":"sku2442",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "addOnItem":true,
                    "quantity":1,
                    "productId":"prod40002",
                    "externalData":[
                    ],
                    "parentAssetKey":null,
                    "billingAccountId":"billingAcc-123",
                    "originalCommerceItemId":"o30417",
                    "rootAssetKey":null,
                    "configurablePropertyId":"product10222",
                    "catalogRefId":"sku40005",
                    "assetKey":null,
                    "customerAccountId":"customerAcc-123",
                    "assetId":"asset10001",
                    "actionCode":"Add",
                    "shopperInput":{
                        "message":"Best Wishes my friend",
                        "font":"courier"
                    },
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                }
            ],
            "serviceAccountId":"serviceAcc-123",
            "quantity":3,
            "productId":"prod10021",
            "externalId":null,
            "parentAssetKey":null,
            "originalCommerceItemId":"o30417",
            "rootAssetKey":null,
            "catalogRefId":"sku10017",
            "customerAccountId":"customerAcc-123",
            "recurringChargePriceInfo":{
                "discounted":false,
                "amount":10,
                "rawTotalPrice":10,
                "salePrice":0,
                "priceListId":null,
                "quantityDiscounted":0,
                "amountIsFinal":false,
                "onSale":false,
                "shippingSurcharge":0,
                "discountable":true,
                "currentPriceDetailsSorted":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "amountIsFinal":false,
                        "range":{
                            "lowBound":0,
                            "highBound":0,
                            "size":1
                        },
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "currencyCode":"USD",
                "listPrice":0
            },
            "catalogKey":null,
            "productDisplayName":"Wii Classic Controller",
            "shopperInput":{
                "color":"neon",
                "initials":"M.C.K",
                "font":"courier"
            },
            "activationDate":"2017-06-27T15:30:00Z",
            "asset":false,
            "backOrderQuantity":0
        }
    ]
}
Nested Schema : cancelOrder
Type: object
Initiate Cancel information for the order.
Show Source
Nested Schema : returnRequest
Type: object
return request created for for the cancel order.
Show Source