REST API for Oracle Commerce Cloud December 2017 - getOrder

Previous Next JavaScript must be enabled to correctly display this content

getOrder

get

/ccagent/v1/orders/{id}

Get Order. Loads an order details from the repository. Maps all required fields for order details. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

Commerce id of order.

Query Parameters

includeResult: Type: string

It is "full" if full result is to be included.

Header Parameters

X-CCOrganization: Type: string

the organization Id in which order should be created

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getOrder_response

approvalSystemMessages: Type: array approvalSystemMessages

Additional Properties Allowed:

An array of approval messages when order going in pending approval state
approverMessages: Type: array approverMessages

Additional Properties Allowed:

An array of approval messages when approver approving order
approvers: Type: array approvers

Additional Properties Allowed:

List of approvers of the organization.
billingAddress: Type: object billingAddress

Additional Properties Allowed:

The billing address details.
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.
giftWithPurchaseInfo: Type: array giftWithPurchaseInfo

Additional Properties Allowed:

The gift information.
giftWithPurchaseOrderMarkers: Type: array giftWithPurchaseOrderMarkers

Additional Properties Allowed:

gift with purchase order marker information
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.
orderProfileId: Type: string

The profile-id of the order.
orderStatus: Type: string

Status of the order.
paymentGroupId: Type: string

The payment group ID used for the order.
payments: Type: array 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.
scheduledOrder: Type: array scheduledOrder

Additional Properties Allowed:

schedule order 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/order: Type: object shoppingCart/order

Additional Properties Allowed:

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

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

The order submitted date in ISO format.
trackingInfo: Type: array trackingInfo

Additional Properties Allowed:

Tracking Information for the Order.
uuid: Type: string

The unique ID for the order.

Nested Schema : approvalSystemMessages

Type: array

An array of approval messages when order going in pending approval state

Type: string

Nested Schema : approverMessages

Type: array

An array of approval messages when approver approving order

Type: string

Nested Schema : approvers

Type: array

List of approvers of the organization.

Type: object items

Additional Properties Allowed:

Nested Schema : billingAddress

Type: object

The billing 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 : discountInfo

Type: object

The discount information.

claimedCouponMultiPromotions: Type: object claimedCouponMultiPromotions

Additional Properties Allowed:

The coupons that were claimed
orderCouponsMap: Type: array orderCouponsMap

Additional Properties Allowed:

The list of all the coupons with the order.
orderDiscount: Type: integer

The order discount.
orderImplicitDiscountList: Type: array orderImplicitDiscountList

Additional Properties Allowed:

The implicit order discounts with the order.
shippingDiscount: Type: integer

The shipping discount.
unclaimedCouponMultiPromotions: Type: object unclaimedCouponMultiPromotions

Additional Properties Allowed:

The coupons that were not claimed
unclaimedCouponsMap: Type: object unclaimedCouponsMap

Additional Properties Allowed:

The unclaimed coupons with the order.

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 : giftWithPurchaseInfo

Type: array

The gift information.

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseOrderMarkers

Type: array

gift with purchase order marker information

Type: object items

Additional Properties Allowed:

Nested Schema : payments

Type: array

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

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 : 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 : scheduledOrder

Type: array

schedule order information

Type: object items

Additional Properties Allowed:

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/order

Type: object

The shopping-cart or order contents of the current order.

items: Type: array items

Additional Properties Allowed:

The array of products in the shopping cart.

Nested Schema : trackingInfo

Type: array

Tracking Information for the Order.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

approverId: Type: string

Id of approver.
firstName: Type: string

First name of approver.
lastName: Type: string

Last name of approver.

Nested Schema : claimedCouponMultiPromotions

Type: object

The coupons that were claimed

coupon code: Type: array coupon code

Additional Properties Allowed:

Coupon Code, corresponding to which promotions were applied

Nested Schema : orderCouponsMap

Type: array

The list of all the coupons with the order.

Type: object items

Additional Properties Allowed:

Nested Schema : orderImplicitDiscountList

Type: array

The implicit order discounts with the order.

Type: object items

Additional Properties Allowed:

Nested Schema : unclaimedCouponMultiPromotions

Type: object

The coupons that were not claimed

coupon code: Type: array coupon code

Additional Properties Allowed:

Coupon Code, corresponding to which some promotions were not applied

Nested Schema : unclaimedCouponsMap

Type: object

The unclaimed coupons with the order.

coupon code: Type: array coupon code

Additional Properties Allowed:

Coupon Code, corresponding to which some promotions were not applied

Nested Schema : coupon code

Type: array

Coupon Code, corresponding to which promotions were applied

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

promotionDesc: Type: string

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

Promotion Id
promotionLevel: Type: string

Promotion Level
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

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

Adjustment done by the promotion

Nested Schema : items

Type: object

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: string

The total adjustment.

Nested Schema : items

Type: object

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: string

The total adjustment.

Nested Schema : coupon code

Type: array

Coupon Code, corresponding to which some promotions were not applied

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

promotionDesc: Type: string

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

Promotion Id
promotionLevel: Type: string

Promotion Level
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.

Nested Schema : coupon code

Type: array

Coupon Code, corresponding to which some promotions were not applied

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

promotionDesc: Type: string

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

Promotion Id
promotionLevel: Type: string

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 : items

Type: object

giftWithPurchaseDetail: Type: string

String identifying the free gift, usually the repository id of the gift type.
giftWithPurchaseIdentifier: Type: integer

An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
giftWithPurchaseQuantityAvailableForSelection: Type: number

gift quantity available for selection
giftWithPurchaseType: Type: string

The type of the gift. (sku, product)
promotionId: Type: string

The gift with purchase promotion id

Nested Schema : items

Type: object

automaticQuantity: Type: number

The quantity of free sku for this gift selection that has already been auto added to the order.
autoRemove: Type: boolean

Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
data: Type: integer

Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
failedQuantity: Type: number

The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
giftDetail: Type: string

String identifying the free gift, usually the repository id of the gift type.
giftType: Type: string

The type of the gift. (sku, product)
key: Type: string

atg.gwp
quantity: Type: number

The total quantity of sku for this gift selection.
removedQuantity: Type: number

The amount of free quantity that has since been manually removed by a Shopper.
selectedQuantity: Type: integer

The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
targetedQuantity: Type: number

The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
value: Type: string

The gift with purchase promotion id

Nested Schema : items

Type: object

amount: Type: number

Amount authorized from the payment group.
balance: Type: number

Total available balance on the gift card.
gatewayName: Type: string

Payment gateway name. e.g. chaseCreditCard.
giftCardNumber: Type: string

Gift card number.
isAmountRemaining: Type: boolean

A boolean to decide if more payment can be made from this payment group.
maskedCardNumber: Type: string

Masked gift card number.
paymentGroupId: Type: string

Payment group id.
paymentMethod: Type: string

Payment method. e.g. physicalGiftCard/ creditCard.
paymentState: Type: string

The state of the payment group. e.g. AUTHORIZED.
PONumber: Type: string

Purchase order number for invoice payment. Payment type:invoice
uiIntervention: Type: string

This decides whether the client has to do some intervention for payment. e.g. SOP.

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

clonedOrders: Type: array clonedOrders

Additional Properties Allowed:

list of orders that is created using this as template.
createDate: Type: string

The submitted date in ISO format.
endDate: Type: string

The submitted date in ISO format.
executionStatusList: Type: array executionStatusList

Additional Properties Allowed:

list of orders with status that are placed with this schedule.
id: Type: string

The scheduled order id.
lastError: Type: object lastError

Additional Properties Allowed:

last error of this scheduled order.
lastScheduledRun: Type: string

last date of order placed.
name: Type: string

name of scheduled order.
nextScheduledRun: Type: string

next date of order to be placed.
profileId: Type: string

the profile id of the user.
repositoryId: Type: string

repository id of scheduled order.
schedule: Type: object schedule

Required: true

Additional Properties Allowed:

schedule details for the schedule.
siteId: Type: string

id of site.
startDate: Type: string

The submitted date in ISO format.
status: Type: string

status of schedule order active or inactive.
templateOrderId: Type: string

template order id.
type: Type: string

type of order.
version: Type: integer

version scheduled order.

Nested Schema : clonedOrders

Type: array

list of orders that is created using this as template.

Type: object items

Additional Properties Allowed:

Nested Schema : executionStatusList

Type: array

list of orders with status that are placed with this schedule.

Type: object items

Additional Properties Allowed:

Nested Schema : lastError

Type: object

last error of this scheduled order.

errorDate: Type: string

The date when error occurred
errorMessages: Type: array errorMessages

Additional Properties Allowed:

An array of error messages
scheduleErrorId: Type: string

error id of the last failed schedule order

Nested Schema : schedule

Type: object

schedule details for the schedule.

daysInMonth: Type: array daysInMonth

Additional Properties Allowed:

mention which days of Month schedule should run. values can be 1 to 31.
daysOfWeek: Type: array daysOfWeek

Additional Properties Allowed:

mention which days of week schedule should run. values can be 1 to 7.
monthsInYear: Type: array monthsInYear

Additional Properties Allowed:

The months in year of the Scheduled order. Values can be 0 to 11.
occurenceInDay: Type: integer

The occurence in day on the Scheduled order. Values can be 1 or 2.
weeksInMonth: Type: array weeksInMonth

Additional Properties Allowed:

The weeks in month of the Scheduled order.Values can be 1 to 5

Nested Schema : items

Type: object

orderId: Type: string

The Id of the template order.

Nested Schema : items

Type: object

errorMessages: Type: array errorMessages

Additional Properties Allowed:

The error messages list.
executionDate: Type: string

The date for previous scheduled run
id: Type: string

The Id of the Scheduled order.
orderId: Type: string

The Id of the template order.
orderSubmitted: Type: boolean

The status of order.
orderTotal: Type: number

Total order value.
repositoryId: Type: string

The Id of the Scheduled order.
scheduledOrderId: Type: string

The Id of the Scheduled order.

Nested Schema : errorMessages

Type: array

The error messages list.

Type: string

Nested Schema : errorMessages

Type: array

An array of error messages

Type: string

Nested Schema : daysInMonth

Type: array

mention which days of Month schedule should run. values can be 1 to 31.

Type: integer

Nested Schema : daysOfWeek

Type: array

mention which days of week schedule should run. values can be 1 to 7.

Type: integer

Nested Schema : monthsInYear

Type: array

The months in year of the Scheduled order. Values can be 0 to 11.

Type: integer

Nested Schema : weeksInMonth

Type: array

The weeks in month of the Scheduled order.Values can be 1 to 5

Type: integer

Nested Schema : items

Type: object

actualShipDate: Type: string

The actual ship date in ISO format.
discountInfo: Type: object discountInfo

Additional Properties Allowed:

The shipping group price information.
items: Type: array items

Additional Properties Allowed:

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

Additional Properties Allowed:

The shipping group price information.
recurringChargePriceInfo: Type: object recurringChargePriceInfo

Additional Properties Allowed:

Recurring charge price information.
shipOnDate: Type: string

The ship on date in ISO format.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details.
shippingGroupId: Type: string

The shipping group ID.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details.
status: Type: string

The shipping group status.
submittedDate: Type: string

The submitted date in ISO format.
taxPriceInfo: Type: object taxPriceInfo

Additional Properties Allowed:

The shipping tax price info details.
trackingInfo: Type: array trackingInfo

Additional Properties Allowed:

Tracking Information for the Order.
trackingNumber: Type: string

The tracking number.

Nested Schema : discountInfo

Type: object

The shipping group price information.

discountDescList: Type: array discountDescList

Additional Properties Allowed:

The list of all the order discounts.
orderDiscount: Type: number

The orderDiscount.
shippingDiscount: Type: number

The shipping discount.

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 shipping group price information.

amount: Type: number

The shipping method amount.
currencyCode: Type: string

The shipping method amount.
shipping: Type: number

The shipping amount.
shippingSurchargeValue: Type: number

The shipping surcharge value amount.
subTotal: Type: number

The shipping group subtotal.
tax: Type: number

The shipping method tax amount.
total: Type: number

The total cost of shipping.
totalWithoutTax: Type: number

The shipping items 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.

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 : taxPriceInfo

Type: object

The shipping tax price info details.

amount: Type: number

The shipping method amount.
cityTax: Type: number

The shipping group subtotal.
countryTax: Type: number

The country tax total.
countyTax: Type: number

The county tax amount.
districtTax: Type: string

The shipping method applied to the order.
isTaxIncluded: Type: boolean

Flag that states whether is tax included.
miscTax: Type: string

The miscellaneous tax amount.
stateTax: Type: number

The shipping method tax amount.
valueAddedTax: Type: number

The value added tax .

Nested Schema : trackingInfo

Type: array

Tracking Information for the Order.

Type: object items

Additional Properties Allowed:

Nested Schema : discountDescList

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

activationDate: Type: string

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

UIs this product active.
assetId: Type: string

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

The Availability date of commerce Item.
backOrderQuantity: Type: number

Back Order Quantity of the Items.
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.
detailedItemPriceInfo: Type: object detailedItemPriceInfo

Additional Properties Allowed:

Detailed Item Price Information.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
discountAmount: Type: string

The discount amount.
displayName: Type: string

Display Name.
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.
listPrice: Type: string

List Price.
onSale: Type: boolean

Indicates whether the price is for an item that is on sale.
preOrderQuantity: Type: number

Pre Order Quantity of the Items.
primaryImageAltText: Type: string

Primary Image Alternative Text.
primaryImageTitle: Type: string

Primary Image Title.
primaryThumbImageURL: Type: string

Primary Thumb Image URL.
productId: Type: string

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

The quantity of the product in this shipping group.
rawTotalPrice: Type: string

Raw Total Price.
recurringCharge: Type: number

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

route.
salePrice: Type: string

Sale Price.
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: number

shipping surcharge value.
skuProperties: Type: array skuProperties

Additional Properties Allowed:

Sku properties Information
unitPrice: Type: number

The unit price.
variant: Type: array variant

Additional Properties Allowed:

List of variants for the product.

Nested Schema : detailedItemPriceInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The amount.
currencyCode: Type: string

The currency code.
detailedUnitPrice: Type: number

Detailed Unit Price.
discounted: Type: boolean

Is this item discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: number

The quantity.
tax: Type: number

The tax amount.

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 : 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

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: object

carrierId: Type: string

Carrier Id for Tracking.
carrierName: Type: string

Carrier Name for Tracking.
carrierUrl: Type: string

Carrier URL for Tracking.
trackingNumber: Type: string

Tracking Number.

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.
active: Type: boolean

active or not.
assetId: Type: string

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

The Availability date of commerce Item.
backOrderQuantity: Type: number

Back Order Quantity of the Items.
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.
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.
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.
giftWithPurchaseCommerceItemMarkers: Type: array giftWithPurchaseCommerceItemMarkers

Additional Properties Allowed:

The array of giftWithPurchaseCommerceItemMarkers.
id: Type: string

Repository id of the commerce item.
preOrderQuantity: Type: number

Pre Order Quantity of the Items.
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 : 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 : giftWithPurchaseCommerceItemMarkers

Type: array

The array of giftWithPurchaseCommerceItemMarkers.

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

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.
giftWithPurchaseDiscountInfo: Type: array giftWithPurchaseDiscountInfo

Additional Properties Allowed:

The gift information.
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 : giftWithPurchaseDiscountInfo

Type: array

The gift information.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

giftWithPurchaseChoicesAvailable: Type: boolean

If this gift with purchase has multiple gift choices.
giftWithPurchaseIdentifier: Type: integer

The gift hash code for this gift with purchase promotion.
giftWithPurchaseQuantity: Type: number

The quantity that is gift quantity

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

automaticQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was auto added by pricing.
data: Type: integer

The gift hash code for this gift with purchase promotion.
key: Type: string

atg.gwp
remainingQuantity: Type: number

The quantity of the commerce item that is not affected by gift with purchase.
selectedQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was selected by the shopper.
targetedQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was targeted by pricing.
value: Type: string

The gift with purchase promotion id.

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 : items

Type: object

carrierId: Type: string

Carrier Id for Tracking.
carrierName: Type: string

Carrier Name for Tracking.
carrierUrl: Type: string

Carrier URL for Tracking.
trackingNumber: Type: string

Tracking Number.

Example application/json


{
    "totalAmountAuthorized":124.18,
    "orderComments":[
    ],
    "creationTime":1.436906449E12,
    "sourceSystem":"Cloud Commerce",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "value":"Test Instructions"
        }
    ],
    "submittedDate":"2015-07-14T20:41:49.000Z",
    "paymentGroups":[
        {
            "lastName":"Anderson",
            "amountAuthorized":124.18,
            "amount":88.55,
            "totalDue":88.55,
            "cardType":null,
            "zero_value_auto_authorized":"true",
            "IIN":"424242",
            "token":"9997000108950573",
            "paymentGroupId":"pg10411",
            "firstName":"Kim",
            "paymentStateDetailsAsUser":"The authorization succeeded",
            "uiIntervention":"sop",
            "billingAddress":{
                "lastName":"Anderson",
                "country":"US",
                "address3":null,
                "address2":null,
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "prefix":null,
                "companyName":null,
                "postalCode":"13202",
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "stateName":"New York",
                "faxNumber":null,
                "middleName":null,
                "countryName":"United States",
                "state":"NY",
                "email":"kim@example.com",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            },
            "paymentState":1,
            "paidAmount":0,
            "cardNumber":"xxxxxxxxxxxx1111",
            "refundAmount":0
        }
    ],
    "priceInfo":{
        "amount":56.99,
        "total":88.55,
        "shipping":25,
        "shippingSurchargeValue":0,
        "tax":6.56,
        "subTotal":56.99,
        "currencyCode":"USD"
    },
    "paymentGroup":{
        "lastName":"Anderson",
        "amountAuthorized":124.18,
        "amount":88.55,
        "totalDue":88.55,
        "cardType":null,
        "zero_value_auto_authorized":"true",
        "token":"9997000108950573",
        "paymentGroupId":"pg10411",
        "firstName":"Kim",
        "paymentStateDetailsAsUser":"The authorization succeeded",
        "uiIntervention":"sop",
        "billingAddress":{
            "lastName":"Anderson",
            "country":"US",
            "address3":null,
            "address2":null,
            "city":"Syracuse",
            "address1":"21 Cedar Ave",
            "prefix":null,
            "companyName":null,
            "postalCode":"13202",
            "jobTitle":null,
            "county":null,
            "suffix":null,
            "selectedCountry":"US",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "stateName":"New York",
            "faxNumber":null,
            "middleName":null,
            "countryName":"United States",
            "state":"NY",
            "email":"kim@example.com",
            "selectedState":"NY",
            "state_ISOCode":"US-NY"
        },
        "paymentState":1,
        "paidAmount":0,
        "cardNumber":"xxxxxxxxxxxx1111",
        "refundAmount":0
    },
    "shoppingCart":{
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":39.99,
                "returnedQuantity":0,
                "priceOverridenBy":"Damon Weber",
                "displayName":"Fable II",
                "shippingSurchargeValue":0,
                "discountAmount":0,
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/fableIIxbox_LARGE.jpg&height=100&width=100"
                },
                "preOrderQuantity":0,
                "childItems":[
                    {
                        "quantity":1,
                        "route":"/intel-pentium-dual-core/product/prod40001",
                        "productId":"prod40001",
                        "displayName":"Intel Pentium Dual Core",
                        "selectedOptions":[
                        ],
                        "childItems":[
                            {
                                "quantity":1,
                                "route":"/intel-pentium-dual-core/product/prod40001",
                                "productId":"prod40001",
                                "displayName":"Intel Pentium Dual Core",
                                "selectedOptions":[
                                ],
                                "catRefId":"sku40009"
                            }
                        ],
                        "catRefId":"sku40001"
                    },
                    {
                        "quantity":1,
                        "route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007",
                        "productId":"prod40007",
                        "displayName":"8 GB Kingston Sodimm DDR3 1600MHz",
                        "selectedOptions":[
                        ],
                        "catRefId":"sku40007"
                    }
                ],
                "configuratorId":"36379716",
                "overriddenPrice":3,
                "commerceItemId":"ci1000785",
                "assetId":"asset10001",
                "price":3,
                "isPriceOverridden":true,
                "variant":[
                ],
                "onSale":"true",
                "actionCode":"Add",
                "serviceId":"service-123",
                "stateDetailsAsUser":"The item has been initialized",
                "serviceAccountId":"serviceAcc-123",
                "unitPrice":39.99,
                "quantity":1,
                "productId":"prod10041",
                "tax":0.34,
                "catRefId":"sku10045",
                "skuProperties":[
                    {
                        "propertyType":"sku-base",
                        "name":"Name",
                        "id":"displayName",
                        "value":null
                    },
                    {
                        "propertyType":"sku-base",
                        "name":"Id",
                        "id":"id",
                        "value":"camerasku_1_1"
                    },
                    {
                        "propertyType":"sku-custom",
                        "name":"dynamicskuprop1",
                        "id":"dynamicskuprop1",
                        "value":"dynamicskuprop1"
                    }
                ],
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "backOrderQuantity":0,
                "listPrice":39.99,
                "status":0,
                "priceOverrideReason":{
                    "displayValue":"Agent Price Override",
                    "key":"agentPriceOverride"
                }
            },
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":49.99,
                "returnedQuantity":0,
                "priceOverridenBy":"",
                "displayName":"Dora the Explorer - Season 1",
                "shippingSurchargeValue":0,
                "discountAmount":0,
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100"
                },
                "overriddenPrice":"",
                "assetId":"asset10001",
                "price":49.99,
                "isPriceOverridden":false,
                "variant":[
                ],
                "actionCode":"Add",
                "serviceId":"service-123",
                "stateDetailsAsUser":"The item has been initialized",
                "unitPrice":49.99,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"Product_21Cxi",
                "tax":5.75,
                "catRefId":"Sku_21Dxy",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "listPrice":49.99,
                "status":0,
                "priceOverrideReason":{
                }
            },
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":49.98,
                "returnedQuantity":0,
                "priceOverridenBy":"Damon Weber",
                "displayName":"Akira",
                "shippingSurchargeValue":0,
                "discountAmount":0,
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/akira_LARGE.jpg&height=100&width=100"
                },
                "overriddenPrice":4,
                "assetId":"asset10001",
                "price":4,
                "isPriceOverridden":true,
                "variant":[
                ],
                "actionCode":"Add",
                "serviceId":"service-123",
                "stateDetailsAsUser":"The item has been initialized",
                "unitPrice":24.99,
                "serviceAccountId":"serviceAcc-123",
                "quantity":2,
                "productId":"Product_27Fxyzi",
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "tax":0.46,
                "catRefId":"Sku_27Gxyzi",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "listPrice":24.99,
                "status":0,
                "priceOverrideReason":{
                    "displayValue":"Appeasement",
                    "key":"appeasement"
                }
            }
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/orders/o10411?includeResult=full"
        }
    ],
    "state":1,
    "id":"o10411",
    "stateDetailsAsUser":"Submitted to fulfillment",
    "taxPriceInfo":{
        "cityTax":0,
        "amount":4,
        "valueAddedTax":0,
        "countyTax":2,
        "isTaxIncluded":false,
        "miscTax":0,
        "districtTax":0,
        "stateTax":2,
        "countryTax":0
    },
    "shippingGroups":[
        {
            "trackingInfo":[
            ],
            "shippingMethod":{
                "cost":25,
                "displayName":"Standard",
                "value":"standardShippingMethod"
            },
            "shippingAddress":{
                "lastName":"Anderson",
                "country":"US",
                "address3":null,
                "address2":null,
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "prefix":null,
                "companyName":null,
                "postalCode":"13202",
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "stateName":"New York",
                "faxNumber":null,
                "middleName":null,
                "countryName":"United States",
                "state":"NY",
                "email":"kim@example.com",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            },
            "trackingNumber":null,
            "items":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "productId":"Product_21Cxi",
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "preOrderQuantity":0,
                    "catRefId":"Sku_21Dxy",
                    "skuProperties":[
                        {
                            "propertyType":"sku-base",
                            "name":"Name",
                            "id":"displayName",
                            "value":null
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Id",
                            "id":"id",
                            "value":"camerasku_1_1"
                        },
                        {
                            "propertyType":"sku-custom",
                            "name":"dynamicskuprop1",
                            "id":"dynamicskuprop1",
                            "value":"dynamicskuprop1"
                        }
                    ],
                    "customerAccountId":"customerAcc-123",
                    "assetId":"asset10001",
                    "variant":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "backOrderQuantity":0
                }
            ]
        }
    ],
    "approvalSystemMessages":[
        "Order is pending approval because total is greater than the approved order limit."
    ],
    "shippingMethod":{
        "cost":25,
        "displayName":"Standard",
        "value":"standardShippingMethod"
    },
    "isItemPriceOverrideAllowed":true,
    "profile":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "organization":{
            "name":"Oracle India Pvt Ltd",
            "id":"oracle"
        },
        "middleName":null,
        "email":"kim@example.com"
    },
    "priceListGroup":{
        "deleted":false,
        "displayName":"UsDollar",
        "repositoryId":"UsDollar",
        "active":true,
        "currency":{
            "symbol":"$",
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"UsDollar",
        "locale":"en_US"
    },
    "returnRequests":[
    ],
    "creationDate":"2015-07-14T20:40:49.000Z",
    "discountInfo":{
        "unclaimedCouponMultiPromotions":{
        },
        "orderCouponsMap":{
        },
        "orderDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
        ],
        "unclaimedCouponsMap":{
        },
        "claimedCouponMultiPromotions":{
        }
    },
    "profileId":"se-570031",
    "exchangeRequests":[
    ],
    "giftWithPurchaseInfo":[
    ],
    "siteId":"siteUS",
    "shippingAddress":{
        "lastName":"Anderson",
        "country":"US",
        "address3":null,
        "address2":null,
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "prefix":null,
        "companyName":null,
        "postalCode":"13202",
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "selectedCountry":"US",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "stateName":"New York",
        "faxNumber":null,
        "middleName":null,
        "countryName":"United States",
        "state":"NY",
        "email":"kim@example.com",
        "selectedState":"NY",
        "state_ISOCode":"US-NY"
    },
    "giftWithPurchaseOrderMarkers":[
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |100094|Organization passed in the header is currently inactive| |100095|The order or return request does not belong to the current organization of the shopper profile| |100096|The organization associated to the order or return request was deleted / does not exist| |100097|The organization associated to the order or return request is currently inactive| |100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization| |100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization| |100101|The shopper profile does not belong to organization passed in the header| |100102|Organization passed in the header is invalid or does not exist|

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 Response Payload returned by endpoint:

{
  "totalAmountAuthorized": 124.18,
  "orderComments": [],
  "creationTime": 1436906449000,
  "sourceSystem": "Cloud Commerce",
  "dynamicProperties": [{
    "id": "dynamicPropertyShippingInstructions",
    "value": "Test Instructions"
  }],
  "submittedDate": "2015-07-14T20:41:49.000Z",
  "paymentGroups": [{
    "lastName": "Anderson",
    "amountAuthorized": 124.18,
    "amount": 88.55,
    "totalDue": 88.55,
    "cardType": null,
    "zero_value_auto_authorized": "true",
    "IIN": "424242",
    "token": "9997000108950573",
    "paymentGroupId": "pg10411",
    "firstName": "Kim",
    "paymentStateDetailsAsUser": "The authorization succeeded",
    "uiIntervention": "sop",
    "billingAddress": {
      "lastName": "Anderson",
      "country": "US",
      "address3": null,
      "address2": null,
      "city": "Syracuse",
      "address1": "21 Cedar Ave",
      "prefix": null,
      "companyName": null,
      "postalCode": "13202",
      "jobTitle": null,
      "county": null,
      "suffix": null,
      "selectedCountry": "US",
      "firstName": "Kim",
      "phoneNumber": "212-555-1977",
      "stateName": "New York",
      "faxNumber": null,
      "middleName": null,
      "countryName": "United States",
      "state": "NY",
      "email": "kim@example.com",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    },
    "paymentState": 1,
    "paidAmount": 0,
    "cardNumber": "xxxxxxxxxxxx1111",
    "refundAmount": 0
  }],
  "priceInfo": {
    "amount": 56.99,
    "total": 88.55,
    "shipping": 25,
    "shippingSurchargeValue": 0,
    "tax": 6.56,
    "subTotal": 56.99,
    "currencyCode": "USD"
  },
  "paymentGroup": {
    "lastName": "Anderson",
    "amountAuthorized": 124.18,
    "amount": 88.55,
    "totalDue": 88.55,
    "cardType": null,
    "zero_value_auto_authorized": "true",
    "token": "9997000108950573",
    "paymentGroupId": "pg10411",
    "firstName": "Kim",
    "paymentStateDetailsAsUser": "The authorization succeeded",
    "uiIntervention": "sop",
    "billingAddress": {
      "lastName": "Anderson",
      "country": "US",
      "address3": null,
      "address2": null,
      "city": "Syracuse",
      "address1": "21 Cedar Ave",
      "prefix": null,
      "companyName": null,
      "postalCode": "13202",
      "jobTitle": null,
      "county": null,
      "suffix": null,
      "selectedCountry": "US",
      "firstName": "Kim",
      "phoneNumber": "212-555-1977",
      "stateName": "New York",
      "faxNumber": null,
      "middleName": null,
      "countryName": "United States",
      "state": "NY",
      "email": "kim@example.com",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    },
    "paymentState": 1,
    "paidAmount": 0,
    "cardNumber": "xxxxxxxxxxxx1111",
    "refundAmount": 0
  },
  "shoppingCart": {"items": [
    {
      "deactivationDate": "2018-06-27T12:59:59Z",
      "rawTotalPrice": 39.99,
      "returnedQuantity": 0,
      "priceOverridenBy": "Damon Weber",
      "displayName": "Fable II",
      "shippingSurchargeValue": 0,
      "discountAmount": 0,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "imageInfo": {"primaryThumbImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/fableIIxbox_LARGE.jpg&height=100&width=100"},
      "preOrderQuantity": 0,
      "childItems": [
        {
          "quantity": 1,
          "route": "/intel-pentium-dual-core/product/prod40001",
          "productId": "prod40001",
          "displayName": "Intel Pentium Dual Core",
          "selectedOptions": [],
          "childItems": [{
            "quantity": 1,
            "route": "/intel-pentium-dual-core/product/prod40001",
            "productId": "prod40001",
            "displayName": "Intel Pentium Dual Core",
            "selectedOptions": [],
            "catRefId": "sku40009"
          }],
          "catRefId": "sku40001"
        },
        {
          "quantity": 1,
          "route": "/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007",
          "productId": "prod40007",
          "displayName": "8 GB Kingston Sodimm DDR3 1600MHz",
          "selectedOptions": [],
          "catRefId": "sku40007"
        }
      ],
      "configuratorId": "36379716",
      "overriddenPrice": 3,
      "commerceItemId": "ci1000785",
      "assetId": "asset10001",
      "price": 3,
      "isPriceOverridden": true,
      "variant": [],
      "onSale": "true",
      "actionCode": "Add",
      "serviceId": "service-123",
      "stateDetailsAsUser": "The item has been initialized",
      "serviceAccountId": "serviceAcc-123",
      "unitPrice": 39.99,
      "quantity": 1,
      "productId": "prod10041",
      "tax": 0.34,
      "catRefId": "sku10045",
      "skuProperties": [
        {
          "propertyType": "sku-base",
          "name": "Name",
          "id": "displayName",
          "value": null
        },
        {
          "propertyType": "sku-base",
          "name": "Id",
          "id": "id",
          "value": "camerasku_1_1"
        },
        {
          "propertyType": "sku-custom",
          "name": "dynamicskuprop1",
          "id": "dynamicskuprop1",
          "value": "dynamicskuprop1"
        }
      ],
      "customerAccountId": "customerAcc-123",
      "discountInfo": [],
      "activationDate": "2017-06-27T15:30:00Z",
      "backOrderQuantity": 0,
      "listPrice": 39.99,
      "status": 0,
      "priceOverrideReason": {
        "displayValue": "Agent Price Override",
        "key": "agentPriceOverride"
      }
    },
    {
      "deactivationDate": "2018-06-27T12:59:59Z",
      "rawTotalPrice": 49.99,
      "returnedQuantity": 0,
      "priceOverridenBy": "",
      "displayName": "Dora the Explorer - Season 1",
      "shippingSurchargeValue": 0,
      "discountAmount": 0,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "imageInfo": {"primaryThumbImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100"},
      "overriddenPrice": "",
      "assetId": "asset10001",
      "price": 49.99,
      "isPriceOverridden": false,
      "variant": [],
      "actionCode": "Add",
      "serviceId": "service-123",
      "stateDetailsAsUser": "The item has been initialized",
      "unitPrice": 49.99,
      "serviceAccountId": "serviceAcc-123",
      "quantity": 1,
      "productId": "Product_21Cxi",
      "tax": 5.75,
      "catRefId": "Sku_21Dxy",
      "customerAccountId": "customerAcc-123",
      "discountInfo": [],
      "activationDate": "2017-06-27T15:30:00Z",
      "listPrice": 49.99,
      "status": 0,
      "priceOverrideReason": {}
    },
    {
      "deactivationDate": "2018-06-27T12:59:59Z",
      "rawTotalPrice": 49.98,
      "returnedQuantity": 0,
      "priceOverridenBy": "Damon Weber",
      "displayName": "Akira",
      "shippingSurchargeValue": 0,
      "discountAmount": 0,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "imageInfo": {"primaryThumbImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/akira_LARGE.jpg&height=100&width=100"},
      "overriddenPrice": 4,
      "assetId": "asset10001",
      "price": 4,
      "isPriceOverridden": true,
      "variant": [],
      "actionCode": "Add",
      "serviceId": "service-123",
      "stateDetailsAsUser": "The item has been initialized",
      "unitPrice": 24.99,
      "serviceAccountId": "serviceAcc-123",
      "quantity": 2,
      "productId": "Product_27Fxyzi",
      "giftWithPurchaseCommerceItemMarkers": [],
      "tax": 0.46,
      "catRefId": "Sku_27Gxyzi",
      "customerAccountId": "customerAcc-123",
      "discountInfo": [],
      "activationDate": "2017-06-27T15:30:00Z",
      "listPrice": 24.99,
      "status": 0,
      "priceOverrideReason": {
        "displayValue": "Appeasement",
        "key": "appeasement"
      }
    }
  ]},
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/orders/o10411?includeResult=full"
  }],
  "state": 1,
  "id": "o10411",
  "stateDetailsAsUser": "Submitted to fulfillment",
  "taxPriceInfo": {
    "cityTax": 0,
    "amount": 4,
    "valueAddedTax": 0,
    "countyTax": 2,
    "isTaxIncluded": false,
    "miscTax": 0,
    "districtTax": 0,
    "stateTax": 2,
    "countryTax": 0
  },
  "shippingGroups": [{
    "trackingInfo": [],
    "shippingMethod": {
      "cost": 25,
      "displayName": "Standard",
      "value": "standardShippingMethod"
    },
    "shippingAddress": {
      "lastName": "Anderson",
      "country": "US",
      "address3": null,
      "address2": null,
      "city": "Syracuse",
      "address1": "21 Cedar Ave",
      "prefix": null,
      "companyName": null,
      "postalCode": "13202",
      "jobTitle": null,
      "county": null,
      "suffix": null,
      "selectedCountry": "US",
      "firstName": "Kim",
      "phoneNumber": "212-555-1977",
      "stateName": "New York",
      "faxNumber": null,
      "middleName": null,
      "countryName": "United States",
      "state": "NY",
      "email": "kim@example.com",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    },
    "trackingNumber": null,
    "items": [{
      "serviceAccountId": "serviceAcc-123",
      "deactivationDate": "2018-06-27T12:59:59Z",
      "quantity": 1,
      "productId": "Product_21Cxi",
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "preOrderQuantity": 0,
      "catRefId": "Sku_21Dxy",
      "skuProperties": [
        {
          "propertyType": "sku-base",
          "name": "Name",
          "id": "displayName",
          "value": null
        },
        {
          "propertyType": "sku-base",
          "name": "Id",
          "id": "id",
          "value": "camerasku_1_1"
        },
        {
          "propertyType": "sku-custom",
          "name": "dynamicskuprop1",
          "id": "dynamicskuprop1",
          "value": "dynamicskuprop1"
        }
      ],
      "customerAccountId": "customerAcc-123",
      "assetId": "asset10001",
      "variant": [],
      "actionCode": "Add",
      "activationDate": "2017-06-27T15:30:00Z",
      "serviceId": "service-123",
      "backOrderQuantity": 0
    }]
  }],
  "approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."],
  "shippingMethod": {
    "cost": 25,
    "displayName": "Standard",
    "value": "standardShippingMethod"
  },
  "isItemPriceOverrideAllowed": true,
  "profile": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "organization": {
      "name": "Oracle India Pvt Ltd",
      "id": "oracle"
    },
    "middleName": null,
    "email": "kim@example.com"
  },
  "priceListGroup": {
    "deleted": false,
    "displayName": "UsDollar",
    "repositoryId": "UsDollar",
    "active": true,
    "currency": {
      "symbol": "$",
      "displayName": "US Dollar",
      "repositoryId": "en_US",
      "fractionalDigits": 2,
      "currencyCode": "USD",
      "numericCode": "840"
    },
    "id": "UsDollar",
    "locale": "en_US"
  },
  "returnRequests": [],
  "creationDate": "2015-07-14T20:40:49.000Z",
  "discountInfo": {
    "unclaimedCouponMultiPromotions": {},
    "orderCouponsMap": {},
    "orderDiscount": 0,
    "shippingDiscount": 0,
    "orderImplicitDiscountList": [],
    "unclaimedCouponsMap": {},
    "claimedCouponMultiPromotions": {}
  },
  "profileId": "se-570031",
  "exchangeRequests": [],
  "giftWithPurchaseInfo": [],
  "siteId": "siteUS",
  "shippingAddress": {
    "lastName": "Anderson",
    "country": "US",
    "address3": null,
    "address2": null,
    "city": "Syracuse",
    "address1": "21 Cedar Ave",
    "prefix": null,
    "companyName": null,
    "postalCode": "13202",
    "jobTitle": null,
    "county": null,
    "suffix": null,
    "selectedCountry": "US",
    "firstName": "Kim",
    "phoneNumber": "212-555-1977",
    "stateName": "New York",
    "faxNumber": null,
    "middleName": null,
    "countryName": "United States",
    "state": "NY",
    "email": "kim@example.com",
    "selectedState": "NY",
    "state_ISOCode": "US-NY"
  },
  "giftWithPurchaseOrderMarkers": []
}