requestQuote

post

/ccstore/v1/orders/requestQuote

Request Quote. Request for a quote on an incomplete order or request for a requote on a quoted order. Optionally takes the x-ccasset-language headers to get translated content in another language.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : requestQuote_request
Type: object
Show Source
Example:
{
    "note":"Sample Quote",
    "shippingGroups":[
        {
            "shippingMethod":{
                "value":"standardShippingMethod"
            },
            "shippingAddress":{
                "lastName":"Anderson",
                "country":"United States",
                "address3":"",
                "address2":"",
                "city":"Syracuse",
                "prefix":"",
                "address1":"21 Cedar Ave",
                "postalCode":"13202",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":true,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "repositoryId":"se-980031",
                "alias":"Home",
                "faxNumber":"",
                "middleName":"",
                "state":"New York",
                "selectedState":"NY",
                "email":"kim@example.com",
                "state_ISOCode":"US-NY"
            },
            "items":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "productId":"Product_18Cxi",
                    "externalData":[
                    ],
                    "parentAssetKey":null,
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "rootAssetKey":null,
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"Sku_18Dxi",
                    "assetKey":"12345",
                    "customerAccountId":"customerAcc-123",
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                }
            ]
        }
    ],
    "appliedPromotions":[
    ],
    "profileId":"se-570031",
    "payments":[
        {
            "cardCVV":"service",
            "amount":"43.19",
            "cardType":"",
            "type":"card",
            "cardNumber":"service"
        }
    ],
    "amountRemaining":"43.19",
    "shoppingCart":{
        "coupons":[
        ],
        "items":[
            {
                "quantity":1,
                "productId":"Product_18Cxi",
                "catRefId":"Sku_18Dxi"
            }
        ],
        "orderTotal":43.19
    },
    "id":"o90419",
    "billingAddress":{
        "lastName":"Anderson",
        "country":"United States",
        "address3":"",
        "address2":"",
        "city":"Syracuse",
        "prefix":"",
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "isDefaultAddress":true,
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "repositoryId":"se-980031",
        "alias":"Home",
        "faxNumber":"",
        "middleName":"",
        "state":"New York",
        "selectedState":"NY",
        "email":"kim@example.com",
        "state_ISOCode":"US-NY"
    },
    "requestChannel":"agent"
}
Nested Schema : appliedPromotions
Type: array
The array of applied promotions. If not supplied, it utilizes the promotions in the current incomplete order.
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : payments
Type: array
List of payments
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details. If not supplied, it utilizes the shipping address in the current incomplete order.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order. If not supplied, it utilizes the shipping groups in the current incomplete order.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order. If not supplied, it utilizes the shipping method in the current incomplete order.
Show Source
Nested Schema : shoppingCart
Type: object
The shopping cart contents of the current order. If not supplied, it utilizes the items in the current incomplete order.
Show Source
Nested Schema : submissionErrorCodes
Type: array
Set of error codes recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionErrorMessages
Type: array
List of failure reasons recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionProgress
Type: array
Checkpoints crossed successfully during each unsuccessful retry of queued orders.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
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 : items
Type: object
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 : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : coupons
Type: array
The array of coupons applied to the order.
Show Source
Nested Schema : items
Type: array
The array of products in the shopping cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
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 : giftWithPurchaseSelections
Type: array
The array of gift with purchase selections to be made.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
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 : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
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 : 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 : values
Type: object
The array of values associated with an externalData item.
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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : requestQuote_response
Type: object
Show Source
Nested Schema : approvalSystemMessages
Type: array
The array of messages which are stored during order processing
Show Source
Nested Schema : discountInfo
Type: object
The 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 : giftWithPurchaseCommerceItemMarkers
Type: array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information
Show Source
Nested Schema : orderComments
Type: array
The list of all logged comments for the order.
Show Source
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order.
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : priceListGroup
Type: object
The price list group object.
Show Source
Nested Schema : pricingMessages
Type: object
The Pricing messages information.
Show Source
Nested Schema : profile
Type: object
Profile Information for the order.
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : returnRequests
Type: array
The list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : shoppingCart
Type: object
The shopping cart contents of the current order.
Show Source
Nested Schema : taxPriceInfo
Type: object
tax price information for the order
Show Source
Nested Schema : orderDiscountDescList
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 : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : GiftWithPurchaseMessages
Type: array
The GWP messages information.
Show Source