REST API for Oracle Commerce Cloud December 2017 - getInitialOrder

Previous Next JavaScript must be enabled to correctly display this content

getInitialOrder

post

/ccstore/v1/orders/{id}

Get Initial Order. Returns an incomplete order that has been initiated with the payment type. 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

application/json

Path Parameters

id: Type: string

Required: true

The id is the payment type in the order being retrieved.

Header Parameters

X-CCOrganization: Type: string

Current organization context of the logged in user

Body Parameter

Root Schema : getInitialOrder_request


{
    "PayerID":"JF8GVGL9Y5V7W",
    "paymentId":"PAY-0RH85609009448435KUPPKUA"
}

amount: Type: string

Amount of the order required for PayULatamWeb checkout type.
currency: Type: string

ISO 4127 three-letter currency code required for PayULatamWeb checkout type.
PayerID: Type: string

Payer ID required for paypal checkout type.
paymentId: Type: string

Payment ID required for both Paypal checkout and PayULatamWeb checkout types.
signature: Type: string

Signature generated required for PayULatamWeb checkout type.
transactionStatus: Type: string

Status of the transaction required for PayULatamWeb checkout type.
transactionType: Type: string

Type of the transaction required for PayULatamWeb checkout type.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getInitialOrder_response

creationDate: Type: string

The creation date in ISO format.
creationTime: Type: number

The creation time in long seconds.
discountInfo: Type: object discountInfo

Additional Properties Allowed:

The discount information.
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

Read-only list of dynamic properties for the order along with meta-data.
id: Type: string

The order ID.
lastModifiedDate: Type: string

The order recent modified date in ISO format.
orderLocale: Type: string

The locale in which order submitted.
payments: Type: object payments

Additional Properties Allowed:

Payment details for the order, including additional properties specific to the payment type.
priceInfo: Type: object priceInfo

Additional Properties Allowed:

The price information.
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

The price list group object.
quoteInfo: Type: object quoteInfo

Additional Properties Allowed:

the quote information of the order
recurringChargePriceInfo: Type: object recurringChargePriceInfo

Additional Properties Allowed:

Recurring charge price information.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details.
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:

The shipping groups for the order.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order.
shoppingCart: Type: object shoppingCart

Additional Properties Allowed:

The shopping cart contents of the current order.
sourceSystem: Type: string

The system where the order originated.
uuid: Type: string

The unique ID for the order.

Nested Schema : discountInfo

Type: object

The discount information.

orderDiscount: Type: integer

The order discount.
orderDiscountDescList: Type: array orderDiscountDescList

Additional Properties Allowed:

The list of all the order discounts.
shippingDiscount: Type: integer

The shipping discount.

Nested Schema : dynamicProperties

Type: array

Read-only list of dynamic properties for the order along with meta-data.

Type: object items

Additional Properties Allowed:

Nested Schema : payments

Type: object

Payment details for the order, including additional properties specific to the payment type.

gatewayName: Type: string

Name of the payment gateway.
paymentGroupId: Type: string

The payment group ID used for the order.
paymentId: Type: string

Payment ID relevant to the payment type.
paymentMethod: Type: string

Mode of payment.
paymentState: Type: string

Current state for the payment.
type: Type: string

Payment type. e.g. paypalCheckout, payULatamWebcheckout.
uiIntervention: Type: string

Represents UI Intervention.

Nested Schema : priceInfo

Type: object

The price information.

amount: Type: number

The total order amount.
currencyCode: Type: string

The currency code.
shipping: Type: number

The total shipping cost.
shippingSurchargeValue: Type: number

Extra handling costs for shipping the products.
subTotal: Type: number

Sub-total.
tax: Type: number

The total tax amount.
total: Type: number

The order total.

Nested Schema : priceListGroup

Type: object

The price list group object.

repositoryId: Type: string

Repository ID of the price list group.

Nested Schema : quoteInfo

Type: object

the quote information of the order

errorInfo: Type: array errorInfo

Additional Properties Allowed:

the array of errors, if any
expirationDate: Type: string

the expiration date of the quoted order, if any
externalId: Type: string

the external id for the quote
notes: Type: array notes

Additional Properties Allowed:

the notes (history) for the order
providerNote: Type: string

the provider note for the quoted order
quoteDate: Type: number

the date the order was quoted in milliseconds
rejectionDate: Type: string

rejection date of the quoted order
rejectionNote: Type: string

the rejection note for an order whose quote has been rejected by user
requestDate: Type: string

the date when the quote was requested in ISO format

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

amount: Type: number

The monetary amount of this recurring charge.
currencyCode: Type: string

The currency code for the monetary amounts. A three character currency code such as USD.
frequencyAmountTotals: Type: array frequencyAmountTotals

Additional Properties Allowed:

The total for each recurring charge frequency
frequencyTaxTotals: Type: array frequencyTaxTotals

Additional Properties Allowed:

The tax for each recurring charge frequency
shipping: Type: number

Cost of shipping the product.
subTotal: Type: number

The sub-total price of the recurring charge.
tax: Type: number

Monetary tax amount.
total: Type: number

The total price of the recurring charge.
totalWithoutTax: Type: number

Total of recurring amount without tax included.

Nested Schema : shippingAddress

Type: object

The shipping address details.

address1: Type: string

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

County.
email: Type: string

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

First name
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Country code.
selectedState: Type: string

State code.
state: Type: string

State.
state_ISOCode: Type: string

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingGroups

Type: array

The shipping groups for the order.

Type: object items

Additional Properties Allowed:

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

cost: Type: number

The total cost of shipping.
value: Type: string

The shipping method applied to the order.

Nested Schema : shoppingCart

Type: object

The shopping cart contents of the current order.

items: Type: array items

Additional Properties Allowed:

The array of products in the shopping cart.

Nested Schema : orderDiscountDescList

Type: array

The list of all the order discounts.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

coupon: Type: string

The coupon code.
promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

The promotion ID.
promotionLevel: Type: string

The promotion level.
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.

Nested Schema : items

Type: object

id: Type: string

The ID of the dynamic property.
label: Type: string

The label of the dynamic property.
value: Type: string

The value of the dynamic property.

Nested Schema : errorInfo

Type: array

the array of errors, if any

Type: string

Nested Schema : notes

Type: array

the notes (history) for the order

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

profileId: Type: string

the profile id of the user
profileType: Type: string

the profile type of the user that requested the quote
requestDate/quoteDate/rejectionDate: Type: number

the request/quote/rejection date for the note
requesterNote/providerNote/rejectionNote: Type: string

the requester/provider/rejection note

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Type: object items

Additional Properties Allowed:

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

frequency: Type: string

The frequency for the item's total e.g. Monthly.
total: Type: string

The total amount for the frequency.

Nested Schema : items

Type: object

frequency: Type: string

The frequency for the item's tax e.g. Monthly.
tax: Type: string

The tax amount for the frequency.

Nested Schema : items

Type: object

items: Type: array items

Additional Properties Allowed:

The array of products in the shipping group.
priceInfo: Type: object priceInfo

Additional Properties Allowed:

The price information.
recurringChargePriceInfo: Type: object recurringChargePriceInfo

Additional Properties Allowed:

Recurring charge price information.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order.
surcharge: Type: number

The shipping surcharge.

Nested Schema : items

Type: array

The array of products in the shipping group.

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

The price information.

amount: Type: number

The total order amount.
currencyCode: Type: string

The currency code.
shipping: Type: number

The total shipping cost.
shippingSurchargeValue: Type: number

Extra handling costs for shipping the products.
subTotal: Type: number

Sub-total.
tax: Type: number

The total tax amount.
total: Type: number

The order total.

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

amount: Type: number

The monetary amount of this recurring charge.
currencyCode: Type: string

The currency code for the monetary amounts. A three character currency code such as USD.
frequencyAmountTotals: Type: array frequencyAmountTotals

Additional Properties Allowed:

The total for each recurring charge frequency
frequencyTaxTotals: Type: array frequencyTaxTotals

Additional Properties Allowed:

The tax for each recurring charge frequency
shipping: Type: number

Cost of shipping the product.
subTotal: Type: number

The sub-total price of the recurring charge.
tax: Type: number

Monetary tax amount.
total: Type: number

The total price of the recurring charge.
totalWithoutTax: Type: number

Total of recurring amount without tax included.

Nested Schema : shippingAddress

Type: object

The shipping address details.

address1: Type: string

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

County.
email: Type: string

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

First name
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Country code.
selectedState: Type: string

State code.
state: Type: string

State.
state_ISOCode: Type: string

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

cost: Type: number

The total cost of shipping.
shippingMethodDescription: Type: string

The description of the shipping method.
shippingTax: Type: number

The shipping tax.
value: Type: string

The shipping method applied to the order.

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the item by the configurator system.
activationDate: Type: string

The activation date in ISO format.
active: Type: boolean

active or not.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

The category to which the product belongs.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
discountInfo: Type: array discountInfo

Additional Properties Allowed:

The discount information.
displayName: Type: string

The name of the product.
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

Array of custom properties at order line item level.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
price: Type: integer

The actual price of the product.
productId: Type: string

ID of the product in the cart.
quantity: Type: integer

The quantity of the product.
rawTotalPrice: Type: integer

The raw price of the product.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.
skuProperties: Type: array skuProperties

Additional Properties Allowed:

Sku properties Information
unitPrice: Type: integer

The unit price of the product.
variant: Type: array variant

Additional Properties Allowed:

List of variants for the product.

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : discountInfo

Type: array

The discount information.

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicProperties

Type: array

Array of custom properties at order line item level.

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Type: object items

Additional Properties Allowed:

Nested Schema : skuProperties

Type: array

Sku properties Information

Type: object items

Additional Properties Allowed:

Nested Schema : variant

Type: array

List of variants for the product.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

coupon: Type: string

The coupon ID.
promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

The promotion ID.
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.

Nested Schema : items

Type: object

id: Type: string

The ID of the dynamic property.
label: Type: string

The label of the dynamic property.
value: Type: string

The value of the dynamic property.

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

dynamic_property_key: Type: string

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

id: Type: string

ID of the Dynamic SKU Property.
name: Type: string

Name of the Dynamic SKU Property.
propertyType: Type: string

Type that indicates whether it is a base or a custom SKU property,
value: Type: string

Value of the Dynamic SKU Property.

Nested Schema : items

Type: object

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value.

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Type: object items

Additional Properties Allowed:

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

frequency: Type: string

The frequency for the item's total e.g. Monthly.
total: Type: string

The total amount for the frequency.

Nested Schema : items

Type: object

frequency: Type: string

The frequency for the item's tax e.g. Monthly.
tax: Type: string

The tax amount for the frequency.

Nested Schema : items

Type: array

The array of products in the shopping cart.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the item by the configurator system.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

The category to which the product belongs.
childItems: Type: array childItems

Additional Properties Allowed:

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.
commerceItemId: Type: string

The unique line item ID distinguisher.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
discountInfo: Type: array discountInfo

Additional Properties Allowed:

The discount information.
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

Array of custom properties at order line item level.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
price: Type: integer

The actual price of the product.
productId: Type: string

ID of the product in the cart.
quantity: Type: integer

The quantity of the product.
rawTotalPrice: Type: integer

The raw price of the product.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.
shippingSurchargeValue: Type: integer

The extra handling cost for shipping the product.
unitPrice: Type: integer

The unit price of the product.

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.

Type: object items

Additional Properties Allowed:

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : discountInfo

Type: array

The discount information.

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicProperties

Type: array

Array of custom properties at order line item level.

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the item by the configurator system.
activationDate: Type: string

The activation date in ISO format.
amount: Type: integer

The total amount of this item including its child items amounts.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

skuid of the item.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
displayName: Type: string

The name of the product.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
id: Type: string

Repository id of the commerce item.
productId: Type: string

ID of the product in the cart.
quantity: Type: integer

The quantity of the product.
rawTotalPrice: Type: integer

The raw price of the product.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.
unitPrice: Type: integer

The unit price of the product.

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

dynamic_property_key: Type: string

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

coupon: Type: string

The coupon ID.
promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

The promotion ID.
promotionLevel: Type: string

The promotion level.
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.
totalAdjustment: Type: number

Total adjustment by the promotion.

Nested Schema : items

Type: object

id: Type: string

The ID of the dynamic property.
label: Type: string

The label of the dynamic property.
value: Type: string

The value of the dynamic property.

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

dynamic_property_key: Type: string

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Example 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@cloudlake.com"
            },
            "trackingNumber":null,
            "items":[
                {
                    "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,
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "displayName":"Davis Martini Glass",
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "commerceItemId":"ci3000411",
                    "assetId":"asset10001",
                    "price":14,
                    "variant":[
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Davis Martini Glass",
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "serviceAccountId":"serviceAcc-123",
                    "unitPrice":14,
                    "primaryImageTitle":"Davis Martini Glass",
                    "quantity":1,
                    "productId":"xprod2076",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":14,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":14,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "active":true,
                    "externalRecurringChargeFrequency":"Monthly",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"xsku2076",
                    "skuProperties":[
                    ],
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/davis-martini-glass/product/xprod2076",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "activationDate":"2017-06-27T15:30:00Z",
                    "listPrice":14,
                    "recurringCharge":10,
                    "status":"INITIAL"
                },
                {
                    "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",
                    "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",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "listPrice":199,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ],
            "status":"INITIAL"
        }
    ],
    "creationTime":1.430862700011E12,
    "lastModifiedDate":"2015-05-05T21:51:51.708Z",
    "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"
    },
    "creationDate":"2015-05-05T21:51:40.011Z",
    "orderProfileId":"110727",
    "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":[
            {
                "unitPrice":14,
                "serviceAccountId":"serviceAcc-123",
                "deactivationDate":"2018-06-27T12:59:59Z",
                "quantity":1,
                "rawTotalPrice":14,
                "productId":"xprod2076",
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "externalRecurringCharge":10,
                "shippingSurchargeValue":0,
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "externalRecurringChargeFrequency":"Monthly",
                "externalRecurringChargeDuration":"12",
                "catRefId":"xsku2076",
                "commerceItemId":"ci3000411",
                "discountInfo":[
                ],
                "customerAccountId":"customerAcc-123",
                "price":14,
                "assetId":"asset10001",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "actionCode":"Add",
                "activationDate":"2017-06-27T15:30:00Z",
                "serviceId":"service-123",
                "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,
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "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@cloudlake.com"
    },
    "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 error response

Body

Root Schema : errorModel

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "PayerID": "JF8GVGL9Y5V7W",
  "paymentId": "PAY-0RH85609009448435KUPPKUA"
}

Sample Response Payload returned by endpoint:

{
  "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@cloudlake.com"
    },
    "trackingNumber": null,
    "items": [
      {
        "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,
        "dynamicProperties": [{
          "id": "dynamicPropertyMode",
          "label": "Mode",
          "value": "pickup"
        }],
        "displayName": "Davis Martini Glass",
        "shippingSurchargeValue": 0,
        "discountAmount": 0,
        "externalData": [],
        "billingAccountId": "billingAcc-123",
        "commerceItemId": "ci3000411",
        "assetId": "asset10001",
        "price": 14,
        "variant": [],
        "onSale": false,
        "primaryImageAltText": "Davis Martini Glass",
        "actionCode": "Add",
        "serviceId": "service-123",
        "stateDetailsAsUser": "The item has been initialized within the shipping group",
        "serviceAccountId": "serviceAcc-123",
        "unitPrice": 14,
        "primaryImageTitle": "Davis Martini Glass",
        "quantity": 1,
        "productId": "xprod2076",
        "salePrice": 0,
        "detailedItemPriceInfo": [{
          "discounted": false,
          "amount": 14,
          "quantity": 1,
          "tax": 0,
          "orderDiscountShare": 0,
          "detailedUnitPrice": 14,
          "currencyCode": "USD"
        }],
        "externalRecurringCharge": 10,
        "active": true,
        "externalRecurringChargeFrequency": "Monthly",
        "externalRecurringChargeDuration": "12",
        "catRefId": "xsku2076",
        "skuProperties": [],
        "customerAccountId": "customerAcc-123",
        "discountInfo": [],
        "route": "/davis-martini-glass/product/xprod2076",
        "detailedRecurringChargeInfo": [{
          "discounted": false,
          "amount": 10,
          "quantity": 1,
          "tax": 0,
          "orderDiscountShare": 0,
          "detailedUnitPrice": 10,
          "currencyCode": "USD"
        }],
        "activationDate": "2017-06-27T15:30:00Z",
        "listPrice": 14,
        "recurringCharge": 10,
        "status": "INITIAL"
      },
      {
        "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",
        "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",
        "detailedRecurringChargeInfo": [{
          "discounted": false,
          "amount": 10,
          "quantity": 1,
          "tax": 0,
          "orderDiscountShare": 0,
          "detailedUnitPrice": 10,
          "currencyCode": "USD"
        }],
        "listPrice": 199,
        "recurringCharge": 10,
        "status": "INITIAL"
      }
    ],
    "status": "INITIAL"
  }],
  "creationTime": 1430862700011,
  "lastModifiedDate": "2015-05-05T21:51:51.708Z",
  "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"},
  "creationDate": "2015-05-05T21:51:40.011Z",
  "orderProfileId": "110727",
  "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": [
    {
      "unitPrice": 14,
      "serviceAccountId": "serviceAcc-123",
      "deactivationDate": "2018-06-27T12:59:59Z",
      "quantity": 1,
      "rawTotalPrice": 14,
      "productId": "xprod2076",
      "dynamicProperties": [{
        "id": "dynamicPropertyMode",
        "label": "Mode",
        "value": "pickup"
      }],
      "externalRecurringCharge": 10,
      "shippingSurchargeValue": 0,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "externalRecurringChargeFrequency": "Monthly",
      "externalRecurringChargeDuration": "12",
      "catRefId": "xsku2076",
      "commerceItemId": "ci3000411",
      "discountInfo": [],
      "customerAccountId": "customerAcc-123",
      "price": 14,
      "assetId": "asset10001",
      "detailedRecurringChargeInfo": [{
        "discounted": false,
        "amount": 10,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 10,
        "currencyCode": "USD"
      }],
      "actionCode": "Add",
      "activationDate": "2017-06-27T15:30:00Z",
      "serviceId": "service-123",
      "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,
      "detailedRecurringChargeInfo": [{
        "discounted": false,
        "amount": 10,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 10,
        "currencyCode": "USD"
      }],
      "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@cloudlake.com"
  },
  "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": 1477479521002,
      "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
  }
}