getOrderConfirmation

get

/ccstore/v1/orders/confirmation/{uuid}

Get Order Confirmation. Returns the Order Confirmation data, specified by the UUID of the Order. The Order Confirmation data expires within 30 seconds of the order being submitted. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.

Request

Supported Media Types
Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getOrderConfirmation_response
Type: object
Show Source
Nested Schema : billingAddress
Type: object
The billing address details.
Show Source
Nested Schema : discountInfo
Type: object
The order discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information
Show Source
Nested Schema : payments
Type: array
Payment details for the order, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type: object
The order price information.
Show Source
Nested Schema : priceListGroup
Type: object
The order price list group details.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingGroup
Type: object
The 1st shipping group for the order.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shippingMethod
Type: object
The 1st shipping group method details for the order.
Show Source
Nested Schema : shoppingCart
Type: object
The items of the order.
Show Source
Nested Schema : taxPriceInfo
Type: object
The order tax price information details.
Show Source
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
Nested Schema : discountDescList
Type: array
The list of all the order discounts.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
The currency object.
Show Source
Nested Schema : listPriceList
Type: object
List price list details.
Show Source
Nested Schema : salePriceList
Type: object
Sale price list details.
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Shipping Surcharge PriceList 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 : discountInfo
Type: object
The shipping group price information.
Show Source
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
Nested Schema : priceInfo
Type: object
The shipping group price information.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details.
Show Source
Nested Schema : store
Type: object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
Nested Schema : taxPriceInfo
Type: object
The shipping tax price info details.
Show Source
Nested Schema : discountDescList
Type: array
The list of all the order discounts.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedItemPriceInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
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: array
The array of items in the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Show Source
Nested Schema : detailedItemPriceInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
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 : giftWithPurchaseDiscountInfo
Type: array
The gift information.
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 : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "creationTime":1.479743766427E12,
    "sourceSystem":"Cloud Commerce",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "label":"Shipping Instructions",
            "value":"Test Instructions"
        }
    ],
    "payments":[
        {
            "paymentGroupId":"pg70442",
            "amount":58.03,
            "customPaymentProperties":{
                "custProp2":"100",
                "custProp1":"12"
            },
            "gatewayName":"chaseCreditCard",
            "uiIntervention":null,
            "paymentMethod":"creditCard",
            "isAmountRemaining":true,
            "paymentState":"AUTHORIZED"
        }
    ],
    "submittedDate":"2016-11-21T15:56:35.174Z",
    "uuid":"6be4196a-ce3c-4fae-bc04-724c40729a05",
    "organizationId":null,
    "priceInfo":{
        "amount":46.8,
        "total":58.03,
        "shipping":5.95,
        "shippingSurchargeValue":0,
        "tax":5.28,
        "subTotal":52,
        "currencyCode":"USD",
        "totalWithoutTax":52.75
    },
    "shoppingCart":{
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":52,
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "displayName":"Cowboy Shirt",
                "shippingSurchargeValue":0,
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "discountAmount":0,
                "billingAccountId":"billingAcc-123",
                "assetKey":null,
                "commerceItemId":"ci3000411",
                "assetId":"asset10001",
                "price":52,
                "variant":[
                    {
                        "optionValue":"Blue",
                        "optionName":"Color"
                    },
                    {
                        "optionValue":"Medium",
                        "optionName":"Size"
                    }
                ],
                "actionCode":"Add",
                "id":"ci4000032",
                "serviceId":"service-123",
                "unitPrice":52,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"prod10002",
                "salePrice":0,
                "detailedItemPriceInfo":[
                    {
                        "discounted":false,
                        "amount":52,
                        "quantity":1,
                        "tax":4.68,
                        "orderDiscountShare":5.2,
                        "detailedUnitPrice":52,
                        "currencyCode":"USD"
                    }
                ],
                "externalRecurringCharge":10,
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "externalRecurringChargeFrequency":"Monthly",
                "rootAssetKey":null,
                "transactionDate":"2018-06-27T12:59:59Z",
                "externalRecurringChargeDuration":"12",
                "catRefId":"sku40087",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "shopperInput":{
                    "color":"neon",
                    "initials":"M.C.K",
                    "font":"courier"
                },
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "listPrice":52,
                "recurringCharge":10
            }
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://www.example.com/ccstoreui/v1/orders/6be4196a-ce3c-4fae-bc04-724c40729a05"
        }
    ],
    "state":"SUBMITTED",
    "id":"o90008",
    "trackingNumber":"1224",
    "taxPriceInfo":{
        "cityTax":1.85,
        "amount":5.28,
        "valueAddedTax":0,
        "countyTax":1.32,
        "isTaxIncluded":false,
        "miscTax":0,
        "districtTax":0,
        "stateTax":2.11,
        "countryTax":0
    },
    "shippingGroups":[
        {
            "taxPriceInfo":{
                "cityTax":1.85,
                "amount":5.28,
                "valueAddedTax":0,
                "countyTax":1.32,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":2.11,
                "countryTax":0
            },
            "shippingMethod":{
                "shippingTax":0.6,
                "cost":5.95,
                "value":"ground",
                "shippingMethodDescription":"Ground"
            },
            "shippingGroupId":"sg10032",
            "submittedDate":null,
            "priceInfo":{
                "amount":46.8,
                "total":58.03,
                "shipping":5.95,
                "shippingSurchargeValue":0,
                "tax":5.28,
                "subTotal":52,
                "currencyCode":"USD",
                "totalWithoutTax":52.75
            },
            "recurringChargePriceInfo":{
                "amount":30,
                "total":32.4,
                "shipping":0,
                "subTotalByFrequency":[
                    {
                        "amount":30,
                        "frequency":"Monthly"
                    }
                ],
                "taxByFrequency":[
                    {
                        "amount":2.4,
                        "frequency":"Monthly"
                    }
                ],
                "tax":2.4,
                "subTotal":30,
                "currencyCode":"USD",
                "totalWithoutTax":30
            },
            "discountInfo":{
                "orderDiscount":5.2,
                "orderDiscountDescList":[
                    {
                        "promotionLevel":"order",
                        "promotionDesc":"10% off Orders over $40",
                        "promotionId":"promo20011"
                    }
                ],
                "shippingDiscount":0
            },
            "shipOnDate":null,
            "trackingInfo":[
            ],
            "actualShipDate":null,
            "shippingAddress":{
                "lastName":"Shopper",
                "country":"US",
                "address3":"",
                "address2":"",
                "city":"Springfield",
                "address1":"1 Main Street",
                "prefix":"",
                "companyName":"",
                "postalCode":"36130",
                "jobTitle":"",
                "regionName":"Alabama",
                "county":"",
                "suffix":"",
                "firstName":"Test",
                "phoneNumber":"5675675678",
                "alias":"Address##0",
                "faxNumber":"",
                "middleName":"",
                "state":"AL",
                "countryName":"United States",
                "email":"a@a.com"
            },
            "trackingNumber":"1224",
            "items":[
                {
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_CowboyShirt_full.jpg&height=100&width=100",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":52,
                    "returnedQuantity":0,
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "displayName":"Cowboy Shirt",
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "assetKey":null,
                    "commerceItemId":"ci3000411",
                    "assetId":"asset10001",
                    "price":52,
                    "variant":[
                        {
                            "optionValue":"Blue",
                            "optionName":"Color"
                        },
                        {
                            "optionValue":"Medium",
                            "optionName":"Size"
                        }
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Cowboy Shirt",
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "serviceAccountId":"serviceAcc-123",
                    "unitPrice":52,
                    "primaryImageTitle":"Cowboy Shirt",
                    "quantity":1,
                    "pointOfNoRevision":false,
                    "productId":"prod10002",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":52,
                            "quantity":1,
                            "tax":4.68,
                            "orderDiscountShare":5.2,
                            "detailedUnitPrice":52,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "parentAssetKey":null,
                    "active":true,
                    "rootAssetKey":null,
                    "externalRecurringChargeFrequency":"Monthly",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"sku40087",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/cowboy-shirt/product/prod10002",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "activationDate":"2017-06-27T15:30:00Z",
                    "asset":false,
                    "listPrice":52,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ],
            "status":"INITIAL"
        }
    ],
    "lastModifiedDate":"2016-11-21T15:56:35.405Z",
    "shippingMethod":{
        "shippingTax":0.6,
        "cost":5.95,
        "value":"ground"
    },
    "priceListGroup":{
        "endDate":null,
        "displayName":"Default Price Group",
        "listPriceList":{
            "repositoryId":"listPrices"
        },
        "active":true,
        "locale":"en_US",
        "shippingSurchargePriceList":{
            "repositoryId":"shippingSurchargePrices"
        },
        "deleted":false,
        "repositoryId":"defaultPriceGroup",
        "salePriceList":{
            "repositoryId":"salePrices"
        },
        "currency":{
            "symbol":"$",
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"defaultPriceGroup",
        "includeAllProducts":true,
        "startDate":null
    },
    "cartName":"mck Order",
    "creationDate":"2016-11-21T15:56:06.427Z",
    "orderProfileId":"120693",
    "recurringChargePriceInfo":{
        "amount":30,
        "total":32.4,
        "shipping":0,
        "subTotalByFrequency":[
            {
                "amount":30,
                "frequency":"Monthly"
            }
        ],
        "taxByFrequency":[
            {
                "amount":2.4,
                "frequency":"Monthly"
            }
        ],
        "tax":2.4,
        "subTotal":30,
        "currencyCode":"USD",
        "totalWithoutTax":30
    },
    "discountInfo":{
        "orderDiscount":5.2,
        "orderDiscountDescList":[
            {
                "promotionLevel":"order",
                "promotionDesc":"10% off Orders over $40",
                "promotionId":"promo20011"
            }
        ],
        "shippingDiscount":0
    },
    "trackingInfo":[
        {
            "carrierName":"OnTrac",
            "carrierUrl":"http://www.ontrac.com/trackingdetail.asp?tracking=1224",
            "carrierId":"OnTrac",
            "trackingNumber":"1224"
        }
    ],
    "orderLocale":"en",
    "shippingAddress":{
        "lastName":"Shopper",
        "country":"US",
        "address3":"",
        "address2":"",
        "city":"Springfield",
        "address1":"1 Main Street",
        "prefix":"",
        "companyName":"",
        "postalCode":"36130",
        "jobTitle":"",
        "county":"",
        "suffix":"",
        "firstName":"Test",
        "phoneNumber":"5675675678",
        "faxNumber":"",
        "alias":"Address",
        "middleName":"",
        "state":"AL",
        "email":"a@a.com"
    },
    "billingAddress":{
        "lastName":"Shopper",
        "country":"US",
        "address3":"",
        "address2":"",
        "city":"Springfield",
        "address1":"1 Main Street",
        "prefix":"",
        "companyName":"",
        "postalCode":"36130",
        "jobTitle":"",
        "county":"",
        "suffix":"",
        "firstName":"Test",
        "phoneNumber":"5675675678",
        "faxNumber":"",
        "alias":null,
        "middleName":"",
        "state":"AL",
        "email":"a@a.com"
    },
    "giftWithPurchaseOrderMarkers":[
        {
            "quantity":1,
            "selectedQuantity":0,
            "removedQuantity":0,
            "data":"-1275480226",
            "automaticQuantity":0,
            "giftType":"product",
            "autoRemove":true,
            "giftDetail":"camera_1",
            "repositoryId":"200001",
            "failedQuantity":0,
            "value":"promo10002",
            "targetedQuantity":0,
            "key":"atg.gwp"
        }
    ]
}

Default Response

The error response
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