approveOrder
post
/ccagent/v1/orders/approve
Approve Order. Approver approves 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: string
the organization Id in which order should be created
-
X-CCSite: string
the site Id in which order should be created
Root Schema : approveOrder_request
Type:
Show Source
object-
approverMessage:
string
the message given by approver when he is approving order.
-
ignorePriceWarnings(required):
boolean
this flag decides whether approver is allowing order to be repriced as part of approval or not.
-
orderId(required):
string
the order id of the order which requires approval.
Example:
{
"approverMessage":"Approving order",
"orderId":"o40411"
}Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : approveOrder_response
Type:
Show Source
object-
allowAlternateCurrency:
boolean
A site level setting which enables the shopper to split the payment amount in points and monetary currency, irrespective of the order level price list group.
-
approverMessages:
string
Approver Messages.
-
approvers:
array approvers
List of approvers of the organization.
-
creationDate:
string
The creation date in ISO format.
-
creationSiteId:
string
The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
-
creationTime:
number
Order creation time.
-
discountInfo:
object discountInfo
Discount information.
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
exchangeRate:
number
The coversion rate used to convert values from primary currency to secondary currency. Primary currency refers to to currency code associated with the order level price list group.
-
giftWithPurchaseInfo:
array giftWithPurchaseInfo
Gift Selection Information
-
giftWithPurchaseOrderMarkers:
array giftWithPurchaseOrderMarkers
Gift With Purchase order markers information
-
id(required):
string
The order id.
-
markers:
array markers
Order markers
-
orderAction:
string
The action performed on the order.
-
orderComments:
array orderComments
The list of all logged comments for the order.
-
paymentGroup:
object paymentGroup
Payment Group for the order.
-
payShippingInSecondaryCurrency:
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay Shipping in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
-
payTaxInSecondaryCurrency:
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
-
priceInfo:
object priceInfo
The price information.
-
priceListGroup:
object priceListGroup
PriceList group of the order.
-
pricingMessages:
object pricingMessages
The Pricing messages information.
-
profile:
object profile
Profile Information for the order.
-
profileId(required):
string
profile id.
-
returnRequests:
array returnRequests
The list of the requests raised for the order.
-
secondaryCurrencyCode:
string
The currency code of secondary currency associated with the site.
-
shippingAddress(required):
object shippingAddress
Shipping address.
-
shippingGroups:
array shippingGroups
Shipping Group Information
-
shippingMethod:
object shippingMethod
Shipping method information.
-
shoppingCart:
object shoppingCart
Shopping cart information.
-
siteId:
string
The ID of the site on which the order was placed.
-
state:
integer
The order state.
-
stateDetailsAsUser:
string
Order State description for this order.Incorporates changes made by merchant from admin UI, if any.
-
stateString:
string
Order state as key string.
-
submissionErrorCodes:
array submissionErrorCodes
Set of error codes recorded during each unsuccessful retry of queued orders.
-
submissionErrorMessages:
array submissionErrorMessages
List of failure reasons recorded during each unsuccessful retry of queued orders.
-
submissionProgress:
array submissionProgress
Checkpoints crossed successfully during each unsuccessful retry of queued orders.
-
taxPriceInfo:
object taxPriceInfo
The tax pricing details for the order.
-
totalAmountAuthorized:
number
total amount authorized for the order.
Nested Schema : discountInfo
Type:
objectDiscount information.
Show Source
-
claimedCouponMultiPromotions:
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
secondaryCurrencyShippingDiscount:
number
The shipping discount in secondary currency in case of mix currency scenario.
-
shippingDiscount:
number
The shipping discount.
-
unclaimedCouponMultiPromotions:
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
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 markers information
Show Source
Nested Schema : orderComments
Type:
arrayThe list of all logged comments for the order.
Show Source
Nested Schema : paymentGroup
Type:
objectPayment Group for the order.
Show Source
-
amount:
number
The amount associated with this Payment Group.
-
amountAuthorized:
number
The amount authorized with this Payment Group.
-
balance:
string
The gift card balance available.
-
billingAddress:
object billingAddress
Billing address for the order.
-
cardNumber:
string
The masked credit card number.
-
cardType:
string
The credit card type.
-
firstName:
string
First name associated with this Payment Group.
-
lastName:
string
Last name associated with this Payment Group.
-
paidAmount:
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId:
integer
Id of this payment Group.
-
paymentState:
string
The Payment Group state.
-
paymentStateDetailsAsUser:
string
The payment state description as string.
-
paymentStatString:
string
The payment state as a key string.
-
PONumber:
string
Purchase order number for invoice payment. Payment type: invoice
-
refundAmount:
number
The amount that has been credited to-date for this Payment Group.
-
token:
string
Token associated with this Payment Group.
-
totalDue:
number
The current working total order price including all discounts, tax, and billing costs.
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
-
zero_value_auto_authorized:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : priceInfo
Type:
objectThe price information.
Show Source
-
amount:
number
The total order amount.
-
currencyCode:
string
The currency code.
-
primaryCurrencyTotal:
number
An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
-
secondaryCurrencyShippingAmount:
number
This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
-
secondaryCurrencyShippingSurchargeValue:
number
The shipping surcharges added at item level in monetary currency.
-
secondaryCurrencyTaxAmount:
number
"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
-
secondaryCurrencyTotal:
number
An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
-
shipping:
number
The total shipping cost.
-
shippingSurchargeValue:
number
Extra handling costs for shipping the products.
-
subTotal:
number
Sub-total.
-
tax:
number
The total tax amount.
-
taxExclusiveAmount:
number
Total excluding shipping and tax in monetary currency
-
total:
number
The order total.
Nested Schema : priceListGroup
Type:
objectPriceList group of the order.
Show Source
-
active:
boolean
Active status of pricelist group.
-
currency:
object currency
Currency of the PriceList group.
-
deleted:
boolean
Pricelist group deleted status.
-
displayName:
string
Display Name.
-
id:
string
Id.
-
locale:
string
Locale.
-
repositoryId:
string
Repository Id.
Nested Schema : pricingMessages
Type:
objectThe Pricing messages information.
Show Source
-
GiftWithPurchaseMessages:
array GiftWithPurchaseMessages
The GWP messages information.
Nested Schema : profile
Type:
objectProfile Information for the order.
Show Source
-
email:
string
Email Address corresponding to the profile.
-
firstName:
string
First name of profile.
-
lastName:
string
Last name of profile.
-
middleName:
string
Middle name of profile.
-
organization:
object organization
The Organization associated with the B2B customer profile.
Nested Schema : returnRequests
Type:
arrayThe list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type:
objectShipping address.
Show Source
-
address1(required):
string
The address1 of the shipping address.
-
address2(required):
string
The address2 of the shipping address.
-
address3:
string
The address3 of the shipping address.
-
city(required):
string
The city of the shipping address.
-
companyName:
string
The companyName.
-
country(required):
string
The country of the shipping address.
-
county:
string
The county of the shipping address.
-
DEFAULT_POSTAL_CODE_PATTERN:
string
The default post code pattern of the shipping address.
-
email(required):
string
email of the shipping address.
-
faxNumber:
string
The faxNumber of the shipping address.
-
firstName(required):
string
The first name of the shipping address.
-
jobTitle:
string
The job title.
-
lastName(required):
string
The last name of the shipping address.
-
middleName:
string
The middle name of the shipping address.
-
phoneNumber(required):
string
The phone Number of the shipping address.
-
postalCode(required):
string
The postal Code of the shipping address.
-
prefix:
string
prefix of shipping address name.
-
selectedCountry(required):
string
The selected country of the shipping address.
-
selectedState(required):
string
The selected state of the shipping address.
-
state(required):
string
The state of the shipping address.
-
state_ISOCode(required):
string
The state ISON code of the shipping address.
-
suffix:
string
suffix of the shipping address name.
Nested Schema : shippingMethod
Type:
objectShipping method information.
Show Source
-
cost:
number
shipping cost.
-
displayName:
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount:
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount:
string
tax amount in secondary currency.
-
value:
string
method type of shipment.
Nested Schema : shoppingCart
Type:
objectShopping cart information.
Show Source
-
items:
array items
Items in the cart.
Nested Schema : submissionErrorCodes
Type:
arraySet of error codes recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionErrorMessages
Type:
arrayList of failure reasons recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionProgress
Type:
arrayCheckpoints crossed successfully during each unsuccessful retry of queued orders.
Show Source
Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
Show Source
-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether the amount is final.
-
cityTax:
number
The monetary amount of city tax.
-
countryTax:
number
The monetary amount of country tax.
-
countyTax:
number
The monetary amount of county tax.
-
currencyCode:
string
The three character currency code.
-
discounted:
boolean
Whether the price was discounted.
-
districtTax:
number
Tax amount for the district.
-
stateTax:
number
Tax amount for the state.
Nested Schema : items
Type:
Show Source
object-
approverId:
string
Id of approver.
-
firstName:
string
First name of approver.
-
lastName:
string
Last name of approver.
Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
Show Source
-
couponCode:
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-
promotionDesc:
string
Promotion description.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
objectCoupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by 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-
promotionDesc:
string
Promotion description.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
Nested Schema : items
Type:
Show Source
object-
couponInfo:
array couponInfo
The coupon Info.
-
promotionValue:
string
The value for promotion.
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
id:
string
The ID of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
giftHashCode:
string
The gift hash code for the promotion
-
giftWithPurchaseDetail:
string
String identifying the gift usually the repository ID of the gift type.
-
giftWithPurchaseIdentifier:
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:
number
Quantity of gift that the shopper still needs to select.
-
giftWithPurchaseType:
string
The type of gift like sku, product, category, skuContentGroup or productContentGroup.
-
promotionDesc:
string
The promotion description.
-
promotionId:
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object-
automaticQuantity:
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data:
string
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:
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:
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType:
string
The type of gift like sku, product, category, skuContentGroup or productContentGroup.
-
key:
string
atg.gwp.
-
quantity:
number
The total quantity of sku for this gift selection.
-
removedQuantity:
number
The amount of free quantity that has since been manually removed by a Shopper.
-
repositoryId:
string
The repository id of the gwp order marker.
-
selectedQuantity:
number
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity:
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:
string
The GWP promotion id.
Nested Schema : items
Type:
Show Source
object-
key:
string
Order marker key. In a marketing campaign marker, key signifies that it is a campaign marker and it also identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
-
value:
string
Order marker value. In a marketing campaign marker, value holds the marketing system's unique campaign ID.
Nested Schema : items
Type:
Show Source
object-
comment:
string
The comment string.
-
creationDate:
string
Date on which the comment was created.
-
repositoryId:
string
The repository id of the comment record.
Nested Schema : billingAddress
Type:
objectBilling address for the order.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this billing address.
-
state_ISOCode:
string
The state ISON code of the shipping address.
-
suffix:
string
Suffix for this billing address.
Nested Schema : currency
Type:
objectCurrency of the PriceList group.
Show Source
-
currencyCode:
string
Currency Code.
-
displayName:
string
Display Name.
-
fractionalDigits:
integer
Fractional Digits.
-
numericCode:
string
Numeric Code.
-
repositoryId:
string
Repository Id.
-
symbol:
string
currency Symbol.
Nested Schema : items
Type:
Show Source
object-
identifier:
string
The pricing message identifier.
-
params:
array params
The list of all message parameters.
-
priority:
integer
The pricing message priority.
-
summary:
string
The pricing message summary.
-
type:
string
The pricing message type.
Nested Schema : organization
Type:
objectThe Organization associated with the B2B customer profile.
Show Source
-
id:
string
The id of the organization.
-
name:
string
The name of of the organization.
Nested Schema : items
Type:
Show Source
object-
createdDate:
string
The creation date of the return request.
-
returnRequestId:
string
The return request id.
-
state:
string
The status of the return request.
-
stateKey:
string
State key for return request which is not localized
-
totalRefund:
number
The total amount to be refunded on return.
-
totalReturnQuantity:
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
Show Source
object-
email:
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName:
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items(required):
array items
Items in the cart.
-
lastName:
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName:
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber:
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
shippingAddress:
object shippingAddress
shipping address for the order.
-
shippingMethod:
object shippingMethod
Shipping method information.
-
store:
object store
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
trackingInfo:
array trackingInfo
Tracking Information for the Order.
-
trackingNumber:
string
Shipping tracking number.
-
type:
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
Nested Schema : shippingAddress
Type:
objectshipping address for the order.
Show Source
-
address1:
string
Address Line 1 for this shipping address.
-
address2:
string
Address Line 2 for this shipping address.
-
address3:
string
Address Line 3 for this shipping address.
-
city:
string
City for this shipping address.
-
companyName:
string
Company name for this shipping address.
-
country:
string
Country for this shipping address.
-
county:
string
County for this shipping address.
-
email:
string
Email for this shipping address.
-
faxNumber:
string
Fax number for this shipping address.
-
firstName:
string
First name for this shipping address.
-
jobTitle:
string
Job title for this shipping address.
-
lastName:
string
Last name for this shipping address.
-
middleName:
string
Middle name for this shipping address.
-
phoneNumber:
string
Phone number for this shipping address.
-
postalCode:
string
Postal code for this shipping address.
-
prefix:
string
Prefix for this shipping address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this shipping address.
-
state_ISOCode:
string
The state ISON code of the shipping address.
-
suffix:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
objectShipping method information.
Show Source
-
cost:
number
shipping cost.
-
displayName:
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount:
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount:
string
tax amount in secondary currency.
-
value:
string
method type of shipment.
Nested Schema : store
Type:
objectInformation about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1:
string
Address line 1 of the store.
-
address2:
string
Address line 2 of the store.
-
address3:
string
Address line 3 of the store.
-
city:
string
The city in which the store resides.
-
country:
string
The country in which the store resides.
-
county:
string
The county in which the store resides.
-
email:
string
The email address of the store.
-
faxNumber:
string
The fax number of the store.
-
hours:
string
The opening hours of the store.
-
locationId:
string
The location id of the store.
-
name:
string
Name of the store.
-
phoneNumber:
string
The phone number of the store.
-
postalCode:
string
The postal code of the store.
-
stateAddress:
string
The state in which the store resides.
Nested Schema : items
Type:
Show Source
object-
availablePickupDate:
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
catRefId(required):
string
catRefId of the product.
-
pointOfNoRevision:
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preferredPickupDate:
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
productId(required):
string
Id of the product.
-
quantity(required):
integer
quantity of the product.
-
relationshipType:
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
-
siteId:
string
The ID of the site on which the item was added.
-
skuProperties:
array skuProperties
Sku properties Information
-
variant:
array variant
Product Variant Information.
Nested Schema : items
Type:
Show Source
object-
id:
string
ID of the Dynamic SKU Property.
-
name:
string
Name of the Dynamic SKU Property.
-
propertyType:
string
Type that indicates whether it is a base or a custom SKU property,
-
value:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object-
carrierId:
string
Carrier Id for Tracking.
-
carrierName:
string
Carrier Name for Tracking.
-
carrierUrl:
string
Carrier URL for Tracking.
-
trackingNumber:
string
Tracking Number
Nested Schema : items
Type:
Show Source
object-
catRefId:
string
Catalog Reference Id of commerce item.
-
childItems:
array childItems
Child items of the commerce item
-
commerceItemId:
string
Unique id of the line item
-
configuratorId:
string
Configuration id of the configurable product
-
discountAmount:
number
Total discount applied to commerce item.
-
discountInfo:
object discountInfo
Discount information.
-
displayName:
string
Display name of commerce item.
-
externalPrice:
number
The Price of the product as per the external pricing system.
-
externalPriceQuantity:
integer
Quantity of the product, the customer is allowed to buy at the external price.
-
giftWithPurchaseCommerceItemMarkers:
array giftWithPurchaseCommerceItemMarkers
The array of giftWithPurchaseCommerceItemMarkers.
-
imageInfo:
object imageInfo
Shipping method information.
-
isPriceOverridden:
boolean
Indicates if commerce item price is overridden or not.
-
nonreturable:
boolean
Indicates whether the item is returnable or not.
-
onSale:
boolean
indicates if product is on sale or not
-
originalCommerceItemId:
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
overriddenPrice:
number
overridden price of commerce item.
-
price:
number
The raw number that represents the price.
-
priceOverridenBy:
string
Name of the agent who has overridden item price.
-
priceOverrideReason:
object priceOverrideReason
Price override reason map.
-
productId:
string
Product Id of commerce item.
-
quantity:
number
Quantity of the items.
-
rawTotalPrice:
number
The raw total price.
-
returnedQuantity:
number
Quantity for which return request has been raised.
-
siteId:
string
The ID of the site on which the item was added.
-
skuProperties:
array skuProperties
Sku properties Information
-
stateDescription:
string
Item state as a key string.
-
stateDetailsAsUser:
string
State description of the commerce item.
-
status:
integer
State of the commerce item.
-
subTotal:
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.
-
tax:
number
The amount of tax paid for this item.
-
unitPrice:
number
Sale price or list price of commerceItem.
-
variant:
array variant
Product Variant Information.
Nested Schema : discountInfo
Type:
objectDiscount information.
Show Source
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
secondaryCurrencyShippingDiscount:
number
The shipping discount in secondary currency in case of mix currency scenario.
-
shippingDiscount:
number
The shipping discount.
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
arrayThe array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : imageInfo
Type:
objectShipping method information.
Show Source
-
primaryThumbImageURL:
string
ThumbNail Image URL
Nested Schema : priceOverrideReason
Type:
objectPrice override reason map.
Show Source
-
displayValue:
string
price override reason value.
-
key:
string
price override reason key.
Nested Schema : items
Type:
Show Source
object-
addOnItem:
boolean
Whether the sub commerce item is an add-on (internally configured) or not (externally configured).
-
catRefId:
string
Sku Id of the child item
-
childItems:
array childItems
Child items of the commerce item
-
commerceItemId:
string
commerce item id of the child item
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this sub commerce item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this sub commerce item.
-
displayName:
string
Display name of the child product
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
route:
string
Product path
-
selectedOptions:
array selectedOptions
Child Product Variant Information.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId:
string
The ID of the site on which the item was added.
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
catRefId:
string
Sku Id of the child item
-
displayName:
string
Display name of the child product
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
route:
string
Product path
-
selectedOptions:
array selectedOptions
Child Product Variant Information.
-
siteId:
string
The ID of the site on which the item was added.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : couponCode
Type:
objectCoupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
couponInfo:
array couponInfo
The coupon Info.
-
promotionValue:
string
The value for promotion.
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
automaticQuantity:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data:
integer
The gift hash code for this GWP promotion.
-
key:
string
atg.gwp
-
remainingQuantity:
number
The quantity of the commerce item that is not affected by GWP.
-
selectedQuantity:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value:
string
The gift with purchase promotion id.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
Name of the Dynamic SKU Property.
-
optionValue:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Example Response (application/json)
{
"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"
},
"submissionProgress":[
],
"totalCommerceItemCount":1,
"id":"o40411",
"state":"PENDING_PAYMENT",
"quoteInfo":null,
"taxCalculated":true,
"commerceItems":[
{
"quantity":1,
"productId":"prod10015",
"returnedQuantity":0,
"externalId":null,
"originalCommerceItemId":null,
"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
},
"catalogId":null,
"lineAttributes":[
],
"catalogKey":null,
"productDisplayName":"Playstation 3",
"externalPriceDetails":null,
"siteId":"siteUS",
"id":"ci4000413"
}
],
"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":{
},
"locationId":"SiteUS-GlenAllen187",
"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",
"markers":[
],
"activeQuoteOrderId":null
}Default Response
The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s 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|
|28390|The following item(s) are no longer for sale [ItemName]. Order cannot be approved.|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code