1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Store
  4. Orders
  5. Current

Submit the current order (cart)

post

/ccstore/v1/orders/current/submit

This API is used by the CX Commerce OSF Storefront. This API is currently not used by CX Commerce Classic Storefront but may be used in the future. It may be used in applications outside of CX Commerce Storefront.

Submits the current Order. This endpoint will also capture and authorise payment before submitting the order. If Store Credit or Gift Card payments have been previously applied only the payment group ID and type need to be provided.

This endpoint is part of a group of APIs used in conjunction with each other to perform granular actions on the cart (current incomplete order).

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : submit_request
Type: object
Show Source
Example:
{
    "payments":[
        {
            "cardCVV":"111",
            "nameOnCard":"test test",
            "cardType":"visa",
            "expiryMonth":"01",
            "expiryYear":"2021",
            "billingAddress":{
                "lastName":"Bloggs",
                "country":"US",
                "address3":"",
                "address2":"",
                "city":"Florida City",
                "prefix":"",
                "address1":"111 Florida Dr",
                "postalCode":"33034",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "suffix":"",
                "type":"",
                "firstName":"Joe",
                "phoneNumber":"",
                "alias":"",
                "faxNumber":"",
                "middleName":"",
                "state":"FL",
                "email":null,
                "state_ISOCode":"US-FL"
            },
            "type":"card",
            "cardNumber":"4111111111111111"
        }
    ]
}
Nested Schema : payments
Type: array
Payment details for the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
The billing address details.
Show Source
Nested Schema : customProperties
Type: object
Custom object with dynamic properties. This will be passed to the webhook request
Back to Top

Response

Supported Media Types

200 Response

The model being returned when the POST operation succeeds. It contains an Order representation.
Body ()
Root Schema : submit_response
Type: object
Show Source
Nested Schema : approvalSystemMessages
Type: array
An array of approval messages when order going in pending approval state
Show Source
Nested Schema : billingAddress
Type: object
The billing address details.
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 : 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 price list group object.
Show Source
Nested Schema : pricingMessages
Type: object
The Pricing messages information.
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 : trackingInfo
Type: array
Tracking 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 : orderTotalBySite
Type: object
The map containing order totals by site for all sites in a given order.
Nested Schema : giftWithPurchaseMessages
Type: array
The gift with purchase messages information.
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 : 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 from which 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 : 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 : detailedItemPriceInfo
Type: array
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 : skuProperties
Type: array
Sku properties Information
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 : 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 : 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 : items
Type: array
The array of products in the shopping cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childSkus
Type: array
An array with single primary image url for this item's sku, or its default image.
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 : orderDiscountInfos
Type: array
Array of order promotions received by this item.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
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 : couponCodes
Type: array
The array of coupon codes used to grant promotion providing the discount.
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.573645921E12,
    "sourceSystem":"Cloud Commerce",
    "dynamicProperties":[
    ],
    "payments":[
        {
            "paymentGroupId":"pg230428",
            "amount":14.99,
            "customPaymentProperties":{
                "sample-addnl-property-key2":"sample-payment-property-value2"
            },
            "gatewayName":"demoGenericGiftCardGateway",
            "paymentMethod":"physicalGiftCard",
            "isAmountRemaining":false,
            "paymentState":"AUTHORIZED",
            "currencyCode":"USD",
            "maskedCardNumber":"xxxxxxxxxxxxxxx4103"
        }
    ],
    "submittedDate":"2019-11-13T11:54:01.117Z",
    "uuid":"c52bb39e-c957-4f74-91db-22f7dcf83794",
    "priceInfo":{
        "amount":14.99,
        "total":14.99,
        "shipping":0,
        "shippingSurchargeValue":0,
        "orderTotalBySite":{
            "siteUS":14.99
        },
        "tax":0,
        "subTotal":14.99,
        "currencyCode":"USD",
        "totalWithoutTax":14.99
    },
    "shoppingCart":{
        "items":[
            {
                "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100",
                "rawTotalPrice":14.99,
                "displayName":"Dr. Dolittle",
                "dynamicProperties":[
                ],
                "shippingSurchargeValue":0,
                "discountAmount":0,
                "externalData":[
                ],
                "commerceItemId":"ci21000417",
                "price":14.99,
                "variant":[
                ],
                "primaryImageAltText":"Dr. Dolittle",
                "id":"ci21000417",
                "state":"Added to order",
                "stateKey":"INITIAL",
                "unitPrice":14.99,
                "primaryImageTitle":"Dr. Dolittle",
                "childSKUs":[
                    {
                        "primaryThumbImageURL":null
                    }
                ],
                "amount":14.99,
                "quantity":1,
                "productId":"Product_18Cxi",
                "pointOfNoRevision":false,
                "salePrice":0,
                "orderDiscountInfos":[
                ],
                "detailedItemPriceInfo":[
                    {
                        "discounted":false,
                        "secondaryCurrencyTaxAmount":0,
                        "amount":14.99,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":14.99,
                        "currencyCode":"USD"
                    }
                ],
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "originalCommerceItemId":null,
                "catRefId":"Sku_18Dxi",
                "skuProperties":[
                    {
                        "propertyType":"sku-base",
                        "name":"Not Returnable",
                        "id":"nonreturnable",
                        "value":false
                    },
                    {
                        "propertyType":"sku-base",
                        "name":"Name",
                        "id":"displayName",
                        "value":null
                    },
                    {
                        "propertyType":"sku-base",
                        "name":"Active",
                        "id":"active",
                        "value":true
                    },
                    {
                        "propertyType":"sku-base",
                        "name":"Id",
                        "id":"id",
                        "value":"Sku_18Dxi"
                    },
                    {
                        "propertyType":"sku-base",
                        "name":"Discountable",
                        "id":"discountable",
                        "value":true
                    }
                ],
                "route":"/dr-dolittle/product/Product_18Cxi",
                "discountInfo":[
                ],
                "siteId":"siteUS",
                "shopperInput":{
                },
                "asset":false,
                "listPrice":14.99
            }
        ]
    },
    "links":[
        {
            "method":"PATCH",
            "rel":"/rels/patchCurrentOrder",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current"
        },
        {
            "method":"GET",
            "rel":"/rels/getIncompleteOrder",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current"
        },
        {
            "method":"POST",
            "rel":"/rels/priceCurrentOrder",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/price"
        },
        {
            "method":"POST",
            "rel":"/rels/submitCurrentOrder",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/submit"
        }
    ],
    "id":"o200415",
    "state":"SUBMITTED",
    "taxPriceInfo":{
        "cityTax":0,
        "secondaryCurrencyTaxAmount":0,
        "amount":0,
        "valueAddedTax":0,
        "countyTax":0,
        "isTaxIncluded":false,
        "miscTax":0,
        "districtTax":0,
        "stateTax":0,
        "countryTax":0
    },
    "shippingGroups":[
        {
            "taxPriceInfo":{
                "cityTax":0,
                "secondaryCurrencyTaxAmount":0,
                "amount":0,
                "valueAddedTax":0,
                "countyTax":0,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":0,
                "countryTax":0
            },
            "priceInfo":{
                "amount":14.99,
                "total":14.99,
                "lkpValExcludingFreeShip":null,
                "shipping":0,
                "shippingSurchargeValue":0,
                "tax":0,
                "subTotal":14.99,
                "currencyCode":"USD",
                "totalWithoutTax":14.99
            },
            "discountInfo":{
                "orderDiscount":0,
                "shippingDiscount":0,
                "discountDescList":[
                ]
            },
            "trackingInfo":[
            ],
            "shippingMethod":{
                "secondaryCurrencyTaxAmount":0,
                "shippingTax":0,
                "cost":0,
                "taxIncluded":true,
                "taxCode":"",
                "value":"freeShippingMethod",
                "shippingMethodDescription":"Free Shipping"
            },
            "shippingGroupId":"sg210415",
            "shippingAddress":{
                "lastName":"Blogs",
                "country":"US",
                "address3":"3 The Street",
                "address2":"2 The Street",
                "city":"The City",
                "prefix":"The Prefix",
                "address1":"1 The Street",
                "postalCode":"01887",
                "companyName":"CompanyName",
                "jobTitle":"The Job Title",
                "county":null,
                "suffix":"The Suffix",
                "firstName":"Joe",
                "phoneNumber":"331234567",
                "faxNumber":"331234567",
                "alias":null,
                "middleName":"Syd",
                "state":"MA",
                "email":"p.p@GGGG.com"
            },
            "type":"hardgoodShippingGroup",
            "items":[
                {
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100",
                    "rawTotalPrice":14.99,
                    "returnedQuantity":0,
                    "dynamicProperties":[
                    ],
                    "displayName":"Dr. Dolittle",
                    "shippingSurchargeValue":0,
                    "externalData":[
                    ],
                    "discountAmount":0,
                    "preOrderQuantity":0,
                    "commerceItemId":"ci21000417",
                    "price":14.99,
                    "variant":[
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Dr. Dolittle",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "commerceId":"ci21000417",
                    "unitPrice":14.99,
                    "primaryImageTitle":"Dr. Dolittle",
                    "amount":14.99,
                    "quantity":1,
                    "pointOfNoRevision":false,
                    "productId":"Product_18Cxi",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "secondaryCurrencyTaxAmount":0,
                            "amount":14.99,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":14.99,
                            "currencyCode":"USD"
                        }
                    ],
                    "active":true,
                    "catRefId":"Sku_18Dxi",
                    "skuProperties":[
                        {
                            "propertyType":"sku-base",
                            "name":"Not Returnable",
                            "id":"nonreturnable",
                            "value":false
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Name",
                            "id":"displayName"
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Active",
                            "id":"active",
                            "value":true
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Id",
                            "id":"id",
                            "value":"Sku_18Dxi"
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Discountable",
                            "id":"discountable",
                            "value":true
                        }
                    ],
                    "discountInfo":[
                    ],
                    "route":"/dr-dolittle/product/Product_18Cxi",
                    "siteId":"siteUS",
                    "shopperInput":{
                    },
                    "asset":false,
                    "backOrderQuantity":0,
                    "listPrice":14.99,
                    "status":"INITIAL"
                }
            ],
            "status":"INITIAL"
        }
    ],
    "lastModifiedDate":"2019-11-13T11:54:01.118Z",
    "creationSiteId":"siteUS",
    "approvalSystemMessages":[
    ],
    "shippingMethod":{
        "shippingTax":0,
        "cost":0,
        "value":"freeShippingMethod"
    },
    "priceListGroup":{
        "isTaxIncluded":false,
        "endDate":null,
        "displayName":"Default Price Group",
        "listPriceList":{
            "repositoryId":"listPrices"
        },
        "active":true,
        "isPointsBased":false,
        "locale":"en_US",
        "shippingSurchargePriceList":{
            "repositoryId":"shippingSurchargePrices"
        },
        "deleted":false,
        "taxCalculationType":null,
        "repositoryId":"defaultPriceGroup",
        "salePriceList":{
            "repositoryId":"salePrices"
        },
        "currency":{
            "currencyType":null,
            "symbol":"$",
            "deleted":false,
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"defaultPriceGroup",
        "includeAllProducts":true,
        "startDate":null
    },
    "creationDate":"2019-11-13T11:52:01.000Z",
    "orderProfileId":"310062",
    "orderAction":"order",
    "discountInfo":{
        "orderDiscount":0,
        "orderDiscountDescList":[
        ],
        "shippingDiscount":0
    },
    "trackingInfo":[
    ],
    "orderLocale":"en",
    "shippingAddress":{
        "lastName":"Blogs",
        "country":"US",
        "address3":"3 The Street",
        "address2":"2 The Street",
        "city":"The City",
        "prefix":"The Prefix",
        "address1":"1 The Street",
        "postalCode":"01887",
        "companyName":"CompanyName",
        "jobTitle":"The Job Title",
        "county":null,
        "suffix":"The Suffix",
        "firstName":"Joe",
        "phoneNumber":"331234567",
        "faxNumber":"331234567",
        "alias":null,
        "middleName":"Syd",
        "state":"MA",
        "email":"p.p@GGGG.com"
    },
    "siteId":"siteUS",
    "billingAddress":{
        "lastName":"Blogs",
        "country":"US",
        "address3":"3 The Street",
        "address2":"2 The Street",
        "city":"The City",
        "prefix":"The Prefix",
        "address1":"1 The Street",
        "postalCode":"01887",
        "companyName":"CompanyName",
        "jobTitle":"The Job Title",
        "county":null,
        "suffix":"The Suffix",
        "firstName":"Joe",
        "phoneNumber":"331234567",
        "faxNumber":"331234567",
        "alias":null,
        "middleName":"Syd",
        "state":"MA",
        "email":"p.p@GGGG.com"
    },
    "giftWithPurchaseOrderMarkers":[
    ]
}

400 Response

The error response (which alternates to the default response depending on error reason).
Body ()
Root Schema : errorModelSingleError
Type: object
Show Source

Default Response

The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response.
Body ()
Root Schema : errorModelMultiErrors
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