syncQuote

put

/ccadmin/v1/orders/syncQuote

Sync Quote. This operation is used to synchronize the quote from the external system. The expected fields are commerce items and their external prices, order external price and notes.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : syncQuote_request
Type: object
Show Source
Example:
{
    "taxPriceInfo":{
        "discounted":false,
        "cityTax":0,
        "secondaryCurrencyTaxAmount":1.5,
        "amount":6.3,
        "countyTax":0.9,
        "amountIsFinal":false,
        "districtTax":0,
        "stateTax":5.4,
        "currencyCode":"USD",
        "countryTax":0
    },
    "id":"o10076",
    "quoteInfo":{
        "providerNote":"10% discount given",
        "providerDate":1.409947604E12,
        "agentId":"A1234",
        "externalId":"T12345",
        "expirationDate":1234
    },
    "externalOrderPriceDetails":{
        "externalPrice":100
    },
    "locale":"en",
    "commerceItems":[
        {
            "quantity":3,
            "productId":"prod10021",
            "returnedQuantity":0,
            "availabilityDate":null,
            "externalId":null,
            "preOrderQuantity":1,
            "catalogRefId":"sku10017",
            "configuratorId":"123455",
            "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
            },
            "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
            },
            "catalogId":null,
            "externalRecurringChargeDetails":{
                "externalRecurringCharge":10,
                "externalRecurringChargeFrequency":"Monthly",
                "externalRecurringChargeDuration":"12"
            },
            "catalogKey":null,
            "productDisplayName":"Wii Classic Controller",
            "externalPriceDetails":{
                "externalPriceQuantity":1,
                "externalPrice":100
            },
            "id":"ci1000076",
            "backOrderQuantity":1,
            "locationInventoryInfoMap":{
                "__NULL__":{
                    "availabilityDate":null,
                    "preOrderQuantity":0,
                    "backOrderQuantity":1,
                    "inStockQuantity":0
                },
                "Boston128":{
                    "availabilityDate":null,
                    "preOrderQuantity":1,
                    "backOrderQuantity":0,
                    "inStockQuantity":1
                }
            },
            "commerceItems":[
                {
                    "quantity":1,
                    "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
                    },
                    "productId":"prod40001",
                    "externalRecurringChargeDetails":{
                        "externalRecurringCharge":10,
                        "externalRecurringChargeFrequency":"Monthly",
                        "externalRecurringChargeDuration":"12"
                    },
                    "catalogRefId":"sku40001"
                },
                {
                    "quantity":1,
                    "productId":"prod40002",
                    "catalogRefId":"sku40005"
                }
            ]
        }
    ]
}
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 : externalOrderPriceDetails
Type: object
Details about external Order pricing.
Show Source
Nested Schema : quoteInfo
Type: object
Details about quote info
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
Nested Schema : items
Type: object
Show Source