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":"o30411",
    "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:
{
    "priceGroupId":"defaultPriceGroup",
    "lastModifiedTime":1.409947606E12,
    "creationTime":1.409947604E12,
    "sourceSystem":"Cloud Commerce",
    "locale":"en",
    "salesChannel":"default",
    "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@example.com"
            },
            "id":"pg10076",
            "currencyCode":"USD"
        }
    ],
    "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"
    },
    "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":"12345",
            "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,
            "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":"12345",
                    "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
                    },
                    "externalRecurringChargeDetails":{
                        "externalRecurringCharge":10,
                        "externalRecurringChargeFrequency":"Monthly",
                        "externalRecurringChargeDuration":"12"
                    },
                    "siteId":"siteUS",
                    "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":"12345",
                    "customerAccountId":"customerAcc-123",
                    "siteId":"siteUS",
                    "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",
            "siteId":"siteUS",
            "shopperInput":{
                "color":"neon",
                "initials":"M.C.K",
                "font":"courier"
            },
            "activationDate":"2017-06-27T15:30:00Z",
            "asset":false,
            "backOrderQuantity":0
        }
    ],
    "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":"9085554321",
                "faxNumber":null,
                "middleName":null,
                "state":"FL",
                "id":"sg10076",
                "email":"FLORENCE.FLORES@example.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"
        }
    ],
    "taxExempt":false,
    "creationSiteId":"siteUS",
    "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@example.com"
    },
    "shippingGroupCount":1,
    "orderAction":"order",
    "paymentGroupCount":1,
    "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"
}
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
Nested Schema : commerceItems
Type: array
The commerce items (sometimes referred to as "line items") represent which actual skus are included in the order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.
Show Source
Nested Schema : paymentGroups
Type: array
The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
Show Source
Nested Schema : priceInfo
Type: object
The order price information.
Show Source
  • The total order amount.
  • The currency code.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • The shipping surcharges added at item level in monetary currency.
  • This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency.
    Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
    3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
    3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • The total shipping cost.
  • Extra handling costs for shipping the products.
  • The sub-total amount.
  • The total tax amount.
  • Total excluding shipping and tax in monetary currency
  • The order total.
Nested Schema : profile
Type: object
Basic profile information. (read-only)
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information of the order
Show Source
Nested Schema : shippingGroups
Type: array
Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about pricing.
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring pricing.
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : externalRecurringChargeDetails
Type: object
Details about external recurring 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 array of 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 recurring charge price info.
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 : 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 : values
Type: object
The array of 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 recurring charge price info.
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 : 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 : values
Type: object
The array of 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 recurring charge price info.
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 : 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 : values
Type: object
The array of 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 recurring charge price info.
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 : 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 : values
Type: object
The array of 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 recurring charge price info.
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 : 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 : values
Type: object
The array of 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 recurring charge price info.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : authorizationStatus
Type: array
Array of authorization status objects.
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
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
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. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
Show Source
Nested Schema : handlingInstructions
Type: array
Handling instructions. Currently read-only.
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 : trackingInfo
Type: array
An array that specifies the tracking info of shipping group. (read-only)
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 : additionalProperties
Type: object
Map of Additional properties for return request
Show Source
Nested Schema : originatingOrder
Type: object
Original order information
Show Source
Nested Schema : profile
Type: object
Profile Information for the order.
Show Source
Nested Schema : refundMethodList
Type: array
List of Refund methods of return request
Show Source
Nested Schema : returnItemList
Type: array
List of returnable Items
Show Source
Nested Schema : trackingNumber
Type: array
List of tracking numbers for the return request
Show Source
Nested Schema : approverIds
Type: array
List of ids of approvers
Show Source
Nested Schema : commerceItems
Type: array
list of commerce items
Show Source
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order. Related Endpoint operations - submitOrder
Show Source
Nested Schema : priceInfo
Type: object
The order price information.
Show Source
  • The total order amount.
  • The currency code.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • The shipping surcharges added at item level in monetary currency.
  • This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency.
    Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
    3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
    3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • The total shipping cost.
  • Extra handling costs for shipping the products.
  • The sub-total amount.
  • The total tax amount.
  • Total excluding shipping and tax in monetary currency
  • The order total.
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
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 : priceInfo
Type: object
Details about pricing.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address for this shipping group.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Map of Additional properties for each return item
Show Source
Example Response (application/json)
{
    "cancelOrder":{
        "gwp":false,
        "secondaryCurrencyCode":null,
        "defaultCatalog":null,
        "salesChannel":"contactCenter",
        "submittedDate":"2018-05-28T13:29:09.000Z",
        "configuratorId":null,
        "responseCode":null,
        "organizationId":null,
        "relationships":[
        ],
        "exchangeRate":null,
        "id":"o270411",
        "state":"INCOMPLETE_CANCEL",
        "taxCalculated":true,
        "commerceItems":[
            {
                "deactivationDate":null,
                "returnedQuantity":0,
                "availabilityDate":null,
                "externalData":[
                ],
                "billingAccountId":null,
                "preOrderQuantity":0,
                "assetKey":"12345",
                "priceInfo":{
                    "discounted":true,
                    "amount":0,
                    "secondaryCurrencyShippingSurcharge":0,
                    "rawTotalPrice":49.99,
                    "salePrice":0,
                    "priceListId":"listPrices",
                    "quantityDiscounted":0,
                    "amountIsFinal":true,
                    "onSale":false,
                    "shippingSurcharge":0,
                    "discountable":true,
                    "currencyCode":"USD",
                    "currentPriceDetailsSorted":[
                        {
                            "discounted":false,
                            "secondaryCurrencyTaxAmount":0,
                            "amount":0,
                            "quantity":1,
                            "amountIsFinal":false,
                            "range":{
                                "lowBound":0,
                                "highBound":0,
                                "size":1
                            },
                            "orderDiscountShare":0,
                            "tax":0,
                            "detailedUnitPrice":0,
                            "currencyCode":"USD"
                        }
                    ],
                    "listPrice":49.99
                },
                "catalogId":null,
                "externalRecurringChargeDetails":null,
                "externalPriceDetails":null,
                "actionCode":"-",
                "id":"ci26000411",
                "serviceId":null,
                "serviceAccountId":null,
                "quantity":1,
                "productId":"Product_21Cxi",
                "externalId":null,
                "parentAssetKey":null,
                "originalCommerceItemId":"ci20000412",
                "rootAssetKey":null,
                "catalogRefId":"Sku_21Dxy",
                "customerAccountId":null,
                "recurringChargePriceInfo":null,
                "lineAttributes":[
                ],
                "catalogKey":null,
                "productDisplayName":"Dora the Explorer - Season 1",
                "siteId":"siteUS",
                "shopperInput":{
                },
                "activationDate":null,
                "asset":false,
                "backOrderQuantity":0
            }
        ],
        "freezeDate":null,
        "shippingGroups":[
            {
                "shippingMethod":"freeShippingMethod",
                "description":"sg200412",
                "submittedDate":null,
                "priceInfo":{
                    "discounted":false,
                    "secondaryCurrencyTaxAmount":0,
                    "shippingTax":2,
                    "amount":0,
                    "secondaryCurrencyShippingAmount":0,
                    "rawShipping":0,
                    "amountIsFinal":true,
                    "currencyCode":"USD"
                },
                "shipOnDate":null,
                "actualShipDate":null,
                "specialInstructions":{
                },
                "shippingAddress":{
                    "country":"US",
                    "lastName":"Anderson",
                    "address3":null,
                    "address2":null,
                    "city":"Syracuse",
                    "address1":"21 Cedar Ave",
                    "prefix":null,
                    "companyName":null,
                    "jobTitle":null,
                    "postalCode":"13202",
                    "county":null,
                    "ownerId":null,
                    "suffix":null,
                    "firstName":"Kim",
                    "phoneNumber":"212-555-1977",
                    "faxNumber":null,
                    "middleName":null,
                    "state":"NY",
                    "email":"kim@example.com"
                },
                "commerceItemRelationships":[
                    {
                        "commerceItemId":"ci26000411",
                        "amount":0,
                        "quantity":1,
                        "pointOfNoRevision":false,
                        "relationshipType":"SHIPPINGQUANTITY",
                        "returnedQuantity":0,
                        "range":{
                            "lowBound":0,
                            "highBound":0,
                            "size":1
                        },
                        "commerceItemExternalId":null,
                        "id":"r260384",
                        "state":"INITIAL"
                    }
                ],
                "id":"sg260411",
                "state":"INITIAL",
                "stateDetail":null,
                "trackingNumber":null,
                "handlingInstructions":[
                ],
                "shippingGroupClassType":"hardgoodShippingGroup"
            }
        ],
        "taxExempt":false,
        "profile":{
            "firstName":"Kim",
            "lastName":"Anderson",
            "loyaltyPrograms":[
            ],
            "shippingAddress":{
                "country":"US",
                "lastName":"Anderson",
                "address3":null,
                "address2":null,
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "prefix":null,
                "companyName":null,
                "jobTitle":null,
                "postalCode":"13202",
                "county":null,
                "ownerId":null,
                "suffix":null,
                "version":2,
                "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"
        },
        "defaultPriceListGroup":null,
        "paymentInitiatedEmailSent":false,
        "payShippingInSecondaryCurrency":null,
        "shippingGroupCount":1,
        "taxExemptionCode":null,
        "orderAction":"cancelOrder",
        "profileId":"se-570031",
        "activeQuoteOrderId":null,
        "approverIds":[
        ],
        "lastModifiedTime":1.527600124827E12,
        "priceGroupId":"defaultPriceGroup",
        "creationTime":1.527514131E12,
        "sourceSystem":"Cloud Commerce",
        "gwpMarkers":[
        ],
        "locale":"en",
        "paymentGroups":[
        ],
        "payTaxInSecondaryCurrency":null,
        "priceInfo":{
            "discounted":false,
            "secondaryCurrencyTaxAmount":0,
            "amount":0,
            "frequencyAmountTotals":{
            },
            "secondaryCurrencyShippingAmount":0,
            "secondaryCurrencyTotal":0,
            "manualAdjustmentTotal":0,
            "discountAmount":0,
            "tax":0,
            "rawSubtotal":0,
            "frequencyTaxTotals":{
            },
            "total":0,
            "shipping":0,
            "primaryCurrencyTotal":0,
            "amountIsFinal":false,
            "currencyCode":"USD"
        },
        "catalogId":null,
        "totalCommerceItemCount":1,
        "externalContext":false,
        "quoteInfo":null,
        "taxPriceInfo":{
            "discounted":false,
            "secondaryCurrencyTaxAmount":0,
            "amount":0,
            "valueAddedTax":0,
            "countyTax":3,
            "isTaxIncluded":false,
            "miscTax":0,
            "districtTax":0,
            "stateTax":3,
            "miscTaxInfo":{
            },
            "countryTax":0,
            "cityTax":0,
            "amountIsFinal":true,
            "currencyCode":"USD"
        },
        "defaultAdditionalPriceListGroups":null,
        "creationSiteId":"siteUS",
        "lastModifiedDate":"2018-05-29T13:22:04.827Z",
        "approvalSystemMessages":[
        ],
        "approverMessages":[
        ],
        "message":null,
        "paymentGroupCount":0,
        "recurringChargePriceInfo":null,
        "organization":null,
        "siteId":"siteUS"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://agent.example.com:9080/ccagentui/v1/orders/initiateCancelOrder"
        }
    ],
    "returnRequest":{
        "agentId":null,
        "authorizationDate":"2018-05-29T13:21:58.131Z",
        "refundSubtotal":80.99,
        "relatedReplacementOrders":[
        ],
        "refundMethodList":[
            {
                "refundType":"manualRefund",
                "amount":80.99,
                "maximumRefundAmount":-1
            }
        ],
        "allocatedAmount":80.99,
        "originatingOrder":{
            "gwp":false,
            "secondaryCurrencyCode":null,
            "defaultCatalog":null,
            "salesChannel":"contactCenter",
            "submittedDate":"2018-05-28T13:29:09.000Z",
            "configuratorId":null,
            "responseCode":null,
            "organizationId":null,
            "relationships":[
                {
                    "paymentGroupId":"pg180414",
                    "amount":80.99,
                    "relationshipType":"ORDERAMOUNT",
                    "id":"r200390"
                }
            ],
            "exchangeRate":null,
            "id":"o210411",
            "state":"SUBMITTED",
            "taxCalculated":true,
            "commerceItems":[
                {
                    "deactivationDate":null,
                    "returnedQuantity":0,
                    "availabilityDate":null,
                    "externalData":[
                    ],
                    "billingAccountId":null,
                    "preOrderQuantity":0,
                    "assetKey":"12345",
                    "priceInfo":{
                        "discounted":false,
                        "amount":49.99,
                        "secondaryCurrencyShippingSurcharge":0,
                        "rawTotalPrice":49.99,
                        "salePrice":0,
                        "priceListId":"listPrices",
                        "quantityDiscounted":0,
                        "amountIsFinal":false,
                        "onSale":false,
                        "shippingSurcharge":0,
                        "discountable":true,
                        "currencyCode":"USD",
                        "currentPriceDetailsSorted":[
                            {
                                "discounted":false,
                                "secondaryCurrencyTaxAmount":0,
                                "amount":49.99,
                                "quantity":1,
                                "amountIsFinal":false,
                                "range":{
                                    "lowBound":0,
                                    "highBound":0,
                                    "size":1
                                },
                                "orderDiscountShare":0,
                                "tax":4,
                                "detailedUnitPrice":49.99,
                                "currencyCode":"USD"
                            }
                        ],
                        "listPrice":49.99
                    },
                    "catalogId":null,
                    "externalRecurringChargeDetails":null,
                    "externalPriceDetails":null,
                    "actionCode":null,
                    "id":"ci20000412",
                    "serviceId":null,
                    "serviceAccountId":null,
                    "quantity":1,
                    "productId":"Product_21Cxi",
                    "externalId":null,
                    "parentAssetKey":null,
                    "originalCommerceItemId":null,
                    "rootAssetKey":null,
                    "catalogRefId":"Sku_21Dxy",
                    "customerAccountId":null,
                    "recurringChargePriceInfo":null,
                    "lineAttributes":[
                    ],
                    "catalogKey":null,
                    "productDisplayName":"Dora the Explorer - Season 1",
                    "siteId":"siteUS",
                    "shopperInput":{
                    },
                    "activationDate":null,
                    "asset":false,
                    "backOrderQuantity":0
                }
            ],
            "freezeDate":null,
            "shippingGroups":[
                {
                    "shippingMethod":"standardShippingMethod",
                    "description":"sg200412",
                    "submittedDate":null,
                    "priceInfo":{
                        "discounted":false,
                        "secondaryCurrencyTaxAmount":0,
                        "shippingTax":2,
                        "amount":25,
                        "secondaryCurrencyShippingAmount":0,
                        "rawShipping":25,
                        "amountIsFinal":false,
                        "currencyCode":"USD"
                    },
                    "shipOnDate":null,
                    "actualShipDate":null,
                    "specialInstructions":{
                    },
                    "shippingAddress":{
                        "country":"US",
                        "lastName":"Anderson",
                        "address3":null,
                        "address2":null,
                        "city":"Syracuse",
                        "address1":"21 Cedar Ave",
                        "prefix":null,
                        "companyName":null,
                        "jobTitle":null,
                        "postalCode":"13202",
                        "county":null,
                        "ownerId":null,
                        "suffix":null,
                        "firstName":"Kim",
                        "phoneNumber":"212-555-1977",
                        "faxNumber":null,
                        "middleName":null,
                        "state":"NY",
                        "email":"kim@example.com"
                    },
                    "commerceItemRelationships":[
                        {
                            "commerceItemId":"ci20000412",
                            "amount":0,
                            "quantity":1,
                            "pointOfNoRevision":false,
                            "relationshipType":"SHIPPINGQUANTITY",
                            "returnedQuantity":0,
                            "range":{
                                "lowBound":0,
                                "highBound":0,
                                "size":1
                            },
                            "commerceItemExternalId":null,
                            "id":"r200388",
                            "state":"INITIAL"
                        }
                    ],
                    "id":"sg200412",
                    "state":"INITIAL",
                    "stateDetail":null,
                    "trackingNumber":null,
                    "handlingInstructions":[
                    ],
                    "shippingGroupClassType":"hardgoodShippingGroup"
                }
            ],
            "taxExempt":false,
            "profile":{
                "firstName":"Kim",
                "lastName":"Anderson",
                "loyaltyPrograms":[
                ],
                "shippingAddress":{
                    "country":"US",
                    "lastName":"Anderson",
                    "address3":null,
                    "address2":null,
                    "city":"Syracuse",
                    "address1":"21 Cedar Ave",
                    "prefix":null,
                    "companyName":null,
                    "jobTitle":null,
                    "postalCode":"13202",
                    "county":null,
                    "ownerId":null,
                    "suffix":null,
                    "version":2,
                    "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"
            },
            "defaultPriceListGroup":null,
            "paymentInitiatedEmailSent":false,
            "payShippingInSecondaryCurrency":null,
            "shippingGroupCount":1,
            "taxExemptionCode":null,
            "orderAction":"order",
            "profileId":"se-570031",
            "activeQuoteOrderId":null,
            "approverIds":[
            ],
            "lastModifiedTime":1.527514149E12,
            "priceGroupId":"defaultPriceGroup",
            "creationTime":1.527514131E12,
            "sourceSystem":"Cloud Commerce",
            "gwpMarkers":[
            ],
            "locale":"en",
            "paymentGroups":[
                {
                    "PONumber":null,
                    "amountAuthorized":80.99,
                    "amount":80.99,
                    "gatewayName":null,
                    "paymentProps":{
                    },
                    "submittedDate":"2018-05-28T13:29:09.000Z",
                    "authorizationStatus":[
                        {
                            "amount":80.99,
                            "statusProps":{
                            },
                            "transactionSuccess":true,
                            "errorMessage":null,
                            "externalStatusProps":[
                            ],
                            "transactionId":null,
                            "transactionTimestamp":null
                        }
                    ],
                    "paymentGroupClassType":"invoiceRequest",
                    "paymentMethod":"invoiceRequest",
                    "billingAddress":{
                        "country":"US",
                        "lastName":"Anderson",
                        "address3":null,
                        "address2":null,
                        "city":"Syracuse",
                        "address1":"21 Cedar Ave",
                        "prefix":null,
                        "companyName":null,
                        "jobTitle":null,
                        "postalCode":"13202",
                        "county":null,
                        "ownerId":null,
                        "suffix":null,
                        "firstName":"Kim",
                        "phoneNumber":"212-555-1977",
                        "faxNumber":null,
                        "middleName":null,
                        "state":"NY",
                        "email":"kim@example.com"
                    },
                    "id":"pg180414",
                    "state":"PAYMENT_DEFERRED",
                    "debitStatus":[
                    ],
                    "currencyCode":"USD"
                }
            ],
            "payTaxInSecondaryCurrency":null,
            "priceInfo":{
                "discounted":false,
                "secondaryCurrencyTaxAmount":0,
                "amount":49.99,
                "frequencyAmountTotals":{
                },
                "secondaryCurrencyShippingAmount":0,
                "secondaryCurrencyTotal":0,
                "manualAdjustmentTotal":0,
                "discountAmount":0,
                "tax":6,
                "rawSubtotal":49.99,
                "frequencyTaxTotals":{
                },
                "total":80.99,
                "shipping":25,
                "primaryCurrencyTotal":49.99,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "catalogId":null,
            "totalCommerceItemCount":1,
            "externalContext":false,
            "quoteInfo":null,
            "taxPriceInfo":{
                "discounted":false,
                "secondaryCurrencyTaxAmount":0,
                "amount":6,
                "valueAddedTax":0,
                "countyTax":3,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":3,
                "miscTaxInfo":{
                },
                "countryTax":0,
                "cityTax":0,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "defaultAdditionalPriceListGroups":null,
            "creationSiteId":"siteUS",
            "lastModifiedDate":"2018-05-28T13:29:09.000Z",
            "approvalSystemMessages":[
            ],
            "approverMessages":[
            ],
            "message":null,
            "paymentGroupCount":1,
            "recurringChargePriceInfo":null,
            "organization":null,
            "siteId":"siteUS"
        },
        "suggestedShippingRefund":25,
        "returnPaymentState":"Refund",
        "orderCurrencyCode":"USD",
        "processImmediately":false,
        "processName":"Return",
        "returnAdjustedOrderId":"o270412",
        "returnCalculationOrder":{
            "gwp":false,
            "secondaryCurrencyCode":null,
            "defaultCatalog":null,
            "salesChannel":"contactCenter",
            "submittedDate":"2018-05-28T13:29:09.000Z",
            "configuratorId":null,
            "responseCode":null,
            "organizationId":null,
            "relationships":[
                {
                    "paymentGroupId":"pg240413",
                    "amount":80.99,
                    "relationshipType":"ORDERAMOUNT",
                    "id":"r260389"
                }
            ],
            "exchangeRate":null,
            "id":"o270413",
            "state":"SUBMITTED",
            "taxCalculated":true,
            "commerceItems":[
            ],
            "freezeDate":null,
            "shippingGroups":[
            ],
            "taxExempt":false,
            "profile":{
                "firstName":"Kim",
                "lastName":"Anderson",
                "loyaltyPrograms":[
                ],
                "shippingAddress":{
                    "country":"US",
                    "lastName":"Anderson",
                    "address3":null,
                    "address2":null,
                    "city":"Syracuse",
                    "address1":"21 Cedar Ave",
                    "prefix":null,
                    "companyName":null,
                    "jobTitle":null,
                    "postalCode":"13202",
                    "county":null,
                    "ownerId":null,
                    "suffix":null,
                    "version":2,
                    "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"
            },
            "defaultPriceListGroup":null,
            "paymentInitiatedEmailSent":false,
            "payShippingInSecondaryCurrency":null,
            "shippingGroupCount":0,
            "taxExemptionCode":null,
            "orderAction":"order",
            "profileId":"se-570031",
            "activeQuoteOrderId":null,
            "approverIds":[
            ],
            "lastModifiedTime":1.527600124709E12,
            "priceGroupId":"defaultPriceGroup",
            "creationTime":1.527514131E12,
            "sourceSystem":"Cloud Commerce",
            "gwpMarkers":[
            ],
            "locale":"en",
            "paymentGroups":[
                {
                    "PONumber":null,
                    "amountAuthorized":80.99,
                    "amount":80.99,
                    "gatewayName":null,
                    "paymentProps":{
                    },
                    "submittedDate":"2018-05-28T13:29:09.000Z",
                    "authorizationStatus":[
                        {
                            "amount":80.99,
                            "statusProps":{
                            },
                            "transactionSuccess":true,
                            "errorMessage":null,
                            "externalStatusProps":[
                            ],
                            "transactionId":null,
                            "transactionTimestamp":null
                        }
                    ],
                    "paymentGroupClassType":"invoiceRequest",
                    "paymentMethod":"invoiceRequest",
                    "billingAddress":{
                        "country":"US",
                        "lastName":"Anderson",
                        "address3":null,
                        "address2":null,
                        "city":"Syracuse",
                        "address1":"21 Cedar Ave",
                        "prefix":null,
                        "companyName":null,
                        "jobTitle":null,
                        "postalCode":"13202",
                        "county":null,
                        "ownerId":null,
                        "suffix":null,
                        "firstName":"Kim",
                        "phoneNumber":"212-555-1977",
                        "faxNumber":null,
                        "middleName":null,
                        "state":"NY",
                        "email":"kim@example.com"
                    },
                    "id":"pg240413",
                    "state":"PAYMENT_DEFERRED",
                    "debitStatus":[
                    ],
                    "currencyCode":"USD"
                }
            ],
            "payTaxInSecondaryCurrency":null,
            "priceInfo":{
                "discounted":false,
                "secondaryCurrencyTaxAmount":0,
                "amount":0,
                "frequencyAmountTotals":{
                },
                "secondaryCurrencyShippingAmount":0,
                "secondaryCurrencyTotal":0,
                "manualAdjustmentTotal":0,
                "discountAmount":0,
                "tax":0,
                "rawSubtotal":0,
                "frequencyTaxTotals":{
                },
                "total":0,
                "shipping":0,
                "primaryCurrencyTotal":0,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "catalogId":null,
            "totalCommerceItemCount":0,
            "externalContext":false,
            "quoteInfo":null,
            "taxPriceInfo":{
                "discounted":false,
                "secondaryCurrencyTaxAmount":0,
                "amount":0,
                "valueAddedTax":0,
                "countyTax":0,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":0,
                "miscTaxInfo":null,
                "countryTax":0,
                "cityTax":0,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "defaultAdditionalPriceListGroups":null,
            "creationSiteId":"siteUS",
            "lastModifiedDate":"2018-05-29T13:22:04.709Z",
            "approvalSystemMessages":[
            ],
            "approverMessages":[
            ],
            "message":null,
            "paymentGroupCount":1,
            "recurringChargePriceInfo":null,
            "organization":null,
            "siteId":"siteUS"
        },
        "state":"incomplete",
        "unAdjustedRefundSubtotal":49.99,
        "returnItemCount":1,
        "trackingNumber":null,
        "totalOrderPromotionValueAdjustmentChange":0,
        "comments":null,
        "profile":{
            "firstName":"Kim",
            "lastName":"Anderson",
            "loyaltyPrograms":[
            ],
            "shippingAddress":{
                "country":"US",
                "firstName":"Kim",
                "lastName":"Anderson",
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "postalCode":"13202",
                "repositoryId":"se-980031",
                "middleName":null,
                "state":"NY"
            },
            "middleName":null,
            "id":"se-570031",
            "login":"kim@example.com",
            "parentOrganization":null,
            "email":"kim@example.com"
        },
        "suggestedTaxRefund":6,
        "nonReturnItemCostAdjustments":[
        ],
        "replacementOrder":null,
        "actualShippingRefund":25,
        "actualTaxRefund":6,
        "otherRefund":0,
        "processed":false,
        "returnLabel":null,
        "totalItemRefund":49.99,
        "authorizationNumber":null,
        "returningItems":true,
        "exchangeProcess":false,
        "replacingItems":false,
        "returnFee":0,
        "totalReturnItemRefund":49.99,
        "submitExchangeAllowed":false,
        "additionalProperties":{
        },
        "originOfReturn":null,
        "totalRefundAmount":80.99,
        "unallocatedAmount":0,
        "nonReturnItemSubtotalAdjustment":0,
        "originatingOrderId":"o210411",
        "adjustmentAmount":31,
        "replaceItemCount":0,
        "returnItemList":[
            {
                "quantityReturned":0,
                "quantityToReturn":1,
                "quantityAvailable":1,
                "returnItemId":"r200388",
                "suggestedTaxRefundShare":4,
                "itemCurrencyCode":"USD",
                "quantityToExchange":0,
                "shippingGroupId":"sg200412",
                "description":null,
                "catalogRefId":"Sku_21Dxy",
                "suggestedShippingRefundShare":25,
                "commerceItemId":"ci20000412",
                "disposition":null,
                "quantityShipped":1,
                "returnReason":"cancelOrder",
                "itemCostAdjustments":[
                    {
                        "commerceItemId":"ci20000412",
                        "amountAdjustment":-49.99,
                        "shippingGroupId":"sg200412",
                        "quantityAdjusted":1,
                        "shippingShareAdjustment":0,
                        "orderDiscountShareAdjustment":0,
                        "manualAdjustmentShareAdjustment":0,
                        "taxShareAdjustment":-4
                    },
                    {
                        "commerceItemId":"ci20000412",
                        "amountAdjustment":0,
                        "shippingGroupId":"sg200412",
                        "quantityAdjusted":0,
                        "shippingShareAdjustment":-25,
                        "orderDiscountShareAdjustment":0,
                        "manualAdjustmentShareAdjustment":0,
                        "taxShareAdjustment":0
                    }
                ],
                "actualShippingRefundShare":25,
                "actualTaxRefundShare":6,
                "suggestedRefundAmount":49.99,
                "quantityReceived":0,
                "refundAmount":49.99
            }
        ]
    }
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |100094|Organization passed in the header is currently inactive| |100095|The order or return request does not belong to the current organization of the shopper profile| |100096|The organization associated to the order or return request was deleted / does not exist| |100097|The organization associated to the order or return request is currently inactive| |100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization| |100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization| |28107|If no order is found of the order id which is mentioned in request paylaod.| |200106|No order data specified| |200105|No Order id specified in request.| |28315|Error occurred while updating the order.| |200115|Error occurred at the time of pricing.| |28364|Error occurred when quote is not allowed.| |30015|SiteId passed in x-ccsite header is currently inactive| |30014|SiteId passed in x-ccsite header is invalid or the site was deleted| |28365|Error occurred while requesting for quote| |28300|Internal error while creating the order| |100101|The shopper profile does not belong to organization passed in the header| |103000|An error occurred while updating the order.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top