priceOrder

post

/ccstore/v1/orders/price

Price Order. Price an order. 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
Query Parameters
Header Parameters
Body ()
Root Schema : priceOrder_request
Type: object
Show Source
Example:
{
    "orderId":"o10001",
    "shippingMethod":{
        "value":"ground"
    },
    "payments":[
        {
            "amount":"100.0",
            "giftCardNumber":"6035710988880101071",
            "giftCardPin":"",
            "type":"physicalGiftCard"
        }
    ],
    "shoppingCart":{
        "coupons":[
            {
                "code":"FREETATTOO",
                "level":"item",
                "description":"Explicit Item Discount - FREETATTOO",
                "id":"explicitItemFreeDiscount",
                "totalAdjustment":"-21.99",
                "status":"claimed"
            }
        ],
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "childItems":[
                    {
                        "configurationOptionId":"configOptIDC1P11536825979556",
                        "addOnItem":true,
                        "quantity":5,
                        "priceListGroupId":"price_list_group_1536825979556",
                        "productId":"child1P1Prod1536825979556",
                        "childItems":[
                        ],
                        "configurablePropertyId":"configPropIDC1P11536825979556",
                        "shopperInput":{
                            "fontSIID1536825979556":"Times New Roman",
                            "shrtTxtSIID1536825979556":"This is the P1parent1Prod1536825979556"
                        },
                        "catRefId":"child1P1Sku1536825979556"
                    }
                ],
                "assetKey":null,
                "assetId":"asset10001",
                "stockStatus":true,
                "actionCode":"Add",
                "serviceId":"service-123",
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "dynamicPropertyMode":"pickup",
                "productId":"xprod2165",
                "externalRecurringCharge":10,
                "parentAssetKey":null,
                "rootAssetKey":null,
                "externalRecurringChargeFrequency":"Monthly",
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"xsku2165",
                "externalRecurringChargeDuration":"12",
                "discountInfo":[
                ],
                "customerAccountId":"customerAcc-123",
                "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,
                "recurringCharge":10
            }
        ]
    },
    "reprice":true,
    "shippingAddress":{
        "lastName":"Test",
        "country":"United States",
        "address3":"",
        "address2":"Line 2",
        "city":"Montgomery",
        "prefix":"",
        "address1":"Line 1",
        "postalCode":"36123",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"Steve",
        "phoneNumber":"45454545",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"Alabama",
        "email":"steve.test@oracle.com",
        "selectedState":"AL",
        "state_ISOCode":"US-AL"
    }
}
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information. Required if gift with purchase order marker information is present.
Show Source
Nested Schema : payments
Type: array
The array of payments containing gift card payments or a payment card's issue identification number (IIN) to be sent when repricing the order. Properties are specific to the given payment type e.g. if 'type' is iinPaymentType include only 'IIN', if physicalGiftCard include all other properties
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 : items
Type: object
Show Source
  • The quantity of free sku for this gift selection that has already been auto added to the order.
  • Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
  • Identifier to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
  • The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
  • String identifying the free gift, usually the repository id of the gift type.
  • The type of the gift. (sku, product)
  • atg.gwp
  • The total quantity of sku for this gift selection.
  • The amount of free quantity that has since been manually removed by a Shopper.
  • The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
  • The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
  • The gift with purchase promotion id
Nested Schema : items
Type: object
Show Source
  • The total balance on the gift card. It will be empty if the gift card is added for the first time.
  • Gift card number. Payment type:physicalGiftCard.
  • Gift card pin. Payment type:physicalGiftCard.
  • The issuer identification number (first 6 digits) of the IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout. (iinPaymentType only)
  • The type of the payment. e.g. physicalGiftCard/iinPaymentType.
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 : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
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 : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: object
Discount information.
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
giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in.
Show Source
Nested Schema : giftWithPurchaseSelections
Type: array
The array of gift with purchase selections to be made.
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 : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
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 : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : giftWithPurchaseDiscountInfo
Type: array
The gift selection information.
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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : priceOrder_response
Type: object
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
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 pricing call, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : pricingMessages
Type: object
The Pricing messages information.
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
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 : claimedCouponMultiPromotions
Type: object
The coupons that were claimed
Show Source
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
The implicit order discounts with the order.
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
The unclaimed coupons with the order.
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which promotions were applied
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 : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
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 : giftWithPurchaseMessages
Type: array
The gift with purchase messages information.
Show Source
Nested Schema : promotionUpsellMessages
Type: array
The promotion upsell messages.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : params
Type: array
The list of all message parameters.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : tags
Type: array
The tags the promotion upsell message is associated with.
Show Source
Nested Schema : errorInfo
Type: array
the array of errors, if any
Show Source
Nested Schema : notes
Type: array
the notes (history) for the order
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