handleOrderAmendment
post
/ccagent/v1/orderAmendments/{orderId}
Handle Order Amendment. Performs either of the operations initiateAmendment(initiates the order amendment process), checkAmendmentInProgress, priceOrderAmendmentcheck by passing op value. Additonally takes x-ccsite header to submit the edited order in a site. If the site information is not provided takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.
Request
Supported Media Types
- application/json
Path Parameters
- orderId
-
Type:
string
Required:true
The order id.
Header Parameters
- X-CCOrganization
-
Type:
string
The organization Id to which the order belongs- x-ccsite
Type:string
the site id in which the orders is placed
Body Parameter
Root Schema : handleOrderAmendment_request
{
"op":"initiateAmendment",
"continueWithInProgressEdit":false
}
- amountRemaining
-
Type:
string
Required:true
Amount to authorize. Related Endpoint Operations - preAuthorizeAmendOrder - billingAddress
-
Type:
object
billingAddressRequired:true
Additional Properties Allowed:Billing address for the order. Related Endpoint Operations - preAuthorizeAmendOrder - continueWithInProgressEdit
-
Type:
boolean
Boolean indicating whether to continue with the in progress edit. Related Endpoint Operations - initiateAmendment. - op
-
Type:
string
Required:true
The operation to be performed. Related Endpoint Operations - initiateAmendment, checkAmendmentInProgress, priceOrderAmendment, preAuthorizeAmendOrder - orderId
-
Type:
string
Required:true
Id of the Order. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder. - payments
-
Type:
object
paymentsRequired:true
Additional Properties Allowed:Payment in the cart. Related Endpoint Operations - preAuthorizeAmendOrder - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:shipping address for the order. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:Shipping method information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder - shoppingCart
-
Type:
object
shoppingCartAdditional Properties Allowed:Shopping cart information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
Nested Schema : billingAddress
Type:
object
Billing address for the order. Related Endpoint Operations - preAuthorizeAmendOrder
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country code for this billing address. - countryName
-
Type:
string
Country name for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - isDefaultAddress
-
Type:
boolean
Indicates if address is default or not. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - state
-
Type:
string
State code for this billing address. - stateName
-
Type:
string
State name for this billing address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : payments
Type:
object
Payment in the cart. Related Endpoint Operations - preAuthorizeAmendOrder
- amount
-
Type:
number
The amount associated with this Payment Group. If the order has a single payment group, then this field is optional. However in case we have more than one payment group, we need to provide this field. - cardCVV
-
Type:
string
Credit card CVV. - cardNumber
-
Type:
string
Credit card number. - cardType
-
Type:
string
Payment method. e.g. physicalGiftCard/creditCard. - customProperties
-
Type:
object
customPropertiesAdditional Properties Allowed:{ "description":"Dynamic Properties if any", "type":"string" }
Custom object with dynamic properties. This will be passed to the webhook request - endMonth
-
Type:
string
credit card expiry month. - endYear
-
Type:
integer
credit card expiry year. - giftCardNumber
-
Type:
string
Gift card number used for payment. Payment type: physicalGiftCard (this field should be used when giftcards are used) - giftCardPin
-
Type:
string
Gift card pin. Payment type: physicalGiftCard (this field should be used when giftcards are used) - nameOncard
-
Type:
string
name printed on credit card. - paymentGroupId
-
Type:
string
Payment Group Id of the gift card payment group. Payment type: physicalGiftCard - seqNum
-
Type:
string
Sequence Number of the payment. In multiple paymnets, there can be any number of payments. - type
-
Type:
string
Payment type
Nested Schema : shippingAddress
Type:
object
shipping address for the order. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country code for this shipping address. - countryName
-
Type:
string
Country name for this shipping address. - county
-
Type:
string
County for this shipping address. - DEFAULT_POSTAL_CODE_PATTERN
-
Type:
string
The default post code pattern of the shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - isDefaultAddress
-
Type:
string
States if address is defualt address or not. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
the selected state of the shipping address. - state
-
Type:
string
State code for this shipping address. - state_ISOCode
-
Type:
string
the state ISON code of the shipping address. - stateName
-
Type:
string
State name for this shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
- value
-
Type:
string
method type of shipment
Nested Schema : shoppingCart
Type:
object
Shopping cart information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
- items
-
Type:
array
itemsAdditional Properties Allowed:Items in the cart.
Nested Schema : customProperties
Type:
object
-
Type:
string
Dynamic Properties if any
Custom object with dynamic properties. This will be passed to the webhook request
- membershipId
-
Type:
string
memberShipId of customer. This property need to be sent if loyalty payment method is selected for payment - programId
-
Type:
string
Unique id for loyalty program.This property need to be sent if loyalty payment method is selected for payment
Nested Schema : items
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - backOrderableQuantity
-
Type:
number
Back Order Quantity of the Items. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Catalog Reference Id of commerce item. - childItems
-
Type:
array
childItemsAdditional Properties Allowed:Child items of the commerce item - commerceItemId
-
Type:
string
Unique id of the line item - configuratorId
-
Type:
string
Configuration id of the configurable product - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - discountAmount
-
Type:
number
Discount given on commerce item. - discountInfo
-
Type:
array
discountInfoAdditional Properties Allowed:Discount Information. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
number
The Price of the product as per the external pricing system. - externalPriceQuantity
-
Type:
integer
Quantity of the product, the customer is allowed to buy at the external price. - overriddenPrice
-
Type:
number
overridden price of commerce item. - preOrderableQuantity
-
Type:
number
Pre Order Quantity of the Items. - priceOverrideReason
-
Type:
string
Price override reason. - productId
-
Type:
string
Product Id of commerce item. - quantity
-
Type:
number
Quantity of the items. - rawTotalPrice
-
Type:
number
Raw total price of commerce item - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - stockStatus
-
Type:
boolean
Indicates if the product has stock or not.
Nested Schema : childItems
Nested Schema : discountInfo
Nested Schema : externalData
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Sku Id of the child item - childItems
-
Type:
array
childItemsAdditional Properties Allowed:Child items of the commerce item - currentPrice
-
Type:
number
Current price of the child item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - invalid
-
Type:
boolean
Invalid state of the child item - priceListGroupId
-
Type:
string
price list group id of the child item - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - selectedOptions
-
Type:
array
selectedOptionsAdditional Properties Allowed:Child Product Variant Information. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - stockStatus
-
Type:
boolean
Stock status Id of the child item
Nested Schema : childItems
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Sku Id of the child item - currentPrice
-
Type:
number
Current price of the child item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - invalid
-
Type:
boolean
Invalid state of the child item - priceListGroupId
-
Type:
string
price list group id of the child item - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - selectedOptions
-
Type:
array
selectedOptionsAdditional Properties Allowed:Child Product Variant Information. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - stockStatus
-
Type:
boolean
Stock status Id of the child item
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
object
- coupon
-
Type:
string
The couopn code. - promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : handleOrderAmendment_response
- cloneOrder
-
Type:
object
cloneOrderAdditional Properties Allowed:The clone order details. Related Endpoint Operations - initiateAmendment - discountInfo
-
Type:
object
discountInfoAdditional Properties Allowed:Discount information. Related Endpoint Operations - priceOrderAmendment - editInProgress
-
Type:
boolean
The original order id. Related Endpoint Operations - checkAmendmentInProgress - id
-
Type:
string
The order id. Related Endpoint Operations - preAuthorizeAmendOrder - isItemPriceOverrideAllowed
-
Type:
boolean
Indicetes if item price can be overridden or not. Related Endpoint Operations - initiateAmendment - orderableQuantityMap
-
Type:
array
orderableQuantityMapAdditional Properties Allowed:The list of all logged comments for the order. Related Endpoint Operations - initiateAmendment - orderId
-
Type:
string
The original order id. Related Endpoint Operations - checkAmendmentInProgress - originalOrderId
-
Type:
string
The original order id. Related Endpoint Operations - initiateAmendment - paymentGroups
-
Type:
array
paymentGroupsAdditional Properties Allowed:List of payment Groups for the order. Related Endpoint Operations - preAuthorizeAmendOrder - payments
-
Type:
object
paymentsAdditional Properties Allowed:Payment in the cart. Related Endpoint Operations - priceOrderAmendment - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:Price information of the order. Related Endpoint Operations - priceOrderAmendment - priceOverrideReasons
-
Type:
array
priceOverrideReasonsAdditional Properties Allowed:All price override reasons. These are sent only if isItemPriceOverrideAllowed is true. Related Endpoint Operations - initiateAmendment - shoppingCart
-
Type:
object
shoppingCartAdditional Properties Allowed:Shopping cart information. Related Endpoint Operations - priceOrderAmendment - state
-
Type:
integer
The order state. Related Endpoint operation - submitOrder. - stateDetailsAsUser
-
Type:
string
Order State description for this order. Related Endpoint operation - submitOrder. - stateString
-
Type:
string
Order state as key string. - taxPriceInfo
-
Type:
object
taxPriceInfoAdditional Properties Allowed:The tax pricing details for the order. Related Endpoint Operations - priceOrderAmendment
Nested Schema : cloneOrder
Type:
object
The clone order details. Related Endpoint Operations - initiateAmendment
- creationDate
-
Type:
string
Date on which the Order was created. - creationTime
-
Type:
number
Order creation time. - discountInfo
-
Type:
object
discountInfoAdditional Properties Allowed:Discount information. - id
-
Type:
string
Commerce id for this order. - orderComments
-
Type:
array
orderCommentsAdditional Properties Allowed:The list of all logged comments for the order. - paymentGroup
-
Type:
object
paymentGroupAdditional Properties Allowed:Payment Group for the order. - paymentGroups
-
Type:
array
paymentGroupsAdditional Properties Allowed:List of payment Groups for the order. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:Price information of the order. - priceListGroup
-
Type:
object
priceListGroupAdditional Properties Allowed:PriceList group of the order. - profile
-
Type:
object
profileAdditional Properties Allowed:Profile Information for the order. - profileId
-
Type:
string
The Repository Id of the profile to which this Order belongs to. - quoteInfo
-
Type:
object
quoteInfoAdditional Properties Allowed:the quote information of the order - returnRequests
-
Type:
array
returnRequestsAdditional Properties Allowed:The list of the requests raised for the order. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:shipping address for the order. - shippingGroups
-
Type:
array
shippingGroupsAdditional Properties Allowed:List of shipping groups - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:Shipping method information. - shoppingCart
-
Type:
object
shoppingCartAdditional Properties Allowed:Shopping cart information. - siteId
-
Type:
string
Site Id on which the order was placed. - state
-
Type:
integer
The order state. - stateDetailsAsUser
-
Type:
string
Order State description for this order. - submittedDate
-
Type:
string
Date on which the Order was submitted. - taxPriceInfo
-
Type:
object
taxPriceInfoAdditional Properties Allowed:The tax pricing details for the order. - totalAmountAuthorized
-
Type:
number
total amount authorized for the order.
Nested Schema : discountInfo
Type:
object
Discount information. Related Endpoint Operations - priceOrderAmendment
- claimedCouponMultiPromotions
-
Type:
object
claimedCouponMultiPromotionsAdditional Properties Allowed:The coupons that were claimed - orderCouponsMap
-
Type:
array
orderCouponsMapAdditional Properties Allowed:Map of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListAdditional Properties Allowed:List of discounts. - shippingDiscount
-
Type:
number
shipping discount - unclaimedCouponMultiPromotions
-
Type:
object
unclaimedCouponMultiPromotionsAdditional Properties Allowed:The coupons that were not claimed - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapAdditional Properties Allowed:Map of unclaimed coupons.
Nested Schema : orderableQuantityMap
Nested Schema : paymentGroups
Nested Schema : payments
Type:
object
Payment in the cart. Related Endpoint Operations - priceOrderAmendment
- amount
-
Type:
number
The raw number that represents the price. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - gatewayName
-
Type:
string
The payment gateway name. - IIN
-
Type:
string
The issuer identification number of the card intended to pay for order. - isAmountRemaining
-
Type:
boolean
Indicates if there is any balance unpaid amount remaining on the cart. - paymentGroupId
-
Type:
string
Id of this payment Group. - paymentMethod
-
Type:
string
The payment method name. - paymentState
-
Type:
string
The Payment Group state. - uiIntervention
-
Type:
number
This decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : priceInfo
Type:
object
Price information of the order. Related Endpoint Operations - priceOrderAmendment
- amount
-
Type:
number
The raw number that represents the price. - billing
-
Type:
number
The billing cost of the order. - currencyCode
-
Type:
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars. - shipping
-
Type:
number
Total shipping amount of the order. - shippingSurchargeValue
-
Type:
number
Total shipping surcharge amount of the order. - subTotal
-
Type:
number
The subtotal of the order before applying order-level promotions. - tax
-
Type:
number
The tax on the order. - total
-
Type:
number
The current working total, including all promotions, tax, and billing costs. - totalWithoutTax
-
Type:
number
Order total without tax.
Nested Schema : priceOverrideReasons
Nested Schema : shoppingCart
Type:
object
Shopping cart information. Related Endpoint Operations - priceOrderAmendment
- items
-
Type:
array
itemsAdditional Properties Allowed:Items in the cart.
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order. Related Endpoint Operations - priceOrderAmendment
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - cityTax
-
Type:
number
The monetary amount of city tax. - countryTax
-
Type:
number
The monetary amount of country tax. - countyTax
-
Type:
number
The monetary amount of county tax. - currencyCode
-
Type:
string
The three character currency code. - discounted
-
Type:
boolean
Whether the price was discounted. - districtTax
-
Type:
number
Tax amount for the district. - stateTax
-
Type:
number
Tax amount for the state.
Nested Schema : discountInfo
Type:
object
Discount information.
- claimedCouponMultiPromotions
-
Type:
object
claimedCouponMultiPromotionsAdditional Properties Allowed:The coupons that were claimed - orderCouponsMap
-
Type:
array
orderCouponsMapAdditional Properties Allowed:Map of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListAdditional Properties Allowed:List of discounts. - shippingDiscount
-
Type:
number
Shippinng discount - unclaimedCouponMultiPromotions
-
Type:
object
unclaimedCouponMultiPromotionsAdditional Properties Allowed:The coupons that were not claimed - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapAdditional Properties Allowed:Map of unclaimed coupons.
Nested Schema : orderComments
Nested Schema : paymentGroup
Type:
object
Payment Group for the order.
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - billingAddress
-
Type:
object
billingAddressAdditional Properties Allowed:Billing address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
Payment method. e.g. physicalGiftCard/ creditCard - firstName
-
Type:
string
First name associated with this Payment Group. - lastName
-
Type:
string
Last name associated with this Payment Group. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
string
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - token
-
Type:
string
The payment authorization token. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - type
-
Type:
string
Payment method type - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : paymentGroups
Nested Schema : priceInfo
Type:
object
Price information of the order.
- amount
-
Type:
number
The raw number that represents the price. - currencyCode
-
Type:
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars. - shipping
-
Type:
number
Total shipping amount of the order. - shippingSurchargeValue
-
Type:
number
Total shipping surcharge amount of the order. - subTotal
-
Type:
number
The subtotal of the order before applying order-level promotions. - tax
-
Type:
number
The tax on the order. - total
-
Type:
number
The current working total, including all promotions, tax, and billing costs. - totalWithoutTax
-
Type:
number
Order total without tax.
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
- active
-
Type:
boolean
Active status of pricelist group. - currency
-
Type:
object
currencyAdditional Properties Allowed:Currency of the PriceList group. - deleted
-
Type:
boolean
Pricelist group deleted status. - displayName
-
Type:
string
Display Name. - id
-
Type:
string
Id. - locale
-
Type:
string
Locale. - repositoryId
-
Type:
string
Repository Id.
Nested Schema : profile
Type:
object
Profile Information for the order.
-
Type:
string
Email id of profile. - firstName
-
Type:
string
First name of profile. - lastName
-
Type:
string
Last name of profile. - middleName
-
Type:
string
Middle name of profile.
Nested Schema : quoteInfo
Type:
object
the quote information of the order
- errorInfo
-
Type:
array
errorInfoAdditional Properties Allowed:the array of errors, if any - expirationDate
-
Type:
string
the expiration date of the quoted order, if any - externalId
-
Type:
string
the external id for the quote - notes
-
Type:
array
notesAdditional Properties Allowed:the notes (history) for the order - providerNote
-
Type:
string
the provider note for the quoted order - quoteDate
-
Type:
number
the date the order was quoted in milliseconds - rejectionDate
-
Type:
string
rejection date of the quoted order - rejectionNote
-
Type:
string
the rejection note for an order whose quote has been rejected by user - requestDate
-
Type:
string
the date when the quote was requested in ISO format
Nested Schema : returnRequests
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country code for this shipping address. - countryName
-
Type:
string
Country name for this shipping address. - county
-
Type:
string
County for this shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - state
-
Type:
string
State code for this shipping address. - stateName
-
Type:
string
State name for this shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingGroups
Nested Schema : shippingMethod
Type:
object
Shipping method information.
- cost
-
Type:
number
shipping cost. - displayName
-
Type:
string
Display Name of shipment. - value
-
Type:
string
method type of shipment
Nested Schema : shoppingCart
Type:
object
Shopping cart information.
- items
-
Type:
array
itemsAdditional Properties Allowed:Items in the cart.
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
- amount
-
Type:
number
The monetary amount. - cityTax
-
Type:
number
The monetary amount of city tax. - countryTax
-
Type:
number
The monetary amount of country tax. - countyTax
-
Type:
number
The monetary amount of county tax. - districtTax
-
Type:
number
Tax amount for the district. - isTaxIncluded
-
Type:
boolean
Indicates if tax is included in price. - miscTax
-
Type:
number
Miscellaneous Tax amount. - stateTax
-
Type:
number
Tax amount for the state. - valueAddedTax
-
Type:
number
Value Added Tax amount.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed
- coupon code
-
Type:
array
coupon codeAdditional Properties Allowed:Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
- coupon code
-
Type:
array
coupon codeAdditional Properties Allowed:Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Nested Schema : coupon code
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level - totalAdjustment
-
Type:
number
Adjustment done by the promotion
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion - promotionId
-
Type:
string
Id of the promotion - promotionLevel
-
Type:
string
Level of the promotion - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion - promotionId
-
Type:
string
Id of the promotion - promotionLevel
-
Type:
string
Level of the promotion - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion
Nested Schema : coupon code
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level
Nested Schema : items
Type:
object
- couonInfo
-
Type:
array
couonInfoAdditional Properties Allowed:The couopn Info - promotionValue
-
Type:
string
The value for promotion
Nested Schema : couonInfo
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion - promotionId
-
Type:
string
Id of the promotion - promotionLevel
-
Type:
string
Level of the promotion - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion
Nested Schema : items
Type:
object
- comment
-
Type:
string
The comment string. - creationDate
-
Type:
string
Date on which the comment was created. - repositoryId
-
Type:
string
The repository id of the comment record.
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country code for this billing address. - countryName
-
Type:
string
Country name for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - state
-
Type:
string
State code for this billing address. - stateName
-
Type:
string
State name for this billing address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : items
Type:
object
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - billingAddress
-
Type:
object
billingAddressAdditional Properties Allowed:Billing address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
Payment method. e.g. physicalGiftCard/ creditCard - firstName
-
Type:
string
First name associated with this Payment Group. - lastName
-
Type:
string
Last name associated with this Payment Group. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
string
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - token
-
Type:
string
Token associated with this Payment Group. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - type
-
Type:
string
Payment method type - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country code for this billing address. - countryName
-
Type:
string
Country name for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - state
-
Type:
string
State code for this billing address. - stateName
-
Type:
string
State name for this billing address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : currency
Type:
object
Currency of the PriceList group.
- currencyCode
-
Type:
string
Currency Code. - displayName
-
Type:
string
Display Name. - fractionalDigits
-
Type:
integer
Fractional Digits. - numericCode
-
Type:
string
Numeric Code. - repositoryId
-
Type:
string
Repository Id. - symbol
-
Type:
string
currency Symbol.
Nested Schema : errorInfo
Nested Schema : notes
Nested Schema : items
Type:
object
- profileId
-
Type:
string
the profile id of the user - profileType
-
Type:
string
the profile type of the user that requested the quote - requestDate/quoteDate/rejectionDate
-
Type:
number
the request/quote/rejection date for the note - requesterNote/providerNote/rejectionNote
-
Type:
string
the requester/provider/rejection note
Nested Schema : items
Type:
object
- createdDate
-
Type:
string
The creation date of the return request. - returnRequestId
-
Type:
string
The return request id. - state
-
Type:
string
The status of the return request. - totalRefund
-
Type:
number
The total amount to be refunded on return. - totalReturnQuantity
-
Type:
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
object
- shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:shipping address for the order. - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:Shipping method information. - trackingInfo
-
Type:
array
trackingInfoAdditional Properties Allowed:Tracking Information for the Order - trackingNumber
-
Type:
string
Shipping tracking number
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country code for this shipping address. - countryName
-
Type:
string
Country name for this shipping address. - county
-
Type:
string
County for this shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - state
-
Type:
string
State code for this shipping address. - stateName
-
Type:
string
State name for this shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
- cost
-
Type:
number
shipping cost. - displayName
-
Type:
string
Display Name of shipment. - value
-
Type:
string
method type of shipment
Nested Schema : trackingInfo
Nested Schema : items
Type:
object
- carrierId
-
Type:
string
Carrier Id for Tracking - carrierName
-
Type:
string
Carrier Name for Tracking - carrierUrl
-
Type:
string
Carrier URL for Tracking - trackingNumber
-
Type:
string
Tracking Number
Nested Schema : items
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Catalog Reference Id of commerce item. - childItems
-
Type:
array
childItemsAdditional Properties Allowed:Child items of the commerce item - commerceItemId
-
Type:
string
Commerce Id of the returned item - configuratorId
-
Type:
string
configurator id of the configurable product - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - discountAmount
-
Type:
number
Total discount applied to commerce item. - discountInfo
-
Type:
array
discountInfoAdditional Properties Allowed:discount information of the product - displayName
-
Type:
string
Display name of commerce item. - dynamicProperties
-
Type:
array
dynamicPropertiesAdditional Properties Allowed:Array of custom properties at order line item level. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
number
The Price of the product as per the external pricing system. - externalPriceQuantity
-
Type:
integer
Quantity of the product, the customer is allowed to buy at the external price. - imageInfo
-
Type:
object
imageInfoAdditional Properties Allowed:Image information - isPriceOverridden
-
Type:
boolean
Indicates if commerce item price is overridden or not. - listPrice
-
Type:
number
list price of commerce item - onSale
-
Type:
boolean
indicates if product is on sale or not. - overriddenPrice
-
Type:
number
overridden price of commerce item. - price
-
Type:
number
The raw number that represents the price. - priceOverridenBy
-
Type:
string
Name of the agent who has overridden item price. - priceOverrideReason
-
Type:
object
priceOverrideReasonAdditional Properties Allowed:Price override reason map - productId
-
Type:
string
Product Id of commerce item. - quantity
-
Type:
number
Quantity of the items. - rawTotalPrice
-
Type:
number
Raw total price of commerceItem - returnedQuantity
-
Type:
number
Returned Quantity - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - shippingSurchargeValue
-
Type:
number
Shipping surcharge amount for commerce item. - stateDetailsAsUser
-
Type:
string
State description of the commerce item. - status
-
Type:
string
State of the commerce item. - subTotal
-
Type:
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice. - tax
-
Type:
number
The amount of tax paid for this item. - unitPrice
-
Type:
number
Sale price or list price of commerceItem. - variant
-
Type:
array
variantAdditional Properties Allowed:Sku option information
Nested Schema : childItems
Nested Schema : discountInfo
Nested Schema : dynamicProperties
Nested Schema : externalData
Nested Schema : imageInfo
Nested Schema : priceOverrideReason
Type:
object
Price override reason map
- displayValue
-
Type:
string
price override reason value - key
-
Type:
string
price override reason key
Nested Schema : variant
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Sku Id of the child item - childItems
-
Type:
array
childItemsAdditional Properties Allowed:Child items of the commerce item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Image route - selectedOptions
-
Type:
array
selectedOptionsAdditional Properties Allowed:The array of variants of the child item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : childItems
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Sku Id of the child item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Image route - selectedOptions
-
Type:
array
selectedOptionsAdditional Properties Allowed:The array of variants of the child item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
The varian option name. - optionValue
-
Type:
string
The variant option value
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
The varian option name. - optionValue
-
Type:
string
The variant option value
Nested Schema : items
Type:
object
- coupon
-
Type:
string
Coupon code. - promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion.
Nested Schema : items
Type:
object
- id
-
Type:
string
The ID of the dynamic property. - label
-
Type:
string
The label of the dynamic property. - value
-
Type:
string
The value of the dynamic property.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
The SKU option name. - optionValue
-
Type:
string
The SKU option value.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed
- coupon code
-
Type:
array
coupon codeAdditional Properties Allowed:Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
- coupon code
-
Type:
array
coupon codeAdditional Properties Allowed:Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Nested Schema : coupon code
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level - totalAdjustment
-
Type:
number
Adjustment done by the promotion
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion - promotionId
-
Type:
string
Id of the promotion - promotionLevel
-
Type:
string
Level of the promotion - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion - promotionId
-
Type:
string
Id of the promotion - promotionLevel
-
Type:
string
Level of the promotion - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion
Nested Schema : coupon code
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level
Nested Schema : items
Type:
object
- couonInfo
-
Type:
array
couonInfoAdditional Properties Allowed:The couopn Info - value
-
Type:
string
The value for promotion
Nested Schema : couonInfo
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion - promotionId
-
Type:
string
Id of the promotion - promotionLevel
-
Type:
string
Level of the promotion - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion
Nested Schema : items
Type:
object
- productId:skuId
-
Type:
number
Maximum orderable quantity for the commerce item
Nested Schema : items
Type:
object
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - billingAddress
-
Type:
object
billingAddressAdditional Properties Allowed:Billing address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
Payment method. e.g. physicalGiftCard/ creditCard - firstName
-
Type:
string
First name associated with this Payment Group. - lastName
-
Type:
string
Last name associated with this Payment Group. - originalPaymentGroupId
-
Type:
string
Payment group id of the original order. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
string
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - seqNum
-
Type:
string
Sequence Number of the payment. In multiple paymnets, there can be any number of payments. - token
-
Type:
string
Token associated with this Payment Group. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - type
-
Type:
string
Payment method type - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country code for this billing address. - countryName
-
Type:
string
Country name for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - state
-
Type:
string
State code for this billing address. - stateName
-
Type:
string
State name for this billing address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : items
Type:
object
- displayValue
-
Type:
string
price override reason value - key
-
Type:
string
price override reason key
Nested Schema : items
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - availabilityDate
-
Type:
string
The Availability date of commerce Item. - backOrderQuantity
-
Type:
number
Back Order Quantity of the Items. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Catalog Reference Id of commerce item. - childItems
-
Type:
array
childItemsAdditional Properties Allowed:Child items of the commerce item - commerceItemId
-
Type:
string
Unique id of the line item - configuratorId
-
Type:
string
Configuration id of the configurable product - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of commerce item. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
number
The Price of the product as per the external pricing system. - externalPriceQuantity
-
Type:
integer
Quantity of the product, the customer is allowed to buy at the external price. - imageInfo
-
Type:
object
imageInfoAdditional Properties Allowed:The image information. - listPrice
-
Type:
number
list price of commerce item. - onSale
-
Type:
boolean
Indicates if product is on sale or not. - preOrderQuantity
-
Type:
number
Pre Order Quantity of the Items. - price
-
Type:
number
The raw number that represents the price. - productId
-
Type:
string
Product Id of commerce item. - quantity
-
Type:
number
Quantity of the items. - rawTotalPrice
-
Type:
number
Raw total price of commerce item - returnedQuantity
-
Type:
number
Returned quantity - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - shippingSurchargeValue
-
Type:
number
Shipping surcharge amount for commerce item. - stateDetailsAsUser
-
Type:
string
State description of the commerce item. - status
-
Type:
integer
State of the commerce item. - tax
-
Type:
number
The amount of tax paid for this item. - unitPrice
-
Type:
number
Sale price or list price of commerceItem. - variant
-
Type:
array
variantAdditional Properties Allowed:Sku Information
Nested Schema : childItems
Nested Schema : externalData
Nested Schema : imageInfo
Type:
object
The image information.
- primaryThumbImageURL
-
Type:
string
The primary thumb URL
Nested Schema : variant
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Sku Id of the child item - childItems
-
Type:
array
childItemsAdditional Properties Allowed:Child items of the commerce item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Product path - selectedOptions
-
Type:
array
selectedOptionsAdditional Properties Allowed:Child Product Variant Information. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : childItems
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Sku Id of the child item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Product path - selectedOptions
-
Type:
array
selectedOptionsAdditional Properties Allowed:Child Product Variant Information. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
The SKU option name. - optionValue
-
Type:
string
The SKU option value.
Example application/json
{
"originalOrderId":"o160415",
"orderableQuantityMap":{
"camcorder_1:camcordersku_1_3":5
},
"priceOverrideReasons":[
{
"displayValue":"Agent Price Override",
"key":"agentPriceOverride"
},
{
"displayValue":"Appeasement",
"key":"appeasement"
}
],
"isItemPriceOverrideAllowed":true,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/orderAmendments/o160415"
}
],
"cloneOrder":{
"totalAmountAuthorized":542.8,
"orderComments":[
],
"creationTime":1.465930276E12,
"dynamicProperties":[
],
"paymentGroups":[
{
"lastName":"test",
"amountAuthorized":542.8,
"amount":542.8,
"totalDue":542.8,
"cardType":null,
"type":"card",
"token":"9997000108950573",
"paymentGroupId":"pg160420",
"firstName":"Test",
"paymentStateDetailsAsUser":"The authorization succeeded",
"uiIntervention":"sop",
"billingAddress":{
"lastName":"test",
"country":"US",
"address3":null,
"address2":null,
"city":"tt",
"address1":"t",
"prefix":null,
"companyName":null,
"postalCode":"13202",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"Test",
"phoneNumber":"222-333-1111",
"stateName":"New York",
"faxNumber":null,
"middleName":null,
"countryName":"United States",
"state":"NY",
"email":"test@example.com"
},
"paymentState":1,
"paidAmount":0,
"cardNumber":"xxxxxxxxxxxx1111",
"refundAmount":0
}
],
"submittedDate":"2016-06-14T19:06:37.000Z",
"priceInfo":{
"amount":467.6,
"total":542.8,
"shipping":35,
"shippingSurchargeValue":0,
"tax":40.2,
"subTotal":597,
"currencyCode":"USD",
"totalWithoutTax":502.6
},
"paymentGroup":{
"lastName":"test",
"amountAuthorized":542.8,
"amount":542.8,
"totalDue":542.8,
"cardType":null,
"type":"card",
"token":"9997000108950573",
"paymentGroupId":"pg160420",
"firstName":"Test",
"paymentStateDetailsAsUser":"The authorization succeeded",
"uiIntervention":"sop",
"billingAddress":{
"lastName":"test",
"country":"US",
"address3":null,
"address2":null,
"city":"tt",
"address1":"t",
"prefix":null,
"companyName":null,
"postalCode":"13202",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"Test",
"phoneNumber":"222-333-1111",
"stateName":"New York",
"faxNumber":null,
"middleName":null,
"countryName":"United States",
"state":"NY",
"email":"test@example.com"
},
"paymentState":1,
"paidAmount":0,
"cardNumber":"xxxxxxxxxxxx1111",
"refundAmount":0
},
"shoppingCart":{
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":699.99,
"returnedQuantity":0,
"priceOverridenBy":"",
"dynamicProperties":[
{
"id":"ReferralCode",
"label":"ReferralCode",
"value":null
},
{
"id":"OfferEndsDate",
"label":"OfferEndsDate",
"value":"2020-07-02T03:42:42.962Z"
},
{
"id":"Discount",
"label":"Discount",
"value":10
},
{
"id":"GiftWrapping",
"label":"Gift Wrapping",
"value":false
},
{
"id":"name",
"label":"Name on product(Mug)",
"value":"My name"
}
],
"displayName":"Samsung - F90BN HD Flash Memory Camcorder",
"shippingSurchargeValue":0,
"externalData":[
],
"discountAmount":0,
"billingAccountId":"billingAcc-123",
"imageInfo":{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/Samsung_F90BN_LARGE.jpg&height=100&width=100"
},
"childItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod40001",
"displayName":"Intel Pentium Dual Core",
"externalData":[
],
"billingAccountId":"billingAcc-123",
"catRefId":"sku40001",
"route":"/intel-pentium-dual-core/product/prod40001",
"customerAccountId":"customerAcc-123",
"assetId":"asset10001",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123"
},
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod40007",
"displayName":"8 GB Kingston Sodimm DDR3 1600MHz",
"externalData":[
],
"billingAccountId":"billingAcc-123",
"childItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod40009",
"displayName":"Intel Pentium i9 Core",
"externalData":[
],
"billingAccountId":"billingAcc-123",
"catRefId":"sku40009",
"route":"/intel-pentium-dual-core/product/prod40001",
"customerAccountId":"customerAcc-123",
"assetId":"asset10001",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123"
}
],
"catRefId":"sku40007",
"route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007",
"customerAccountId":"customerAcc-123",
"assetId":"asset10001",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123"
}
],
"configuratorId":"36379716",
"overriddenPrice":"",
"commerceItemId":"ci1000785",
"assetId":"asset10001",
"price":597,
"isPriceOverridden":false,
"variant":[
{
"optionValue":"Neon",
"optionName":"color"
},
{
"optionValue":"2x optical/130x digital",
"optionName":"zoom"
}
],
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"Added to order",
"serviceAccountId":"serviceAcc-123",
"unitPrice":597,
"quantity":1,
"productId":"camcorder_1",
"salePrice":597,
"tax":37.4,
"catRefId":"camcordersku_1_3",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"activationDate":"2017-06-27T15:30:00Z",
"listPrice":699.99,
"status":0,
"priceOverrideReason":{
}
}
]
},
"state":10,
"id":"o160416",
"quoteInfo":{
"providerNote":null,
"notes":[
{
"providerDate":"2016-11-25T13:33:48.000Z",
"providerNote":"The quote is approved as per the request",
"profileType":null,
"profileId":"se-570031"
},
{
"profileType":null,
"profileId":"se-570031",
"requestDate":"2016-10-25T13:33:48.000Z",
"requesterNote":"provide 10 percent off on the total quantity"
}
],
"rejectionDate":null,
"requestDate":"2016-10-25T13:33:48.000Z",
"errorInfo":null,
"externalID":null,
"rejectionNote":null,
"quoteDate":"2016-10-25T13:35:32.000Z",
"expirationDate":"2026-04-28T18:53:48.000Z"
},
"stateDetailsAsUser":"Order being amended",
"taxPriceInfo":{
"cityTax":0,
"amount":40.2,
"valueAddedTax":0,
"countyTax":20.099999999999998,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":20.099999999999998,
"countryTax":0
},
"shippingGroups":[
{
"trackingInfo":[
],
"shippingMethod":{
"shippingTax":2.8,
"cost":35,
"displayName":"Standard",
"value":"standardShippingMethod"
},
"shippingAddress":{
"lastName":"test",
"country":"US",
"address3":null,
"address2":"t",
"city":"tt",
"address1":"t",
"prefix":null,
"companyName":null,
"postalCode":"13202",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"Test",
"phoneNumber":"222-333-1111",
"stateName":"New York",
"faxNumber":null,
"middleName":null,
"countryName":"United States",
"state":"NY",
"email":"test@example.com"
},
"trackingNumber":null
}
],
"shippingMethod":{
"shippingTax":2.8,
"cost":35,
"displayName":"Standard",
"value":"standardShippingMethod"
},
"profile":{
"lastName":"test",
"firstName":"Test",
"middleName":null,
"email":"test@example.com"
},
"priceListGroup":{
"deleted":false,
"displayName":"Default Price Group",
"listPriceList":{
"repositoryId":"listPrices"
},
"repositoryId":"defaultPriceGroup",
"active":true,
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"defaultPriceGroup",
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
}
},
"returnRequests":[
],
"creationDate":"2016-06-14T18:51:16.000Z",
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
"Coupon2":{
"promotionLevel":"order",
"totalAdjustment":"-119.4",
"promotionDesc":"SPEND200FOR20PercentOFF",
"promotionId":"promo30007"
}
},
"orderDiscount":129.39999999999998,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"claimedCouponMultiPromotions":{
"Coupon2":[
{
"promotionLevel":"order",
"totalAdjustment":"-119.4",
"promotionDesc":"SPEND200FOR20PercentOFF",
"promotionId":"promo30007"
},
{
"promotionLevel":"order",
"totalAdjustment":"-10.0",
"promotionDesc":"Order_Discount_M2M",
"promotionId":"promo30008"
}
]
},
"unclaimedCouponsMap":{
}
},
"orderCancelReason":null,
"profileId":"120026",
"exchangeRequests":[
],
"siteId":"siteUS",
"shippingAddress":{
"lastName":"test",
"country":"US",
"address3":null,
"address2":"t",
"city":"tt",
"address1":"t",
"prefix":null,
"companyName":null,
"postalCode":"13202",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"Test",
"phoneNumber":"222-333-1111",
"stateName":"New York",
"faxNumber":null,
"middleName":null,
"countryName":"United States",
"state":"NY",
"email":"test@example.com"
}
}
}
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|
|------------------|------------------|
|200109|No edit in progress|
|200106|Order data passed is null|
|200105|Order id passed is null or empty|
|200108|Edit in progress by another agent|
|200107|Internal error occurred|
|200110|Internal error occurred|
|30020|The Site to which the order belongs was deleted|
|30021|The Site to which the order belongs is currently inactive|
|100094|Organization passed in the header is currently inactive|
|20101|Invalid shipping details|
|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|
|28107|Order not found|
|200116|Internal error occurred|
|200119|Internal error occurred|
|20107|Specified order does not exist|
|200112|Internal error occurred|
|200115|Internal error occurred|
|200120|Edit not initiated for the order|
|30015|SiteId passed in x-ccsite header is currently inactive|
|200100|Internal error occurred|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|100101|The shopper profile does not belong to organization passed in the header|
|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|
Body
Root Schema : errorModel
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - errors
-
Type:
array
errorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code - type
-
Type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code
Examples
Sample Request:
{ "op": "initiateAmendment", "continueWithInProgressEdit": false }
Sample Response Payload returned by endpoint:
{ "originalOrderId": "o160415", "orderableQuantityMap": {"camcorder_1:camcordersku_1_3": 5}, "priceOverrideReasons": [ { "displayValue": "Agent Price Override", "key": "agentPriceOverride" }, { "displayValue": "Appeasement", "key": "appeasement" } ], "isItemPriceOverrideAllowed": true, "links": [{ "rel": "self", "href": "http://localhost:9080/ccagentui/v1/orderAmendments/o160415" }], "cloneOrder": { "totalAmountAuthorized": 542.8, "orderComments": [], "creationTime": 1465930276000, "dynamicProperties": [], "paymentGroups": [{ "lastName": "test", "amountAuthorized": 542.8, "amount": 542.8, "totalDue": 542.8, "cardType": null, "type": "card", "token": "9997000108950573", "paymentGroupId": "pg160420", "firstName": "Test", "paymentStateDetailsAsUser": "The authorization succeeded", "uiIntervention": "sop", "billingAddress": { "lastName": "test", "country": "US", "address3": null, "address2": null, "city": "tt", "address1": "t", "prefix": null, "companyName": null, "postalCode": "13202", "jobTitle": null, "county": null, "suffix": null, "firstName": "Test", "phoneNumber": "222-333-1111", "stateName": "New York", "faxNumber": null, "middleName": null, "countryName": "United States", "state": "NY", "email": "test@example.com" }, "paymentState": 1, "paidAmount": 0, "cardNumber": "xxxxxxxxxxxx1111", "refundAmount": 0 }], "submittedDate": "2016-06-14T19:06:37.000Z", "priceInfo": { "amount": 467.6, "total": 542.8, "shipping": 35, "shippingSurchargeValue": 0, "tax": 40.2, "subTotal": 597, "currencyCode": "USD", "totalWithoutTax": 502.6 }, "paymentGroup": { "lastName": "test", "amountAuthorized": 542.8, "amount": 542.8, "totalDue": 542.8, "cardType": null, "type": "card", "token": "9997000108950573", "paymentGroupId": "pg160420", "firstName": "Test", "paymentStateDetailsAsUser": "The authorization succeeded", "uiIntervention": "sop", "billingAddress": { "lastName": "test", "country": "US", "address3": null, "address2": null, "city": "tt", "address1": "t", "prefix": null, "companyName": null, "postalCode": "13202", "jobTitle": null, "county": null, "suffix": null, "firstName": "Test", "phoneNumber": "222-333-1111", "stateName": "New York", "faxNumber": null, "middleName": null, "countryName": "United States", "state": "NY", "email": "test@example.com" }, "paymentState": 1, "paidAmount": 0, "cardNumber": "xxxxxxxxxxxx1111", "refundAmount": 0 }, "shoppingCart": {"items": [{ "deactivationDate": "2018-06-27T12:59:59Z", "rawTotalPrice": 699.99, "returnedQuantity": 0, "priceOverridenBy": "", "dynamicProperties": [ { "id": "ReferralCode", "label": "ReferralCode", "value": null }, { "id": "OfferEndsDate", "label": "OfferEndsDate", "value": "2020-07-02T03:42:42.962Z" }, { "id": "Discount", "label": "Discount", "value": 10 }, { "id": "GiftWrapping", "label": "Gift Wrapping", "value": false }, { "id": "name", "label": "Name on product(Mug)", "value": "My name" } ], "displayName": "Samsung - F90BN HD Flash Memory Camcorder", "shippingSurchargeValue": 0, "externalData": [], "discountAmount": 0, "billingAccountId": "billingAcc-123", "imageInfo": {"primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v2/products/Samsung_F90BN_LARGE.jpg&height=100&width=100"}, "childItems": [ { "serviceAccountId": "serviceAcc-123", "deactivationDate": "2018-06-27T12:59:59Z", "quantity": 1, "productId": "prod40001", "displayName": "Intel Pentium Dual Core", "externalData": [], "billingAccountId": "billingAcc-123", "catRefId": "sku40001", "route": "/intel-pentium-dual-core/product/prod40001", "customerAccountId": "customerAcc-123", "assetId": "asset10001", "selectedOptions": [], "actionCode": "Add", "activationDate": "2017-06-27T15:30:00Z", "serviceId": "service-123" }, { "serviceAccountId": "serviceAcc-123", "deactivationDate": "2018-06-27T12:59:59Z", "quantity": 1, "productId": "prod40007", "displayName": "8 GB Kingston Sodimm DDR3 1600MHz", "externalData": [], "billingAccountId": "billingAcc-123", "childItems": [{ "serviceAccountId": "serviceAcc-123", "deactivationDate": "2018-06-27T12:59:59Z", "quantity": 1, "productId": "prod40009", "displayName": "Intel Pentium i9 Core", "externalData": [], "billingAccountId": "billingAcc-123", "catRefId": "sku40009", "route": "/intel-pentium-dual-core/product/prod40001", "customerAccountId": "customerAcc-123", "assetId": "asset10001", "selectedOptions": [], "actionCode": "Add", "activationDate": "2017-06-27T15:30:00Z", "serviceId": "service-123" }], "catRefId": "sku40007", "route": "/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007", "customerAccountId": "customerAcc-123", "assetId": "asset10001", "selectedOptions": [], "actionCode": "Add", "activationDate": "2017-06-27T15:30:00Z", "serviceId": "service-123" } ], "configuratorId": "36379716", "overriddenPrice": "", "commerceItemId": "ci1000785", "assetId": "asset10001", "price": 597, "isPriceOverridden": false, "variant": [ { "optionValue": "Neon", "optionName": "color" }, { "optionValue": "2x optical/130x digital", "optionName": "zoom" } ], "actionCode": "Add", "serviceId": "service-123", "stateDetailsAsUser": "Added to order", "serviceAccountId": "serviceAcc-123", "unitPrice": 597, "quantity": 1, "productId": "camcorder_1", "salePrice": 597, "tax": 37.4, "catRefId": "camcordersku_1_3", "customerAccountId": "customerAcc-123", "discountInfo": [], "activationDate": "2017-06-27T15:30:00Z", "listPrice": 699.99, "status": 0, "priceOverrideReason": {} }]}, "state": 10, "id": "o160416", "quoteInfo": { "providerNote": null, "notes": [ { "providerDate": "2016-11-25T13:33:48.000Z", "providerNote": "The quote is approved as per the request", "profileType": null, "profileId": "se-570031" }, { "profileType": null, "profileId": "se-570031", "requestDate": "2016-10-25T13:33:48.000Z", "requesterNote": "provide 10 percent off on the total quantity" } ], "rejectionDate": null, "requestDate": "2016-10-25T13:33:48.000Z", "errorInfo": null, "externalID": null, "rejectionNote": null, "quoteDate": "2016-10-25T13:35:32.000Z", "expirationDate": "2026-04-28T18:53:48.000Z" }, "stateDetailsAsUser": "Order being amended", "taxPriceInfo": { "cityTax": 0, "amount": 40.2, "valueAddedTax": 0, "countyTax": 20.099999999999998, "isTaxIncluded": false, "miscTax": 0, "districtTax": 0, "stateTax": 20.099999999999998, "countryTax": 0 }, "shippingGroups": [{ "trackingInfo": [], "shippingMethod": { "shippingTax": 2.8, "cost": 35, "displayName": "Standard", "value": "standardShippingMethod" }, "shippingAddress": { "lastName": "test", "country": "US", "address3": null, "address2": "t", "city": "tt", "address1": "t", "prefix": null, "companyName": null, "postalCode": "13202", "jobTitle": null, "county": null, "suffix": null, "firstName": "Test", "phoneNumber": "222-333-1111", "stateName": "New York", "faxNumber": null, "middleName": null, "countryName": "United States", "state": "NY", "email": "test@example.com" }, "trackingNumber": null }], "shippingMethod": { "shippingTax": 2.8, "cost": 35, "displayName": "Standard", "value": "standardShippingMethod" }, "profile": { "lastName": "test", "firstName": "Test", "middleName": null, "email": "test@example.com" }, "priceListGroup": { "deleted": false, "displayName": "Default Price Group", "listPriceList": {"repositoryId": "listPrices"}, "repositoryId": "defaultPriceGroup", "active": true, "salePriceList": {"repositoryId": "salePrices"}, "currency": { "symbol": "$", "displayName": "US Dollar", "repositoryId": "en_US", "fractionalDigits": 2, "currencyCode": "USD", "numericCode": "840" }, "id": "defaultPriceGroup", "locale": "en_US", "shippingSurchargePriceList": {"repositoryId": "shippingSurchargePrices"} }, "returnRequests": [], "creationDate": "2016-06-14T18:51:16.000Z", "discountInfo": { "unclaimedCouponMultiPromotions": {}, "orderCouponsMap": {"Coupon2": { "promotionLevel": "order", "totalAdjustment": "-119.4", "promotionDesc": "SPEND200FOR20PercentOFF", "promotionId": "promo30007" }}, "orderDiscount": 129.39999999999998, "shippingDiscount": 0, "orderImplicitDiscountList": [], "claimedCouponMultiPromotions": {"Coupon2": [ { "promotionLevel": "order", "totalAdjustment": "-119.4", "promotionDesc": "SPEND200FOR20PercentOFF", "promotionId": "promo30007" }, { "promotionLevel": "order", "totalAdjustment": "-10.0", "promotionDesc": "Order_Discount_M2M", "promotionId": "promo30008" } ]}, "unclaimedCouponsMap": {} }, "orderCancelReason": null, "profileId": "120026", "exchangeRequests": [], "siteId": "siteUS", "shippingAddress": { "lastName": "test", "country": "US", "address3": null, "address2": "t", "city": "tt", "address1": "t", "prefix": null, "companyName": null, "postalCode": "13202", "jobTitle": null, "county": null, "suffix": null, "firstName": "Test", "phoneNumber": "222-333-1111", "stateName": "New York", "faxNumber": null, "middleName": null, "countryName": "United States", "state": "NY", "email": "test@example.com" } } }