rejectOrder
post
/ccagent/v1/orders/reject
Reject Order. Approver rejects an order. 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
Header Parameters
- X-CCOrganization
-
Type:
string
the organization Id in which order should be created- X-CCSite
Type:string
the site Id in which order should be created
Body Parameter
Root Schema : rejectOrder_request
{
"approverMessage":"Rejecting order",
"orderId":"o30411"
}
- approverMessage
-
Type:
string
the message given by approver when he is rejecting order. - 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 : rejectOrder_response
- approvalSystemMessages
-
Type:
array
approvalSystemMessagesAdditional Properties Allowed:An array of approval messages when order going in pending approval state - approverMessages
-
Type:
array
approverMessagesAdditional Properties Allowed:An array of approval messages when approver approving order - approvers
-
Type:
array
approversAdditional Properties Allowed:List of approvers of the organization. - billingAddress
-
Type:
object
billingAddressAdditional 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
discountInfoAdditional Properties Allowed:The discount information. - dynamicProperties
-
Type:
array
dynamicPropertiesAdditional Properties Allowed:Read-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
array
giftWithPurchaseInfoAdditional Properties Allowed:The gift information. - giftWithPurchaseOrderMarkers
-
Type:
array
giftWithPurchaseOrderMarkersAdditional 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
paymentsAdditional Properties Allowed:Payment details for the order, including additional properties specific to the payment type. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:The price information. - priceListGroup
-
Type:
object
priceListGroupAdditional Properties Allowed:The price list group object. - quoteInfo
-
Type:
object
quoteInfoAdditional Properties Allowed:the quote information of the order - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - scheduledOrder
-
Type:
array
scheduledOrderAdditional Properties Allowed:schedule order information - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:The shipping address details. - shippingGroups
-
Type:
array
shippingGroupsAdditional Properties Allowed:The shipping groups for the order. - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:The shipping method details for the order. - shoppingCart/order
-
Type:
object
shoppingCart/orderAdditional 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
trackingInfoAdditional 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
Nested Schema : approvers
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. -
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
claimedCouponMultiPromotionsAdditional Properties Allowed:The coupons that were claimed - orderCouponsMap
-
Type:
array
orderCouponsMapAdditional Properties Allowed:The list of all the coupons with the order. - orderDiscount
-
Type:
integer
The order discount. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListAdditional Properties Allowed:The implicit order discounts with the order. - shippingDiscount
-
Type:
integer
The shipping discount. - unclaimedCouponMultiPromotions
-
Type:
object
unclaimedCouponMultiPromotionsAdditional Properties Allowed:The coupons that were not claimed - unclaimedCouponsMap
-
Type:
object
unclaimedCouponsMapAdditional Properties Allowed:The unclaimed coupons with the order.
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseInfo
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : payments
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
errorInfoAdditional 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
notesAdditional 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
frequencyAmountTotalsAdditional Properties Allowed:The total for each recurring charge frequency - frequencyTaxTotals
-
Type:
array
frequencyTaxTotalsAdditional 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
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. -
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
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
itemsAdditional Properties Allowed:The array of products in the shopping cart.
Nested Schema : trackingInfo
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 codeAdditional Properties Allowed:Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
- coupon code
-
Type:
array
coupon codeAdditional 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 codeAdditional Properties Allowed:Coupon Code, corresponding to which some promotions were not applied
Nested Schema : coupon code
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
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
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
Nested Schema : notes
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
Nested Schema : frequencyTaxTotals
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
clonedOrdersAdditional 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
executionStatusListAdditional Properties Allowed:list of orders with status that are placed with this schedule. - id
-
Type:
string
The scheduled order id. - lastError
-
Type:
object
lastErrorAdditional 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
scheduleRequired: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
Nested Schema : executionStatusList
Nested Schema : lastError
Type:
object
last error of this scheduled order.
- errorDate
-
Type:
string
The date when error occurred - errorMessages
-
Type:
array
errorMessagesAdditional 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
daysInMonthAdditional Properties Allowed:mention which days of Month schedule should run. values can be 1 to 31. - daysOfWeek
-
Type:
array
daysOfWeekAdditional Properties Allowed:mention which days of week schedule should run. values can be 1 to 7. - monthsInYear
-
Type:
array
monthsInYearAdditional 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
weeksInMonthAdditional 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
errorMessagesAdditional 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
Nested Schema : errorMessages
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
Nested Schema : weeksInMonth
Nested Schema : items
Type:
object
- actualShipDate
-
Type:
string
The actual ship date in ISO format. - discountInfo
-
Type:
object
discountInfoAdditional Properties Allowed:The shipping group price information. - items
-
Type:
array
itemsAdditional Properties Allowed:The array of products in the shipping group. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:The shipping group price information. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - shipOnDate
-
Type:
string
The ship on date in ISO format. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:The shipping address details. - shippingGroupId
-
Type:
string
The shipping group ID. - shippingMethod
-
Type:
object
shippingMethodAdditional 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
taxPriceInfoAdditional 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
discountDescListAdditional Properties Allowed:The list of all the order discounts. - orderDiscount
-
Type:
number
The orderDiscount. - shippingDiscount
-
Type:
number
The shipping discount.
Nested Schema : items
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
frequencyAmountTotalsAdditional Properties Allowed:The total for each recurring charge frequency - frequencyTaxTotals
-
Type:
array
frequencyTaxTotalsAdditional 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. -
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
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
- active
-
Type:
boolean
UIs this product active. - catRefId
-
Type:
string
The category to which the product belongs. - detailedItemPriceInfo
-
Type:
object
detailedItemPriceInfoAdditional Properties Allowed:Detailed Item Price Information. - detailedRecurringChargeInfo
-
Type:
object
detailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - discountAmount
-
Type:
string
The discount amount. - displayName
-
Type:
string
Display Name. - dynamicProperties
-
Type:
array
dynamicPropertiesAdditional Properties Allowed:Array of custom properties at order line item level. - 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. - shippingSurchargeValue
-
Type:
number
shipping surcharge value. - unitPrice
-
Type:
number
The unit price. - variant
-
Type:
array
variantAdditional 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
Nested Schema : variant
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
- optionName
-
Type:
string
The variant option name. - optionValue
-
Type:
string
The variant option value.
Nested Schema : frequencyAmountTotals
Nested Schema : frequencyTaxTotals
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
Nested Schema : items
Type:
object
- active
-
Type:
boolean
active or not. - catRefId
-
Type:
string
The category to which the product belongs. - childItems
-
Type:
array
childItemsAdditional 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. - detailedRecurringChargeInfo
-
Type:
object
detailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - discountInfo
-
Type:
array
discountInfoAdditional Properties Allowed:The discount information. - displayName
-
Type:
string
The name of the product. - dynamicProperties
-
Type:
array
dynamicPropertiesAdditional Properties Allowed:Array of custom properties at order line item level. - 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
giftWithPurchaseCommerceItemMarkersAdditional 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. - unitPrice
-
Type:
integer
The unit price of the product. - variant
-
Type:
array
variantAdditional Properties Allowed:List of variants for the product.
Nested Schema : childItems
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
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : variant
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
detailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - displayName
-
Type:
string
The name of the product. - externalData
-
Type:
array
externalDataAdditional 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
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
valuesAdditional 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
giftWithPurchaseDiscountInfoAdditional 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
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
- 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
{
"gwp":false,
"lastModifiedTime":1.488091242E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.488090529E12,
"gwpMarkers":[
],
"salesChannel":"contactCenter",
"submittedDate":null,
"locale":"en",
"paymentGroups":[
{
"expirationYear":null,
"amountAuthorized":0,
"amount":309.92,
"gatewayName":null,
"expirationMonth":null,
"submittedDate":null,
"authorizationStatus":[
],
"token":null,
"paymentGroupClassType":"tokenizedCreditCard",
"creditCardNumber":null,
"paymentMethod":"tokenizedCreditCard",
"state":"INITIAL",
"id":"pg40411",
"billingAddress":{
"lastName":null,
"country":null,
"address3":null,
"address2":null,
"city":null,
"prefix":null,
"address1":null,
"postalCode":null,
"companyName":null,
"jobTitle":null,
"county":null,
"suffix":null,
"ownerId":null,
"selectedCountry":null,
"firstName":null,
"phoneNumber":null,
"faxNumber":null,
"middleName":null,
"state":null,
"email":null,
"selectedState":null,
"state_ISOCode":null
},
"debitStatus":[
],
"currencyCode":"USD"
}
],
"configuratorId":null,
"organizationId":"or-100002",
"relationships":[
{
"paymentGroupId":"pg40411",
"amount":309.92,
"relationshipType":"ORDERAMOUNTREMAINING",
"id":"r50389"
}
],
"priceInfo":{
"discounted":false,
"amount":249.99,
"total":309.92,
"shipping":35,
"manualAdjustmentTotal":0,
"amountIsFinal":false,
"discountAmount":0,
"tax":24.93,
"rawSubtotal":249.99,
"currencyCode":"USD"
},
"totalCommerceItemCount":1,
"id":"o40411",
"state":"FAILED_APPROVAL",
"quoteInfo":null,
"taxCalculated":true,
"commerceItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod10015",
"returnedQuantity":0,
"externalId":null,
"externalData":[
],
"billingAccountId":"billingAcc-123",
"catalogRefId":"sku10032",
"priceInfo":{
"discounted":true,
"amount":249.99,
"rawTotalPrice":299.99,
"salePrice":0,
"priceListId":"listPrices",
"quantityDiscounted":1,
"amountIsFinal":false,
"onSale":false,
"shippingSurcharge":0,
"discountable":true,
"currentPriceDetailsSorted":[
{
"discounted":true,
"amount":249.99,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"tax":21.86,
"orderDiscountShare":0,
"detailedUnitPrice":249.99,
"currencyCode":"USD"
}
],
"currencyCode":"USD",
"listPrice":299.99
},
"customerAccountId":"customerAcc-123",
"catalogId":null,
"assetId":"asset10001",
"lineAttributes":[
],
"catalogKey":null,
"productDisplayName":"Playstation 3",
"externalPriceDetails":null,
"actionCode":"Add",
"id":"ci4000413",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123"
}
],
"taxPriceInfo":{
"discounted":false,
"valueAddedTax":0,
"amount":24.93,
"countyTax":0.71,
"isTaxIncluded":false,
"miscTax":6.41,
"districtTax":0,
"stateTax":17.1,
"miscTaxInfo":{
"Special":6.41
},
"countryTax":0,
"cityTax":0.71,
"amountIsFinal":false,
"currencyCode":"USD"
},
"freezeDate":"2017-02-26T06:40:42.000Z",
"shippingGroups":[
{
"shippingMethod":"standardShippingMethod",
"description":"sg50411",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"shippingTax":3.07,
"amount":35,
"rawShipping":35,
"amountIsFinal":false,
"currencyCode":"USD"
},
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"shippingAddress":{
"lastName":"Blooming",
"country":"US",
"address3":null,
"address2":"Santa Clara County",
"city":"San Jose",
"prefix":null,
"address1":"7 W Jackson Blvd",
"postalCode":"95111",
"companyName":"US Motor Works, Inc.",
"jobTitle":null,
"county":null,
"suffix":null,
"ownerId":null,
"selectedCountry":"US",
"firstName":"Ron",
"phoneNumber":"408-752-3500",
"faxNumber":null,
"middleName":null,
"state":"CA",
"email":"ron@example.com",
"selectedState":"NY",
"state_ISOCode":"US-NY"
},
"commerceItemRelationships":[
{
"commerceItemId":"ci4000413",
"amount":0,
"quantity":1,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"commerceItemExternalId":null,
"state":"INITIAL",
"id":"r50387"
}
],
"state":"INITIAL",
"id":"sg50411",
"stateDetail":null,
"trackingNumber":null,
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"taxExempt":false,
"lastModifiedDate":"2017-02-26T06:40:42.000Z",
"approvalSystemMessages":[
"Order is pending approval because total is greater than the approved order limit."
],
"profile":{
"lastName":"Blooming",
"firstName":"Ron",
"shippingAddress":null,
"middleName":null,
"parentOrganization":{
"name":"US Motor Works, Inc.",
"id":"or-100002"
},
"email":"ron@example.com"
},
"shippingGroupCount":1,
"paymentGroupCount":1,
"profileId":"bb-110023",
"siteId":"siteUS",
"activeQuoteOrderId":null
}
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|
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
errorsAdditional 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
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": "Rejecting order", "orderId": "o40411" }
Sample Response Payload returned by endpoint:
{ "gwp": false, "lastModifiedTime": 1488091242000, "priceGroupId": "defaultPriceGroup", "creationTime": 1488090529000, "gwpMarkers": [], "salesChannel": "contactCenter", "submittedDate": null, "locale": "en", "paymentGroups": [{ "expirationYear": null, "amountAuthorized": 0, "amount": 309.92, "gatewayName": null, "expirationMonth": null, "submittedDate": null, "authorizationStatus": [], "token": null, "paymentGroupClassType": "tokenizedCreditCard", "creditCardNumber": null, "paymentMethod": "tokenizedCreditCard", "state": "INITIAL", "id": "pg40411", "billingAddress": { "lastName": null, "country": null, "address3": null, "address2": null, "city": null, "prefix": null, "address1": null, "postalCode": null, "companyName": null, "jobTitle": null, "county": null, "suffix": null, "ownerId": null, "selectedCountry": null, "firstName": null, "phoneNumber": null, "faxNumber": null, "middleName": null, "state": null, "email": null, "selectedState": null, "state_ISOCode": null }, "debitStatus": [], "currencyCode": "USD" }], "configuratorId": null, "organizationId": "or-100002", "relationships": [{ "paymentGroupId": "pg40411", "amount": 309.92, "relationshipType": "ORDERAMOUNTREMAINING", "id": "r50389" }], "priceInfo": { "discounted": false, "amount": 249.99, "total": 309.92, "shipping": 35, "manualAdjustmentTotal": 0, "amountIsFinal": false, "discountAmount": 0, "tax": 24.93, "rawSubtotal": 249.99, "currencyCode": "USD" }, "totalCommerceItemCount": 1, "id": "o40411", "state": "FAILED_APPROVAL", "quoteInfo": null, "taxCalculated": true, "commerceItems": [{ "serviceAccountId": "serviceAcc-123", "deactivationDate": "2018-06-27T12:59:59Z", "quantity": 1, "productId": "prod10015", "returnedQuantity": 0, "externalId": null, "externalData": [], "billingAccountId": "billingAcc-123", "catalogRefId": "sku10032", "priceInfo": { "discounted": true, "amount": 249.99, "rawTotalPrice": 299.99, "salePrice": 0, "priceListId": "listPrices", "quantityDiscounted": 1, "amountIsFinal": false, "onSale": false, "shippingSurcharge": 0, "discountable": true, "currentPriceDetailsSorted": [{ "discounted": true, "amount": 249.99, "quantity": 1, "amountIsFinal": false, "range": { "lowBound": 0, "highBound": 0, "size": 1 }, "tax": 21.86, "orderDiscountShare": 0, "detailedUnitPrice": 249.99, "currencyCode": "USD" }], "currencyCode": "USD", "listPrice": 299.99 }, "customerAccountId": "customerAcc-123", "catalogId": null, "assetId": "asset10001", "lineAttributes": [], "catalogKey": null, "productDisplayName": "Playstation 3", "externalPriceDetails": null, "actionCode": "Add", "id": "ci4000413", "activationDate": "2017-06-27T15:30:00Z", "serviceId": "service-123" }], "taxPriceInfo": { "discounted": false, "valueAddedTax": 0, "amount": 24.93, "countyTax": 0.71, "isTaxIncluded": false, "miscTax": 6.41, "districtTax": 0, "stateTax": 17.1, "miscTaxInfo": {"Special": 6.41}, "countryTax": 0, "cityTax": 0.71, "amountIsFinal": false, "currencyCode": "USD" }, "freezeDate": "2017-02-26T06:40:42.000Z", "shippingGroups": [{ "shippingMethod": "standardShippingMethod", "description": "sg50411", "submittedDate": null, "priceInfo": { "discounted": false, "shippingTax": 3.07, "amount": 35, "rawShipping": 35, "amountIsFinal": false, "currencyCode": "USD" }, "shipOnDate": null, "actualShipDate": null, "specialInstructions": {}, "shippingAddress": { "lastName": "Blooming", "country": "US", "address3": null, "address2": "Santa Clara County", "city": "San Jose", "prefix": null, "address1": "7 W Jackson Blvd", "postalCode": "95111", "companyName": "US Motor Works, Inc.", "jobTitle": null, "county": null, "suffix": null, "ownerId": null, "selectedCountry": "US", "firstName": "Ron", "phoneNumber": "408-752-3500", "faxNumber": null, "middleName": null, "state": "CA", "email": "ron@example.com", "selectedState": "NY", "state_ISOCode": "US-NY" }, "commerceItemRelationships": [{ "commerceItemId": "ci4000413", "amount": 0, "quantity": 1, "relationshipType": "SHIPPINGQUANTITY", "returnedQuantity": 0, "range": { "lowBound": 0, "highBound": 0, "size": 1 }, "commerceItemExternalId": null, "state": "INITIAL", "id": "r50387" }], "state": "INITIAL", "id": "sg50411", "stateDetail": null, "trackingNumber": null, "handlingInstructions": [], "shippingGroupClassType": "hardgoodShippingGroup" }], "taxExempt": false, "lastModifiedDate": "2017-02-26T06:40:42.000Z", "approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."], "profile": { "lastName": "Blooming", "firstName": "Ron", "shippingAddress": null, "middleName": null, "parentOrganization": { "name": "US Motor Works, Inc.", "id": "or-100002" }, "email": "ron@example.com" }, "shippingGroupCount": 1, "paymentGroupCount": 1, "profileId": "bb-110023", "siteId": "siteUS", "activeQuoteOrderId": null }