REST API for Oracle Commerce Cloud December 2017 - approveOrder

Previous Next JavaScript must be enabled to correctly display this content

approveOrder

post

/ccstore/v1/orders/approve

Approve Order. Approver approves an order. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.

Request

Supported Media Types

application/json

Header Parameters

X-CCOrganization: Type: string

Current organization context of the logged in user

Body Parameter

Root Schema : approveOrder_request


{
    "approverMessage":"Approving order",
    "orderId":"o30411",
    "ignorePriceWarnings":true
}

approverMessage: Type: string

the message given by approver when he is approving order.
ignorePriceWarnings: Type: boolean

Required: true

this flag decides whether approver is allowing order to be repriced as part of approval or not.
orderId: Type: string

Required: true

the order id of the order which requires approval.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : approveOrder_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.
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.
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 : 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

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

UIs this product active.
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.
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.
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.
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 : 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

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

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


{
    "creationTime":1.428563503E12,
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "label":"Shipping Instructions",
            "value":"Test Instructions"
        }
    ],
    "payments":[
        {
            "paymentGroupId":"pg30411",
            "PONumber":null,
            "amount":78.67,
            "gatewayName":"invoiceGateway",
            "uiIntervention":null,
            "paymentMethod":"invoiceRequest",
            "isAmountRemaining":true,
            "paymentState":"INITIAL"
        }
    ],
    "orderStatus":"Pending payment",
    "approvers":[
        {
            "firstName":"Peter",
            "lastName":"Grun",
            "approverId":"bb-110020"
        }
    ],
    "submittedDate":"2015-04-09T07:21:43.000Z",
    "uuid":"a15543c2-a44f-4640-8ac4-674c594efc85",
    "priceInfo":{
        "amount":52,
        "total":62.6,
        "shipping":6.5,
        "shippingSurchargeValue":20,
        "tax":4.1,
        "subTotal":52,
        "currencyCode":"USD"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://www.example.com/ccstoreui/v1/orders/approve"
        }
    ],
    "id":"o10004",
    "state":"PENDING_PAYMENT",
    "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
    },
    "order":{
        "numberOfItems":1,
        "items":[
            {
                "primaryThumbImageURL":"/ccstoreui/v1/images/?source=http://www.example.com/file/products/APP_CowboyShirt_full.jpg&height=100&width=100",
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":52,
                "displayName":"Cowboy Shirt",
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "assetId":"asset10001",
                "price":52,
                "variant":[
                    {
                        "optionValue":"Blue",
                        "optionName":"Color"
                    },
                    {
                        "optionValue":"Medium",
                        "optionName":"Size"
                    }
                ],
                "actionCode":"Add",
                "serviceId":"service-123",
                "unitPrice":52,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"prod10002",
                "externalRecurringCharge":10,
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "active":true,
                "externalRecurringChargeFrequency":"Monthly",
                "catRefId":"sku40087",
                "externalRecurringChargeDuration":"12",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "route":"/cowboy-shirt/product/prod10002",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "recurringCharge":10
            }
        ]
    },
    "shippingGroup":{
        "shippingMethodDescription":"Ground"
    },
    "shippingGroups":[
        {
            "taxPriceInfo":{
                "cityTax":0,
                "amount":4.1,
                "valueAddedTax":0,
                "countyTax":1.76,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":2.34,
                "countryTax":0
            },
            "shippingMethod":{
                "shippingTax":0.46,
                "cost":6.5,
                "value":"ground",
                "shippingMethodDescription":"Ground"
            },
            "shippingGroupId":"sg10032",
            "submittedDate":null,
            "priceInfo":{
                "amount":52,
                "total":62.6,
                "shipping":6.5,
                "shippingSurchargeValue":0,
                "tax":4.1,
                "subTotal":52,
                "currencyCode":"USD",
                "totalWithoutTax":58.5
            },
            "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":"a",
                "country":"US",
                "address3":"",
                "address2":"a",
                "city":"a",
                "address1":"a",
                "prefix":"",
                "companyName":"",
                "postalCode":"30005",
                "jobTitle":"",
                "county":"",
                "suffix":"",
                "firstName":"a",
                "phoneNumber":"5675675678",
                "alias":"Address##0",
                "faxNumber":"",
                "middleName":"",
                "state":"GA",
                "email":"a@a.com"
            },
            "trackingNumber":null,
            "items":[
                {
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_CowboyShirt_full.jpg&height=100&width=100",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":52,
                    "returnedQuantity":0,
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "displayName":"Cowboy Shirt",
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "commerceItemId":"ci3000411",
                    "assetId":"asset10001",
                    "price":52,
                    "variant":[
                        {
                            "optionValue":"Blue",
                            "optionName":"Color"
                        },
                        {
                            "optionValue":"Medium",
                            "optionName":"Size"
                        }
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Cowboy Shirt",
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "serviceAccountId":"serviceAcc-123",
                    "unitPrice":52,
                    "primaryImageTitle":"Cowboy Shirt",
                    "quantity":1,
                    "productId":"prod10002",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":52,
                            "quantity":1,
                            "tax":3.64,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":52,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "active":true,
                    "externalRecurringChargeFrequency":"Monthly",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"sku40087",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/cowboy-shirt/product/prod10002",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "activationDate":"2017-06-27T15:30:00Z",
                    "listPrice":52,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ],
            "status":"INITIAL"
        }
    ],
    "lastModifiedDate":"2015-04-09T07:21:43.000Z",
    "approvalSystemMessages":[
        "Order is pending approval because total is greater than the approved order limit."
    ],
    "shippingMethod":{
        "cost":6.5,
        "value":"ground"
    },
    "approverMessages":[
        "I am approving this order"
    ],
    "priceListGroup":{
        "repositoryId":"UsDollar"
    },
    "creationDate":"2015-04-09T07:11:43.000Z",
    "orderProfileId":"120029",
    "paymentGroupId":"pg10004",
    "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":{
        "unclaimedCouponMultiPromotions":{
            "coupon2":[
                {
                    "promotionLevel":"order",
                    "promotionDesc":"promo4",
                    "promotionId":"promo20004"
                }
            ]
        },
        "orderCouponsMap":{
            "coupon1":{
                "promotionLevel":"order",
                "totalAdjustment":-1,
                "promotionDesc":"promo1",
                "promotionId":"promo20001"
            },
            "coupon2":{
                "promotionLevel":"order",
                "totalAdjustment":-1,
                "promotionDesc":"promo2",
                "promotionId":"promo20002"
            }
        },
        "orderDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
            {
                "promotionLevel":"item",
                "totalAdjustment":"-0.66",
                "promotionDesc":"Implicit Item Discount - 3PercentOff",
                "promotionId":"implicitItemPercentDiscount"
            }
        ],
        "claimedCouponMultiPromotions":{
            "coupon1":[
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo1",
                    "promotionId":"promo20001"
                },
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo3",
                    "promotionId":"promo20003"
                }
            ],
            "coupon2":[
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo2",
                    "promotionId":"promo20002"
                }
            ]
        },
        "unclaimedCouponsMap":{
            "coupon2":{
                "promotionLevel":"order",
                "promotionDesc":"promo4",
                "promotionId":"promo20004"
            }
        }
    },
    "trackingInfo":[
        {
            "carrierName":"OnTrac",
            "carrierUrl":"http://www.ontrac.com/trackingdetail.asp?tracking=1224",
            "carrierId":"OnTrac",
            "trackingNumber":"1224"
        }
    ],
    "orderLocale":"en",
    "shippingAddress":{
        "lastName":"a",
        "country":"US",
        "address3":null,
        "address2":"a",
        "city":"a",
        "address1":"a",
        "prefix":null,
        "companyName":null,
        "postalCode":"30005",
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "firstName":"a",
        "phoneNumber":"5675675678",
        "faxNumber":null,
        "alias":null,
        "middleName":null,
        "state":"GA",
        "email":"a@a.com"
    },
    "billingAddress":{
        "lastName":"a",
        "country":"US",
        "address3":null,
        "address2":"a",
        "city":"a",
        "address1":"a",
        "prefix":null,
        "companyName":null,
        "postalCode":"30005",
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "firstName":"a",
        "phoneNumber":"5675675678",
        "faxNumber":null,
        "alias":null,
        "middleName":null,
        "state":"GA",
        "email":"a@a.com"
    },
    "giftWithPurchaseOrderMarkers":[
        {
            "quantity":1,
            "selectedQuantity":0,
            "removedQuantity":0,
            "data":"-1275480226",
            "automaticQuantity":0,
            "giftType":"product",
            "autoRemove":true,
            "giftDetail":"camera_1",
            "repositoryId":"200001",
            "failedQuantity":0,
            "value":"promo10002",
            "targetedQuantity":0,
            "key":"atg.gwp"
        }
    ]
}

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:

{
  "approverMessage": "Approving order",
  "orderId": "o30411",
  "ignorePriceWarnings": true
}

Sample Response Payload returned by endpoint:

{
  "creationTime": 1428563503000,
  "dynamicProperties": [{
    "id": "dynamicPropertyShippingInstructions",
    "label": "Shipping Instructions",
    "value": "Test Instructions"
  }],
  "payments": [{
    "paymentGroupId": "pg30411",
    "PONumber": null,
    "amount": 78.67,
    "gatewayName": "invoiceGateway",
    "uiIntervention": null,
    "paymentMethod": "invoiceRequest",
    "isAmountRemaining": true,
    "paymentState": "INITIAL"
  }],
  "orderStatus": "Pending payment",
  "approvers": [{
    "firstName": "Peter",
    "lastName": "Grun",
    "approverId": "bb-110020"
  }],
  "submittedDate": "2015-04-09T07:21:43.000Z",
  "uuid": "a15543c2-a44f-4640-8ac4-674c594efc85",
  "priceInfo": {
    "amount": 52,
    "total": 62.6,
    "shipping": 6.5,
    "shippingSurchargeValue": 20,
    "tax": 4.1,
    "subTotal": 52,
    "currencyCode": "USD"
  },
  "links": [{
    "rel": "self",
    "href": "http://www.example.com/ccstoreui/v1/orders/approve"
  }],
  "id": "o10004",
  "state": "PENDING_PAYMENT",
  "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
  },
  "order": {
    "numberOfItems": 1,
    "items": [{
      "primaryThumbImageURL": "/ccstoreui/v1/images/?source=http://www.example.com/file/products/APP_CowboyShirt_full.jpg&height=100&width=100",
      "deactivationDate": "2018-06-27T12:59:59Z",
      "rawTotalPrice": 52,
      "displayName": "Cowboy Shirt",
      "dynamicProperties": [{
        "id": "dynamicPropertyMode",
        "label": "Mode",
        "value": "pickup"
      }],
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "assetId": "asset10001",
      "price": 52,
      "variant": [
        {
          "optionValue": "Blue",
          "optionName": "Color"
        },
        {
          "optionValue": "Medium",
          "optionName": "Size"
        }
      ],
      "actionCode": "Add",
      "serviceId": "service-123",
      "unitPrice": 52,
      "serviceAccountId": "serviceAcc-123",
      "quantity": 1,
      "productId": "prod10002",
      "externalRecurringCharge": 10,
      "giftWithPurchaseCommerceItemMarkers": [],
      "active": true,
      "externalRecurringChargeFrequency": "Monthly",
      "catRefId": "sku40087",
      "externalRecurringChargeDuration": "12",
      "customerAccountId": "customerAcc-123",
      "discountInfo": [],
      "route": "/cowboy-shirt/product/prod10002",
      "detailedRecurringChargeInfo": [{
        "discounted": false,
        "amount": 10,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 10,
        "currencyCode": "USD"
      }],
      "activationDate": "2017-06-27T15:30:00Z",
      "recurringCharge": 10
    }]
  },
  "shippingGroup": {"shippingMethodDescription": "Ground"},
  "shippingGroups": [{
    "taxPriceInfo": {
      "cityTax": 0,
      "amount": 4.1,
      "valueAddedTax": 0,
      "countyTax": 1.76,
      "isTaxIncluded": false,
      "miscTax": 0,
      "districtTax": 0,
      "stateTax": 2.34,
      "countryTax": 0
    },
    "shippingMethod": {
      "shippingTax": 0.46,
      "cost": 6.5,
      "value": "ground",
      "shippingMethodDescription": "Ground"
    },
    "shippingGroupId": "sg10032",
    "submittedDate": null,
    "priceInfo": {
      "amount": 52,
      "total": 62.6,
      "shipping": 6.5,
      "shippingSurchargeValue": 0,
      "tax": 4.1,
      "subTotal": 52,
      "currencyCode": "USD",
      "totalWithoutTax": 58.5
    },
    "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": "a",
      "country": "US",
      "address3": "",
      "address2": "a",
      "city": "a",
      "address1": "a",
      "prefix": "",
      "companyName": "",
      "postalCode": "30005",
      "jobTitle": "",
      "county": "",
      "suffix": "",
      "firstName": "a",
      "phoneNumber": "5675675678",
      "alias": "Address##0",
      "faxNumber": "",
      "middleName": "",
      "state": "GA",
      "email": "a@a.com"
    },
    "trackingNumber": null,
    "items": [{
      "primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_CowboyShirt_full.jpg&height=100&width=100",
      "deactivationDate": "2018-06-27T12:59:59Z",
      "rawTotalPrice": 52,
      "returnedQuantity": 0,
      "dynamicProperties": [{
        "id": "dynamicPropertyMode",
        "label": "Mode",
        "value": "pickup"
      }],
      "displayName": "Cowboy Shirt",
      "shippingSurchargeValue": 0,
      "discountAmount": 0,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "commerceItemId": "ci3000411",
      "assetId": "asset10001",
      "price": 52,
      "variant": [
        {
          "optionValue": "Blue",
          "optionName": "Color"
        },
        {
          "optionValue": "Medium",
          "optionName": "Size"
        }
      ],
      "onSale": false,
      "primaryImageAltText": "Cowboy Shirt",
      "actionCode": "Add",
      "serviceId": "service-123",
      "stateDetailsAsUser": "The item has been initialized within the shipping group",
      "serviceAccountId": "serviceAcc-123",
      "unitPrice": 52,
      "primaryImageTitle": "Cowboy Shirt",
      "quantity": 1,
      "productId": "prod10002",
      "salePrice": 0,
      "detailedItemPriceInfo": [{
        "discounted": false,
        "amount": 52,
        "quantity": 1,
        "tax": 3.64,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 52,
        "currencyCode": "USD"
      }],
      "externalRecurringCharge": 10,
      "active": true,
      "externalRecurringChargeFrequency": "Monthly",
      "externalRecurringChargeDuration": "12",
      "catRefId": "sku40087",
      "customerAccountId": "customerAcc-123",
      "discountInfo": [],
      "route": "/cowboy-shirt/product/prod10002",
      "detailedRecurringChargeInfo": [{
        "discounted": false,
        "amount": 10,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 10,
        "currencyCode": "USD"
      }],
      "activationDate": "2017-06-27T15:30:00Z",
      "listPrice": 52,
      "recurringCharge": 10,
      "status": "INITIAL"
    }],
    "status": "INITIAL"
  }],
  "lastModifiedDate": "2015-04-09T07:21:43.000Z",
  "approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."],
  "shippingMethod": {
    "cost": 6.5,
    "value": "ground"
  },
  "approverMessages": ["I am approving this order"],
  "priceListGroup": {"repositoryId": "UsDollar"},
  "creationDate": "2015-04-09T07:11:43.000Z",
  "orderProfileId": "120029",
  "paymentGroupId": "pg10004",
  "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": {
    "unclaimedCouponMultiPromotions": {"coupon2": [{
      "promotionLevel": "order",
      "promotionDesc": "promo4",
      "promotionId": "promo20004"
    }]},
    "orderCouponsMap": {
      "coupon1": {
        "promotionLevel": "order",
        "totalAdjustment": -1,
        "promotionDesc": "promo1",
        "promotionId": "promo20001"
      },
      "coupon2": {
        "promotionLevel": "order",
        "totalAdjustment": -1,
        "promotionDesc": "promo2",
        "promotionId": "promo20002"
      }
    },
    "orderDiscount": 0,
    "shippingDiscount": 0,
    "orderImplicitDiscountList": [{
      "promotionLevel": "item",
      "totalAdjustment": "-0.66",
      "promotionDesc": "Implicit Item Discount - 3PercentOff",
      "promotionId": "implicitItemPercentDiscount"
    }],
    "claimedCouponMultiPromotions": {
      "coupon1": [
        {
          "promotionLevel": "order",
          "totalAdjustment": -1,
          "promotionDesc": "promo1",
          "promotionId": "promo20001"
        },
        {
          "promotionLevel": "order",
          "totalAdjustment": -1,
          "promotionDesc": "promo3",
          "promotionId": "promo20003"
        }
      ],
      "coupon2": [{
        "promotionLevel": "order",
        "totalAdjustment": -1,
        "promotionDesc": "promo2",
        "promotionId": "promo20002"
      }]
    },
    "unclaimedCouponsMap": {"coupon2": {
      "promotionLevel": "order",
      "promotionDesc": "promo4",
      "promotionId": "promo20004"
    }}
  },
  "trackingInfo": [{
    "carrierName": "OnTrac",
    "carrierUrl": "http://www.ontrac.com/trackingdetail.asp?tracking=1224",
    "carrierId": "OnTrac",
    "trackingNumber": "1224"
  }],
  "orderLocale": "en",
  "shippingAddress": {
    "lastName": "a",
    "country": "US",
    "address3": null,
    "address2": "a",
    "city": "a",
    "address1": "a",
    "prefix": null,
    "companyName": null,
    "postalCode": "30005",
    "jobTitle": null,
    "county": null,
    "suffix": null,
    "firstName": "a",
    "phoneNumber": "5675675678",
    "faxNumber": null,
    "alias": null,
    "middleName": null,
    "state": "GA",
    "email": "a@a.com"
  },
  "billingAddress": {
    "lastName": "a",
    "country": "US",
    "address3": null,
    "address2": "a",
    "city": "a",
    "address1": "a",
    "prefix": null,
    "companyName": null,
    "postalCode": "30005",
    "jobTitle": null,
    "county": null,
    "suffix": null,
    "firstName": "a",
    "phoneNumber": "5675675678",
    "faxNumber": null,
    "alias": null,
    "middleName": null,
    "state": "GA",
    "email": "a@a.com"
  },
  "giftWithPurchaseOrderMarkers": [{
    "quantity": 1,
    "selectedQuantity": 0,
    "removedQuantity": 0,
    "data": "-1275480226",
    "automaticQuantity": 0,
    "giftType": "product",
    "autoRemove": true,
    "giftDetail": "camera_1",
    "repositoryId": "200001",
    "failedQuantity": 0,
    "value": "promo10002",
    "targetedQuantity": 0,
    "key": "atg.gwp"
  }]
}