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(optional): string
the organization Id in which order should be created
-
X-CCSite(optional): string
the site Id in which order should be created
Root Schema : rejectOrder_request
Type:
Show Source
object-
approverMessage(optional):
string
The message given by approver when he is rejecting order.
-
orderId:
string
The order ID of the order which requires approval.
Example:
{
"approverMessage":"Rejecting order",
"orderId":"o30411"
}Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : rejectOrder_response
Type:
Show Source
object-
approvalSystemMessages(optional):
array approvalSystemMessages
An array of approval messages when order going in pending approval state
-
approverMessages(optional):
array approverMessages
An array of approval messages when approver approving order
-
approvers(optional):
array approvers
List of approvers of the organization.
-
billingAddress(optional):
object billingAddress
The billing address details.
-
cartName(optional):
string
Cart name for this order.
-
creationDate(optional):
string
The creation date in ISO format.
-
creationSiteId(optional):
string
The ID of the site on which the order was created. This may differ to siteId value if the site is part of a cart sharing group.
-
creationTime(optional):
number
The creation time in long seconds.
-
discountInfo(optional):
object discountInfo
The discount information.
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseInfo(optional):
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers(optional):
array giftWithPurchaseOrderMarkers
gift with purchase order marker information
-
id(optional):
string
The order ID.
-
lastModifiedDate(optional):
string
The order recent modified date in ISO format.
-
orderAction(optional):
string
The action performed on the order.
-
orderLocale(optional):
string
The locale in which order submitted.
-
orderProfileId(optional):
string
The profile-id of the order.
-
orderStatus(optional):
string
Status of the order.
-
paymentGroupId(optional):
string
The payment group ID used for the order.
-
payments(optional):
array payments
Payment details for the order, including additional properties specific to the payment type.
-
priceInfo(optional):
object priceInfo
The price information.
-
priceListGroup(optional):
object priceListGroup
The price list group object.
-
quoteInfo(optional):
object quoteInfo
the quote information of the order
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
scheduledOrder(optional):
array scheduledOrder
schedule order information
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingGroups(optional):
array shippingGroups
The shipping groups for the order.
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
shoppingCart/order(optional):
object shoppingCart/order
The shopping-cart or order contents of the current order.
-
siteId(optional):
string
The ID of the site on which the order was placed.
-
submittedDate(optional):
string
The order submitted date in ISO format.
-
trackingInfo(optional):
array trackingInfo
Tracking Information for the Order.
-
uuid(optional):
string
The unique ID for the order.
Nested Schema : approvalSystemMessages
Type:
arrayAn array of approval messages when order going in pending approval state
Show Source
Nested Schema : approverMessages
Type:
arrayAn array of approval messages when approver approving order
Show Source
Nested Schema : billingAddress
Type:
objectThe billing address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry(optional):
string
Country code.
-
selectedState(optional):
string
State code.
-
state(optional):
string
State.
-
state_ISOCode(optional):
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : discountInfo
Type:
objectThe discount information.
Show Source
-
claimedCouponMultiPromotions(optional):
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap(optional):
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount(optional):
number
The order discount.
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
The implicit order discounts with the order.
-
shippingDiscount(optional):
number
The shipping discount.
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap(optional):
object unclaimedCouponsMap
The unclaimed coupons with the order.
Nested Schema : dynamicProperties
Type:
arrayRead-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
arraygift with purchase order marker information
Show Source
Nested Schema : payments
Type:
arrayPayment details for the order, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type:
objectThe price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
shipping(optional):
number
The total shipping cost.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
Sub-total.
-
tax(optional):
number
The total tax amount.
-
total(optional):
number
The order total.
Nested Schema : priceListGroup
Type:
objectThe price list group object.
Show Source
-
repositoryId(optional):
string
Repository ID of the price list group.
Nested Schema : quoteInfo
Type:
objectthe quote information of the order
Show Source
-
errorInfo(optional):
array errorInfo
the array of errors, if any
-
expirationDate(optional):
string
the expiration date of the quoted order, if any
-
externalId(optional):
string
the external ID for the quote
-
notes(optional):
array notes
the notes (history) for the order
-
providerNote(optional):
string
the provider note for the quoted order
-
quoteDate(optional):
number
the date the order was quoted in milliseconds
-
rejectionDate(optional):
string
rejection date of the quoted order
-
rejectionNote(optional):
string
the rejection note for an order whose quote has been rejected by user
-
requestDate(optional):
string
the date when the quote was requested in ISO format
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry(optional):
string
Country code.
-
selectedState(optional):
string
State code.
-
state(optional):
string
State.
-
state_ISOCode(optional):
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
Show Source
-
cost(optional):
number
The total cost of shipping.
-
value(optional):
string
The shipping method applied to the order.
Nested Schema : shoppingCart/order
Type:
objectThe shopping-cart or order contents of the current order.
Show Source
-
items(optional):
array items
The array of products in the shopping cart.
Nested Schema : items
Type:
Show Source
object-
approverId(optional):
string
ID of approver.
-
firstName(optional):
string
First name of approver.
-
lastName(optional):
string
Last name of approver.
Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : orderImplicitDiscountList
Type:
arrayThe implicit order discounts with the order.
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
objectThe unclaimed coupons with the order.
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
objectCoupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The promotion ID.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
string
The total adjustment.
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
giftWithPurchaseDetail(optional):
string
String identifying the free gift, usually the repository ID of the gift type.
-
giftWithPurchaseIdentifier(optional):
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(optional):
number
gift quantity available for selection
-
giftWithPurchaseType(optional):
string
The type of the gift. (sku, product)
-
promotionId(optional):
string
The gift with purchase promotion ID
Nested Schema : items
Type:
Show Source
object-
automaticQuantity(optional):
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove(optional):
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data(optional):
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(optional):
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(optional):
string
String identifying the free gift, usually the repository ID of the gift type.
-
giftType(optional):
string
The type of the gift. (sku, product)
-
key(optional):
string
atg.gwp
-
quantity(optional):
number
The total quantity of sku for this gift selection.
-
removedQuantity(optional):
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity(optional):
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity(optional):
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(optional):
string
The gift with purchase promotion ID
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
Amount authorized from the payment group.
-
balance(optional):
number
Total available balance on the gift card.
-
gatewayName(optional):
string
Payment gateway name. e.g. chaseCreditCard.
-
giftCardNumber(optional):
string
Gift card number.
-
isAmountRemaining(optional):
boolean
A boolean to decide if more payment can be made from this payment group.
-
maskedCardNumber(optional):
string
Masked gift card number.
-
paymentGroupId(optional):
string
Payment group ID.
-
paymentMethod(optional):
string
Payment method. e.g. physicalGiftCard/ creditCard.
-
paymentState(optional):
string
The state of the payment group. e.g. AUTHORIZED.
-
PONumber(optional):
string
Purchase order number for invoice payment. Payment type:invoice
-
savedCardId(optional):
string
ID of the saved card associated with the payment group.
-
uiIntervention(optional):
string
This decides whether the client has to do some intervention for payment. e.g. SOP.
Nested Schema : items
Type:
Show Source
object-
profileId(optional):
string
the profile ID of the user
-
profileType(optional):
string
the profile type of the user that requested the quote
-
requestDate/quoteDate/rejectionDate(optional):
number
the request/quote/rejection date for the note
-
requesterNote/providerNote/rejectionNote(optional):
string
the requester/provider/rejection note
Nested Schema : frequencyAmountTotals
Type:
arrayThe total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
clonedOrders(optional):
array clonedOrders
list of orders that is created using this as template.
-
createDate(optional):
string
The submitted date in ISO format.
-
endDate(optional):
string
The submitted date in ISO format.
-
executionStatusList(optional):
array executionStatusList
list of orders with status that are placed with this schedule.
-
id(optional):
string
The scheduled order ID.
-
lastError(optional):
object lastError
last error of this scheduled order.
-
lastScheduledRun(optional):
string
last date of order placed.
-
name(optional):
string
name of scheduled order.
-
nextScheduledRun(optional):
string
next date of order to be placed.
-
profileId(optional):
string
the profile ID of the user.
-
repositoryId(optional):
string
repository ID of scheduled order.
-
schedule:
object schedule
schedule details for the schedule.
-
siteId(optional):
string
ID of site.
-
startDate(optional):
string
The submitted date in ISO format.
-
status(optional):
string
status of schedule order active or inactive.
-
templateOrderId(optional):
string
template order ID.
-
type(optional):
string
type of order.
-
version(optional):
integer
version scheduled order.
Nested Schema : clonedOrders
Type:
arraylist of orders that is created using this as template.
Show Source
Nested Schema : executionStatusList
Type:
arraylist of orders with status that are placed with this schedule.
Show Source
Nested Schema : lastError
Type:
objectlast error of this scheduled order.
Show Source
-
errorDate(optional):
string
The date when error occurred
-
errorMessages(optional):
array errorMessages
An array of error messages
-
scheduleErrorId(optional):
string
error ID of the last failed schedule order
Nested Schema : schedule
Type:
objectschedule details for the schedule.
Show Source
-
daysInMonth(optional):
array daysInMonth
mention which days of Month schedule should run. values can be 1 to 31.
-
daysOfWeek(optional):
array daysOfWeek
mention which days of week schedule should run. values can be 1 to 7.
-
monthsInYear(optional):
array monthsInYear
The months in year of the Scheduled order. Values can be 0 to 11.
-
occurenceInDay(optional):
integer
The occurence in day on the Scheduled order. Values can be 1 or 2.
-
weeksInMonth(optional):
array weeksInMonth
The weeks in month of the Scheduled order.Values can be 1 to 5
Nested Schema : items
Type:
Show Source
object-
orderId(optional):
string
The ID of the template order.
Nested Schema : items
Type:
Show Source
object-
errorMessages(optional):
array errorMessages
The error messages list.
-
executionDate(optional):
string
The date for previous scheduled run
-
id(optional):
string
The ID of the Scheduled order.
-
orderId(optional):
string
The ID of the template order.
-
orderSubmitted(optional):
boolean
The status of order.
-
orderTotal(optional):
number
Total order value.
-
repositoryId(optional):
string
The ID of the Scheduled order.
-
scheduledOrderId(optional):
string
The ID of the Scheduled order.
Nested Schema : daysInMonth
Type:
arraymention which days of Month schedule should run. values can be 1 to 31.
Show Source
Nested Schema : daysOfWeek
Type:
arraymention which days of week schedule should run. values can be 1 to 7.
Show Source
Nested Schema : monthsInYear
Type:
arrayThe months in year of the Scheduled order. Values can be 0 to 11.
Show Source
Nested Schema : weeksInMonth
Type:
array The weeks in month of the Scheduled order.Values can be 1 to 5
Show Source
Nested Schema : items
Type:
Show Source
object-
actualShipDate(optional):
string
The actual ship date in ISO format.
-
discountInfo(optional):
object discountInfo
The shipping group price information.
-
email(optional):
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName(optional):
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items(optional):
array items
The array of products in the shipping group.
-
lastName(optional):
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName(optional):
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber(optional):
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
priceInfo(optional):
object priceInfo
The shipping group price information.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shipOnDate(optional):
string
The ship on date in ISO format.
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingGroupId(optional):
string
The shipping group ID.
-
shippingMethod(optional):
object shippingMethod
The shipping method details.
-
status(optional):
string
The shipping group status.
-
store(optional):
object store
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
submittedDate(optional):
string
The submitted date in ISO format.
-
taxPriceInfo(optional):
object taxPriceInfo
The shipping tax price info details.
-
trackingNumber(optional):
string
The tracking number.
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
Nested Schema : discountInfo
Type:
objectThe shipping group price information.
Show Source
-
discountDescList(optional):
array discountDescList
The list of all the order discounts.
-
orderDiscount(optional):
number
The orderDiscount.
-
shippingDiscount(optional):
number
The shipping discount.
Nested Schema : priceInfo
Type:
objectThe shipping group price information.
Show Source
-
amount(optional):
number
The shipping method amount.
-
currencyCode(optional):
string
The shipping method amount.
-
shipping(optional):
number
The shipping amount.
-
shippingSurchargeValue(optional):
number
The shipping surcharge value amount.
-
subTotal(optional):
number
The shipping group subtotal.
-
tax(optional):
number
The shipping method tax amount.
-
total(optional):
number
The total cost of shipping.
-
totalWithoutTax(optional):
number
The shipping items total.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry(optional):
string
Country code.
-
selectedState(optional):
string
State code.
-
state(optional):
string
State.
-
state_ISOCode(optional):
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details.
Show Source
-
cost(optional):
number
The total cost of shipping.
-
shippingMethodDescription(optional):
string
The description of the shipping method.
-
shippingTax(optional):
number
The shipping tax.
-
value(optional):
string
The shipping method applied to the order.
Nested Schema : store
Type:
objectInformation about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1(optional):
string
Address line 1 of the store.
-
address2(optional):
string
Address line 2 of the store.
-
address3(optional):
string
Address line 3 of the store.
-
city(optional):
string
The city in which the store resides.
-
country(optional):
string
The country in which the store resides.
-
county(optional):
string
The county in which the store resides.
-
email(optional):
string
The email address of the store.
-
faxNumber(optional):
string
The fax number of the store.
-
hours(optional):
string
The opening hours of the store.
-
locationId(optional):
string
The location ID of the store.
-
name(optional):
string
Name of the store.
-
phoneNumber(optional):
string
The phone number of the store.
-
postalCode(optional):
string
The postal code of the store.
-
stateAddress(optional):
string
The state in which the store resides.
Nested Schema : taxPriceInfo
Type:
objectThe shipping tax price info details.
Show Source
-
amount(optional):
number
The shipping method amount.
-
cityTax(optional):
number
The shipping group subtotal.
-
countryTax(optional):
number
The country tax total.
-
countyTax(optional):
number
The county tax amount.
-
districtTax(optional):
string
The shipping method applied to the order.
-
isTaxIncluded(optional):
boolean
Flag that states whether is tax included.
-
miscTax(optional):
string
The miscellaneous tax amount.
-
stateTax(optional):
number
The shipping method tax amount.
-
valueAddedTax(optional):
number
The value added tax .
Nested Schema : items
Type:
Show Source
object-
coupon(optional):
string
The coupon code.
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The promotion ID.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : items
Type:
Show Source
object-
active(optional):
boolean
UIs this product active.
-
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
catRefId(optional):
string
The product variant ID.
-
detailedItemPriceInfo(optional):
object detailedItemPriceInfo
Detailed Item Price Information.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountAmount(optional):
string
The discount amount.
-
displayName(optional):
string
Display Name.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
inventoryLocationId(optional):
string
Defines the inventory location that services the referenced commerce item.
-
listPrice(optional):
string
List Price.
-
onSale(optional):
boolean
Indicates whether the price is for an item that is on sale.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
primaryImageAltText(optional):
string
Primary Image Alternative Text.
-
primaryImageTitle(optional):
string
Primary Image Title.
-
primaryThumbImageURL(optional):
string
Primary Thumb Image URL.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product in this shipping group.
-
rawTotalPrice(optional):
string
Raw Total Price.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
relationshipType(optional):
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
-
route(optional):
string
route.
-
salePrice(optional):
string
Sale Price.
-
shippingSurchargeValue(optional):
number
shipping surcharge value.
-
siteId(optional):
string
The ID of the site on which the item was added.
-
state(optional):
string
state of the commerce Item
-
unitPrice(optional):
number
The unit price.
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : detailedItemPriceInfo
Type:
objectDetailed Item Price Information.
Show Source
-
amount(optional):
number
The amount.
-
currencyCode(optional):
string
The currency code.
-
detailedUnitPrice(optional):
number
Detailed Unit Price.
-
discounted(optional):
boolean
Is this item discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
number
The quantity.
-
tax(optional):
number
The tax amount.
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : frequencyAmountTotals
Type:
arrayThe total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
active(optional):
boolean
active or not.
-
catRefId(optional):
string
The product variant ID.
-
childItems(optional):
array childItems
The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountInfo(optional):
array discountInfo
The discount information.
-
displayName(optional):
string
The name of the product.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalPrice(optional):
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(optional):
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(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
giftWithPurchaseCommerceItemMarkers(optional):
array giftWithPurchaseCommerceItemMarkers
The array of giftWithPurchaseCommerceItemMarkers.
-
id(optional):
string
Repository ID of the commerce item.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
price(optional):
integer
The actual price of the product.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product.
-
rawTotalPrice(optional):
integer
The raw price of the product.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
state(optional):
string
state of the commerce Item
-
unitPrice(optional):
integer
The unit price of the product.
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : childItems
Type:
arrayThe array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
arrayThe array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (externally configured) or not (externally configured).
-
amount(optional):
integer
The total amount of this item including its child items amounts.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
skuid of the item.
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
displayName(optional):
string
The name of the product.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
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(optional):
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(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
id(optional):
string
Repository ID of the commerce item.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product.
-
rawTotalPrice(optional):
integer
The raw price of the product.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
integer
The unit price of the product.
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object-
coupon(optional):
string
The coupon ID.
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
giftWithPurchaseDiscountInfo(optional):
array giftWithPurchaseDiscountInfo
The gift information.
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The promotion ID.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment by the promotion.
Nested Schema : items
Type:
Show Source
object-
giftWithPurchaseChoicesAvailable(optional):
boolean
If this gift with purchase has multiple gift choices.
-
giftWithPurchaseIdentifier(optional):
integer
The gift hash code for this gift with purchase promotion.
-
giftWithPurchaseQuantity(optional):
number
The quantity that is gift quantity
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
automaticQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data(optional):
integer
The gift hash code for this gift with purchase promotion.
-
key(optional):
string
atg.gwp
-
remainingQuantity(optional):
number
The quantity of the commerce item that is not affected by gift with purchase.
-
selectedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value(optional):
string
The gift with purchase promotion ID.
Nested Schema : items
Type:
Show Source
object-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : items
Type:
Show Source
object-
carrierId(optional):
string
Carrier ID for Tracking.
-
carrierName(optional):
string
Carrier Name for Tracking.
-
carrierUrl(optional):
string
Carrier URL for Tracking.
-
trackingNumber(optional):
string
Tracking Number.
Example Response (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"
},
"submissionProgress":[
],
"totalCommerceItemCount":1,
"id":"o40411",
"state":"FAILED_APPROVAL",
"quoteInfo":null,
"taxCalculated":true,
"commerceItems":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"returnedQuantity":0,
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"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
},
"catalogId":null,
"externalPriceDetails":null,
"actionCode":"Add",
"id":"ci4000413",
"serviceId":"service-123",
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"productId":"prod10015",
"externalId":null,
"parentAssetKey":null,
"originalCommerceItemId":null,
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catalogRefId":"sku10032",
"customerAccountId":"customerAcc-123",
"lineAttributes":[
],
"catalogKey":null,
"productDisplayName":"Playstation 3",
"siteId":"siteUS",
"activationDate":"2017-06-27T15:30:00Z",
"asset":false
}
],
"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",
"inventoryLocationId":null,
"amount":0,
"quantity":1,
"pointOfNoRevision":false,
"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",
"creationSiteId":"siteUS",
"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,
"orderAction":"order",
"paymentGroupCount":1,
"submissionErrorCodes":[
],
"submissionErrorMessages":[
],
"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|
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code