1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Store
  4. Orders

Retrieve an initial order by payment type

post

/ccstore/v1/orders/{id}

Returns an incomplete order that has been initiated with the ID of the payment type supplied.

Request

Supported Media Types
Path Parameters
  • The ID of the payment type in the order being retrieved.
Header Parameters
Body ()
Root Schema : getInitialOrder_request
Type: object
Show Source
Example:
{
    "PayerID":"JF8GVGL9Y5V7W",
    "paymentId":"PAY-0RH85609009448435KUPPKUA"
}
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : getInitialOrder_response
Type: object
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 : payments
Type: object
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
  • The total order amount.
  • The currency code.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • The shipping surcharges added at item level in monetary currency.
  • This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency.
    Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
    3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency.
    Prerequisites for the value in this Attribute:
    1. PriceList configured for the site is in custom currency.
    2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
    3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • The total shipping cost.
  • Extra handling costs for shipping the products.
  • The sub-total amount.
  • The total tax amount.
  • Total excluding shipping and tax in monetary currency
  • The order total.
Nested Schema : priceListGroup
Type: object
The price list group object.
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 : 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 : 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 : 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
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
Nested Schema : priceInfo
Type: object
The 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 for the order.
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 : items
Type: object
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 : 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: array
The array of products in the shopping cart.
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 a 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: 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 : 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 : 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
Example Response (application/json)
{
    "shippingGroups":[
        {
            "shippingMethod":{
                "shippingTax":0,
                "cost":0,
                "value":"free",
                "shippingMethodDescription":"Free Shipping"
            },
            "shippingGroupId":"sg10005",
            "submittedDate":null,
            "priceInfo":{
                "amount":213,
                "total":213,
                "shipping":0,
                "shippingSurchargeValue":0,
                "tax":0,
                "subTotal":213,
                "currencyCode":"USD",
                "totalWithoutTax":213
            },
            "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":0,
                "shippingDiscount":0,
                "discountDescList":[
                ]
            },
            "shipOnDate":null,
            "trackingInfo":[
            ],
            "actualShipDate":null,
            "shippingAddress":{
                "lastName":"Shopper",
                "country":"US",
                "address3":null,
                "address2":null,
                "city":"San Jose",
                "address1":"1 Main St",
                "prefix":null,
                "companyName":null,
                "postalCode":"95131",
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "firstName":"Test",
                "phoneNumber":null,
                "alias":null,
                "faxNumber":null,
                "middleName":null,
                "state":"CA",
                "email":"shopper-1@example.com"
            },
            "trackingNumber":null,
            "items":[
                {
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "discountAmount":0,
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "assetKey":"12345",
                    "price":14,
                    "variant":[
                    ],
                    "primaryImageAltText":"Davis Martini Glass",
                    "actionCode":"Add",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "unitPrice":14,
                    "pointOfNoRevision":false,
                    "productId":"xprod2076",
                    "parentAssetKey":null,
                    "active":true,
                    "catRefId":"xsku2076",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/davis-martini-glass/product/xprod2076",
                    "shopperInput":{
                        "color":"neon",
                        "initials":"M.C.K",
                        "font":"courier"
                    },
                    "activationDate":"2017-06-27T15:30:00Z",
                    "recurringCharge":10,
                    "status":"INITIAL",
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/HOME_HueyMartiniGlass_full.jpg&height=100&width=100",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":14,
                    "returnedQuantity":0,
                    "displayName":"Davis Martini Glass",
                    "shippingSurchargeValue":0,
                    "externalData":[
                    ],
                    "commerceItemId":"ci3000411",
                    "onSale":false,
                    "serviceId":"service-123",
                    "serviceAccountId":"serviceAcc-123",
                    "primaryImageTitle":"Davis Martini Glass",
                    "quantity":1,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":14,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":14,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "rootAssetKey":null,
                    "externalRecurringChargeFrequency":"Monthly",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "externalRecurringChargeDuration":"12",
                    "skuProperties":[
                    ],
                    "siteId":"siteUS",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "asset":false,
                    "listPrice":14
                },
                {
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/ST_ShayaDiningChair_full.jpg&height=100&width=100",
                    "rawTotalPrice":199,
                    "returnedQuantity":0,
                    "displayName":"Shaya Dining Chair",
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "price":199,
                    "variant":[
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Shaya Dining Chair",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "unitPrice":199,
                    "primaryImageTitle":"Shaya Dining Chair",
                    "quantity":1,
                    "productId":"xprod2117",
                    "pointOfNoRevision":false,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":199,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":199,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "active":true,
                    "externalRecurringChargeFrequency":"Monthly",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"xsku2117",
                    "skuProperties":[
                    ],
                    "discountInfo":[
                    ],
                    "route":"/shaya-dining-chair/product/xprod2117",
                    "siteId":"siteUS",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "shopperInput":{
                        "color":"blue",
                        "initials":"D.W",
                        "font":"courier"
                    },
                    "listPrice":199,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ],
            "status":"INITIAL"
        }
    ],
    "creationTime":1.430862700011E12,
    "lastModifiedDate":"2015-05-05T21:51:51.708Z",
    "creationSiteId":"siteUS",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "label":"Shipping Instructions",
            "value":"Test Instructions"
        }
    ],
    "payments":{
        "paymentGroupId":"pg10003",
        "amount":213,
        "gatewayName":"PP-A",
        "paymentId":"PAY-21F96134TN204932AKVETVYY",
        "uiIntervention":null,
        "transaction_state":"created",
        "paymentMethod":"onlinePaymentGroup",
        "isAmountRemaining":true,
        "paymentState":"INITIAL",
        "type":"paypalCheckout",
        "intent":"authorize"
    },
    "priceListGroup":{
        "repositoryId":"UsDollar"
    },
    "cartName":"Test Name",
    "creationDate":"2015-05-05T21:51:40.011Z",
    "orderProfileId":"110727",
    "orderAction":"order",
    "priceInfo":{
        "amount":213,
        "total":213,
        "shipping":0,
        "shippingSurchargeValue":0,
        "tax":0,
        "subTotal":213,
        "currencyCode":"USD"
    },
    "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":0,
        "orderDiscountDescList":[
            {
                "promotionLevel":"item",
                "coupon":"FREETATTOO",
                "totalAdjustment":"-21.99",
                "promotionDesc":"Explicit Item Discount - FREETATTOO",
                "promotionId":"explicitItemFreeDiscount"
            }
        ],
        "shippingDiscount":0
    },
    "shoppingCart":{
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":14,
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "shippingSurchargeValue":0,
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "assetKey":"12345",
                "commerceItemId":"ci3000411",
                "price":14,
                "actionCode":"Add",
                "serviceId":"service-123",
                "unitPrice":14,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"xprod2076",
                "externalRecurringCharge":10,
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "externalRecurringChargeFrequency":"Monthly",
                "rootAssetKey":null,
                "transactionDate":"2018-06-27T12:59:59Z",
                "externalRecurringChargeDuration":"12",
                "catRefId":"xsku2076",
                "discountInfo":[
                ],
                "customerAccountId":"customerAcc-123",
                "siteId":"siteUS",
                "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
            },
            {
                "unitPrice":199,
                "quantity":1,
                "rawTotalPrice":199,
                "productId":"xprod2117",
                "externalRecurringCharge":10,
                "shippingSurchargeValue":0,
                "externalPriceQuantity":2,
                "externalRecurringChargeFrequency":"Monthly",
                "catRefId":"xsku2117",
                "externalRecurringChargeDuration":"12",
                "externalPrice":50.12,
                "discountInfo":[
                ],
                "price":199,
                "siteId":"siteUS",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "shopperInput":{
                    "color":"blue",
                    "initials":"D.W",
                    "font":"courier"
                },
                "recurringCharge":10
            }
        ]
    },
    "orderLocale":"en",
    "shippingAddress":{
        "lastName":"Shopper",
        "country":"US",
        "address3":"",
        "address2":"",
        "city":"San Jose",
        "address1":"1 Main St",
        "prefix":"",
        "companyName":"",
        "postalCode":"95131",
        "jobTitle":"",
        "county":"",
        "suffix":"",
        "firstName":"Test",
        "phoneNumber":"",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"CA",
        "email":"shopper-1@example.com"
    },
    "siteId":"siteUS",
    "links":[
        {
            "rel":"self",
            "href":"http://www.example.com/ccstoreui/v1/orders/paypalCheckout"
        }
    ],
    "state":"INCOMPLETE",
    "id":"o10002",
    "quoteInfo":{
        "providerNote":null,
        "notes":[
            {
                "profileType":null,
                "profileId":"120213",
                "requestDate":1.477479521002E12,
                "requesterNote":"This is a sample quote"
            }
        ],
        "rejectionDate":null,
        "requestDate":"2016-10-26T10:58:41.002Z",
        "errorInfo":null,
        "externalID":null,
        "rejectionNote":null,
        "quoteDate":null,
        "expirationDate":null
    }
}

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
Error CodeDescriptionPossible Fix
28350Order not found.An pre-submit order must already exist.

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