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: string
The order id.
Header Parameters
-
X-CCOrganization(optional): string
The organization Id to which the order belongs
-
x-ccsite(optional): string
the site id in which the orders is placed
Root Schema : handleOrderAmendment_request
Type:
Show Source
object
-
amountRemaining:
string
Amount to authorize. Related Endpoint Operations - preAuthorizeAmendOrder
-
billingAddress:
object billingAddress
Billing address for the order. Related Endpoint Operations - preAuthorizeAmendOrder
-
continueWithInProgressEdit(optional):
boolean
Boolean indicating whether to continue with the in progress edit. Related Endpoint Operations - initiateAmendment.
-
op:
string
The operation to be performed. Related Endpoint Operations - initiateAmendment, checkAmendmentInProgress, priceOrderAmendment, preAuthorizeAmendOrder
-
orderId:
string
Id of the Order. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder.
-
payments:
object payments
Payment in the cart. Related Endpoint Operations - preAuthorizeAmendOrder
-
shippingAddress(optional):
object shippingAddress
shipping address for the order. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
-
shippingGroups(optional):
array shippingGroups
List of shipping groups
-
shippingMethod(optional):
object shippingMethod
Shipping method information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
-
shoppingCart(optional):
object shoppingCart
Shopping cart information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
Example:
{
"op":"initiateAmendment",
"continueWithInProgressEdit":false
}
Nested Schema : billingAddress
Type:
object
Billing address for the order. Related Endpoint Operations - preAuthorizeAmendOrder
Show Source
-
address1(optional):
string
Address line 1 for this billing address.
-
address2(optional):
string
Address line 2 for this billing address.
-
address3(optional):
string
Address line 3 for this billing address.
-
city(optional):
string
City for this billing address.
-
companyName(optional):
string
Company name for this billing address.
-
country(optional):
string
Country code for this billing address.
-
countryName(optional):
string
Country name for this billing address.
-
county(optional):
string
County for this billing address.
-
email(optional):
string
Email for this billing address.
-
faxNumber(optional):
string
Fax number for this billing address.
-
firstName(optional):
string
First name for this billing address.
-
isDefaultAddress(optional):
boolean
Indicates if address is default or not.
-
jobTitle(optional):
string
Job title for this billing address.
-
lastName(optional):
string
Last name for this billing address.
-
middleName(optional):
string
Middle name for this billing address.
-
phoneNumber(optional):
string
Phone number for this billing address.
-
postalCode(optional):
string
Postal code for this billing address.
-
prefix(optional):
string
Prefix for this billing address.
-
state(optional):
string
State code for this billing address.
-
stateName(optional):
string
State name for this billing address.
-
suffix(optional):
string
Suffix for this billing address.
Nested Schema : payments
Type:
object
Payment in the cart. Related Endpoint Operations - preAuthorizeAmendOrder
Show Source
-
amount(optional):
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(optional):
string
Credit card CVV.
-
cardNumber(optional):
string
Credit card number.
-
cardType(optional):
string
Payment method. e.g. physicalGiftCard/creditCard.
-
customProperties(optional):
object customProperties
Additional Properties Allowed: additionalPropertiesCustom object with dynamic properties. This will be passed to the webhook request
-
endMonth(optional):
string
credit card expiry month.
-
endYear(optional):
integer
credit card expiry year.
-
giftCardNumber(optional):
string
Gift card number used for payment. Payment type: physicalGiftCard (this field should be used when giftcards are used)
-
giftCardPin(optional):
string
Gift card pin. Payment type: physicalGiftCard (this field should be used when giftcards are used)
-
nameOncard(optional):
string
name printed on credit card.
-
paymentGroupId(optional):
string
Payment Group Id of the gift card payment group. Payment type: physicalGiftCard
-
seqNum(optional):
string
Sequence Number of the payment. In multiple paymnets, there can be any number of payments.
-
type(optional):
string
Payment type
Nested Schema : shippingAddress
Type:
object
shipping address for the order. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
Show Source
-
address1(optional):
string
Address Line 1 for this shipping address.
-
address2(optional):
string
Address Line 2 for this shipping address.
-
address3(optional):
string
Address Line 3 for this shipping address.
-
city(optional):
string
City for this shipping address.
-
companyName(optional):
string
Company name for this shipping address.
-
country(optional):
string
Country code for this shipping address.
-
countryName(optional):
string
Country name for this shipping address.
-
county(optional):
string
County for this shipping address.
-
DEFAULT_POSTAL_CODE_PATTERN(optional):
string
The default post code pattern of the shipping address.
-
email(optional):
string
Email for this shipping address.
-
faxNumber(optional):
string
Fax number for this shipping address.
-
firstName(optional):
string
First name for this shipping address.
-
isDefaultAddress(optional):
string
States if address is defualt address or not.
-
jobTitle(optional):
string
Job title for this shipping address.
-
lastName(optional):
string
Last name for this shipping address.
-
middleName(optional):
string
Middle name for this shipping address.
-
phoneNumber(optional):
string
Phone number for this shipping address.
-
postalCode(optional):
string
Postal code for this shipping address.
-
prefix(optional):
string
Prefix for this shipping address.
-
selectedCountry(optional):
string
The selected country of the shipping address.
-
selectedState(optional):
string
the selected state of the shipping address.
-
state(optional):
string
State code for this shipping address.
-
state_ISOCode(optional):
string
the state ISON code of the shipping address.
-
stateName(optional):
string
State name for this shipping address.
-
suffix(optional):
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
Show Source
-
value(optional):
string
method type of shipment
Nested Schema : shoppingCart
Type:
object
Shopping cart information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
Show Source
-
items(optional):
array items
Items in the cart.
Nested Schema : customProperties
Type:
object
Additional Properties Allowed
Show Source
-
string
Dynamic Properties if any
Custom object with dynamic properties. This will be passed to the webhook request
Show Source
-
membershipId(optional):
string
memberShipId of customer. This property need to be sent if loyalty payment method is selected for payment
-
programId(optional):
string
Unique id for loyalty program.This property need to be sent if loyalty payment method is selected for payment
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
email(optional):
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName(optional):
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
lastName(optional):
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
locationId(optional):
string
The location id of the store from which items are to be picked up (if type is inStorePickupShippingGroup).
-
middleName(optional):
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber(optional):
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
shippingAddress(optional):
object shippingAddress
shipping address for the order.
-
shippingMethod(optional):
object shippingMethod
Shipping method information.
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1(optional):
string
Address Line 1 for this shipping address.
-
address2(optional):
string
Address Line 2 for this shipping address.
-
address3(optional):
string
Address Line 3 for this shipping address.
-
city(optional):
string
City for this shipping address.
-
companyName(optional):
string
Company name for this shipping address.
-
country(optional):
string
Country code for this shipping address.
-
countryName(optional):
string
Country name for this shipping address.
-
county(optional):
string
County for this shipping address.
-
email(optional):
string
Email for this shipping address.
-
faxNumber(optional):
string
Fax number for this shipping address.
-
firstName(optional):
string
First name for this shipping address.
-
jobTitle(optional):
string
Job title for this shipping address.
-
lastName(optional):
string
Last name for this shipping address.
-
middleName(optional):
string
Middle name for this shipping address.
-
phoneNumber(optional):
string
Phone number for this shipping address.
-
postalCode(optional):
string
Postal code for this shipping address.
-
prefix(optional):
string
Prefix for this shipping address.
-
state(optional):
string
State code for this shipping address.
-
stateName(optional):
string
State name for this shipping address.
-
suffix(optional):
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
cost(optional):
number
shipping cost.
-
displayName(optional):
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount(optional):
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount(optional):
string
tax amount in secondary currency.
-
value(optional):
string
method type of shipment
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
backOrderableQuantity(optional):
number
Back Order Quantity of the Items.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id of commerce item.
-
childItems(optional):
array childItems
Child items of the commerce item
-
commerceItemId(optional):
string
Unique id of the line item
-
configuratorId(optional):
string
Configuration id of the configurable product
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
discountAmount(optional):
number
Discount given on commerce item.
-
discountInfo(optional):
array discountInfo
Discount Information.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
number
The Price of the product as per the external pricing system.
-
externalPriceQuantity(optional):
integer
Quantity of the product, the customer is allowed to buy at the external price.
-
overriddenPrice(optional):
number
overridden price of commerce item.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
preOrderableQuantity(optional):
number
Pre Order Quantity of the Items.
-
priceOverrideReason(optional):
string
Price override reason.
-
productId(optional):
string
Product Id of commerce item.
-
quantity(optional):
number
Quantity of the items.
-
rawTotalPrice(optional):
number
Raw total price of commerce item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
stockStatus(optional):
boolean
Indicates if the product has stock or not.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku Id of the child item
-
childItems(optional):
array childItems
Child items of the commerce item
-
commerceItemId(optional):
string
commerce item id of the child item
-
configurablePropertyId(optional):
string
configurable property id of the child item
-
configurationOptionId(optional):
string
configuration option id of the child item
-
currentPrice(optional):
number
Current price of the child item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display name of the child product
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
invalid(optional):
boolean
Invalid state of the child item
-
isAddOnItem(optional):
boolean
Indicates whether child item is add on item or not
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
priceListGroupId(optional):
string
price list group id of the child item
-
productId(optional):
string
Product Id of the child item
-
quantity(optional):
number
Quantity of the child item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
selectedOptions(optional):
array selectedOptions
Child Product Variant Information.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
stockStatus(optional):
boolean
Stock status Id of the child item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku Id of the child item
-
currentPrice(optional):
number
Current price of the child item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display name of the child product
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
invalid(optional):
boolean
Invalid state of the child item
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
priceListGroupId(optional):
string
price list group id of the child item
-
productId(optional):
string
Product Id of the child item
-
quantity(optional):
number
Quantity of the child item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
selectedOptions(optional):
array selectedOptions
Child Product Variant Information.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
stockStatus(optional):
boolean
Stock status Id of the child item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute.
-
optionValue(optional):
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute.
-
optionValue(optional):
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The couopn code.
-
promotionDesc(optional):
string
Description of the promotion.
-
promotionId(optional):
string
Id of the promotion.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : handleOrderAmendment_response
Type:
Show Source
object
-
allowAlternateCurrency(optional):
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.
-
cloneOrder(optional):
object cloneOrder
The clone order details. Related Endpoint Operations - initiateAmendment
-
discountInfo(optional):
object discountInfo
Discount information. Related Endpoint Operations - priceOrderAmendment
-
editInProgress(optional):
boolean
The original order id. Related Endpoint Operations - checkAmendmentInProgress
-
exchangeRate(optional):
number
The conversion 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.
-
id(optional):
string
The order id. Related Endpoint Operations - preAuthorizeAmendOrder
-
isItemPriceOverrideAllowed(optional):
boolean
Indicetes if item price can be overridden or not. Related Endpoint Operations - initiateAmendment
-
orderableQuantityMap(optional):
array orderableQuantityMap
The list of all logged comments for the order. Related Endpoint Operations - initiateAmendment
-
orderAction(optional):
string
The action performed on the order.
-
orderId(optional):
string
The original order id. Related Endpoint Operations - checkAmendmentInProgress
-
originalOrderId(optional):
string
The original order id. Related Endpoint Operations - initiateAmendment
-
paymentGroups(optional):
array paymentGroups
List of payment Groups for the order. Related Endpoint Operations - preAuthorizeAmendOrder
-
payments(optional):
object payments
Payment in the cart. Related Endpoint Operations - priceOrderAmendment
-
payShippingInSecondaryCurrency(optional):
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(optional):
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(optional):
object priceInfo
Price information of the order. Related Endpoint Operations - priceOrderAmendment
-
priceOverrideReasons(optional):
array priceOverrideReasons
All price override reasons. These are sent only if isItemPriceOverrideAllowed is true. Related Endpoint Operations - initiateAmendment
-
pricingMessages(optional):
object pricingMessages
The Pricing messages information.
-
secondaryCurrencyCode(optional):
string
The currency code of secondary currency associated with the site.
-
shippingGroups(optional):
array shippingGroups
List of shipping groups
-
shoppingCart(optional):
object shoppingCart
Shopping cart information. Related Endpoint Operations - priceOrderAmendment
-
state(optional):
integer
The order state. Related Endpoint operation - submitOrder.
-
stateDetailsAsUser(optional):
string
Order State description for this order.Incorporates changes made by merchant from admin UI, if any. Related Endpoint operation - submitOrder.
-
stateString(optional):
string
Order state as key string.
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order. Related Endpoint Operations - priceOrderAmendment
Nested Schema : cloneOrder
Type:
object
The clone order details. Related Endpoint Operations - initiateAmendment
Show Source
-
creationDate(optional):
string
Date on which the Order was created.
-
creationTime(optional):
number
Order creation time.
-
discountInfo(optional):
object discountInfo
Discount information.
-
id(optional):
string
Commerce id for this order.
-
orderComments(optional):
array orderComments
The list of all logged comments for the order.
-
originOfOrder(optional):
string
The source from which order got created.
-
paymentGroup(optional):
object paymentGroup
Payment Group for the order.
-
paymentGroups(optional):
array paymentGroups
List of payment Groups for the order.
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
priceListGroup(optional):
object priceListGroup
PriceList group of the order.
-
profile(optional):
object profile
Profile Information for the order.
-
profileId(optional):
string
The Repository Id of the profile to which this Order belongs to.
-
quoteInfo(optional):
object quoteInfo
the quote information of the order
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
recurring charge price info at order level
-
returnRequests(optional):
array returnRequests
The list of the requests raised for the order.
-
shippingAddress(optional):
object shippingAddress
shipping address for the order.
-
shippingGroups(optional):
array shippingGroups
List of shipping groups
-
shippingMethod(optional):
object shippingMethod
Shipping method information.
-
shoppingCart(optional):
object shoppingCart
Shopping cart information.
-
siteId(optional):
string
Site Id on which the order was placed.
-
state(optional):
integer
The order state.
-
stateDetailsAsUser(optional):
string
Order State description for this order.Incorporates changes made by merchant from admin UI, if any.
-
submittedDate(optional):
string
Date on which the Order was submitted.
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order.
-
totalAmountAuthorized(optional):
number
total amount authorized for the order.
Nested Schema : discountInfo
Type:
object
Discount information. Related Endpoint Operations - priceOrderAmendment
Show Source
-
claimedCouponMultiPromotions(optional):
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap(optional):
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount(optional):
number
Discount given on an order.
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
List of discounts.
-
secondaryCurrencyShippingDiscount(optional):
number
The shipping discount in secondary currency in case of mix currency scenario.
-
shippingDiscount(optional):
number
shipping discount
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap(optional):
array unclaimedCouponsMap
Map of unclaimed coupons.
Nested Schema : orderableQuantityMap
Type:
array
The list of all logged comments for the order. Related Endpoint Operations - initiateAmendment
Show Source
Nested Schema : paymentGroups
Type:
array
List of payment Groups for the order. Related Endpoint Operations - preAuthorizeAmendOrder
Show Source
Nested Schema : payments
Type:
object
Payment in the cart. Related Endpoint Operations - priceOrderAmendment
Show Source
-
amount(optional):
number
The raw number that represents the price.
-
amountAuthorized(optional):
number
The amount authorized with this Payment Group.
-
gatewayName(optional):
string
The payment gateway name.
-
IIN(optional):
string
The issuer identification number of the card intended to pay for order.
-
isAmountRemaining(optional):
boolean
Indicates if there is any balance unpaid amount remaining on the cart.
-
paymentGroupId(optional):
string
Id of this payment Group.
-
paymentMethod(optional):
string
The payment method name.
-
paymentState(optional):
string
The Payment Group state.
-
uiIntervention(optional):
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
Show Source
-
amount(optional):
number
The raw number that represents the price.
-
billing(optional):
number
The billing cost of the order.
-
currencyCode(optional):
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
primaryCurrencyTotal(optional):
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.
-
secondaryCurrencyShipingAmount(optional):
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.
-
secondaryCurrencyTaxAmount(optional):
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(optional):
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(optional):
number
Total shipping amount of the order.
-
shippingSurchargeValue(optional):
number
Total shipping surcharge amount of the order.
-
subTotal(optional):
number
The subtotal of the order before applying order-level promotions.
-
tax(optional):
number
The tax on the order.
-
total(optional):
number
The current working total, including all promotions, tax, and billing costs.
-
totalWithoutTax(optional):
number
Order total without tax.
Nested Schema : priceOverrideReasons
Type:
array
All price override reasons. These are sent only if isItemPriceOverrideAllowed is true. Related Endpoint Operations - initiateAmendment
Show Source
Nested Schema : pricingMessages
Type:
object
The Pricing messages information.
Show Source
-
promotionUpsellMessages(optional):
array promotionUpsellMessages
The promotion upsell messages.
Nested Schema : shoppingCart
Type:
object
Shopping cart information. Related Endpoint Operations - priceOrderAmendment
Show Source
-
items(optional):
array items
Items in the cart.
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order. Related Endpoint Operations - priceOrderAmendment
Show Source
-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
cityTax(optional):
number
The monetary amount of city tax.
-
countryTax(optional):
number
The monetary amount of country tax.
-
countyTax(optional):
number
The monetary amount of county tax.
-
currencyCode(optional):
string
The three character currency code.
-
discounted(optional):
boolean
Whether the price was discounted.
-
districtTax(optional):
number
Tax amount for the district.
-
secondaryCurrencyTaxAmount(optional):
number
The current total tax amount in monetry currency
-
stateTax(optional):
number
Tax amount for the state.
Nested Schema : discountInfo
Type:
object
Discount information.
Show Source
-
claimedCouponMultiPromotions(optional):
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap(optional):
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount(optional):
number
Discount given on an order.
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
List of discounts.
-
secondaryCurrencyShippingDiscount(optional):
number
The shipping discount in secondary currency in case of mix currency scenario.
-
shippingDiscount(optional):
number
Shippinng discount
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap(optional):
array unclaimedCouponsMap
Map of unclaimed coupons.
Nested Schema : orderComments
Type:
array
The list of all logged comments for the order.
Show Source
Nested Schema : paymentGroup
Type:
object
Payment Group for the order.
Show Source
-
amount(optional):
number
The amount associated with this Payment Group.
-
amountAuthorized(optional):
number
The amount authorized with this Payment Group.
-
billingAddress(optional):
object billingAddress
Billing address for the order.
-
cardNumber(optional):
string
The masked credit card number.
-
cardType(optional):
string
Payment method. e.g. physicalGiftCard/ creditCard
-
firstName(optional):
string
First name associated with this Payment Group.
-
lastName(optional):
string
Last name associated with this Payment Group.
-
paidAmount(optional):
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId(optional):
string
Id of this payment Group.
-
paymentState(optional):
string
The Payment Group state.
-
paymentStateDetailsAsUser(optional):
string
The payment state description as string.
-
refundAmount(optional):
number
The amount that has been credited to-date for this Payment Group.
-
token(optional):
string
The payment authorization token.
-
totalDue(optional):
number
The current working total order price including all discounts, tax, and billing costs.
-
type(optional):
string
Payment method type
-
uiIntervention(optional):
string
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.
Show Source
-
amount(optional):
number
The raw number that represents the price.
-
currencyCode(optional):
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
primaryCurrencyTotal(optional):
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.
-
secondaryCurrencyShipingAmount(optional):
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.
-
secondaryCurrencyTaxAmount(optional):
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(optional):
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(optional):
number
Total shipping amount of the order.
-
shippingSurchargeValue(optional):
number
Total shipping surcharge amount of the order.
-
subTotal(optional):
number
The subtotal of the order before applying order-level promotions.
-
tax(optional):
number
The tax on the order.
-
total(optional):
number
The current working total, including all promotions, tax, and billing costs.
-
totalWithoutTax(optional):
number
Order total without tax.
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
Show Source
-
active(optional):
boolean
Active status of pricelist group.
-
currency(optional):
object currency
Currency of the PriceList group.
-
deleted(optional):
boolean
Pricelist group deleted status.
-
displayName(optional):
string
Display Name.
-
id(optional):
string
Id.
-
locale(optional):
string
Locale.
-
repositoryId(optional):
string
Repository Id.
Nested Schema : profile
Type:
object
Profile Information for the order.
Show Source
-
email(optional):
string
Email id of profile.
-
firstName(optional):
string
First name of profile.
-
lastName(optional):
string
Last name of profile.
-
middleName(optional):
string
Middle name of profile.
Nested Schema : quoteInfo
Type:
object
the quote information of the order
Show Source
-
errorInfo(optional):
array errorInfo
the array of errors, if any
-
expirationDate(optional):
string
the expiration date of the quoted order, if any
-
externalId(optional):
string
the external id for the quote
-
notes(optional):
array notes
the notes (history) for the order
-
providerNote(optional):
string
the provider note for the quoted order
-
quoteDate(optional):
number
the date the order was quoted in milliseconds
-
rejectionDate(optional):
string
rejection date of the quoted order
-
rejectionNote(optional):
string
the rejection note for an order whose quote has been rejected by user
-
requestDate(optional):
string
the date when the quote was requested in ISO format
Nested Schema : recurringChargePriceInfo
Type:
object
recurring charge price info at order level
Show Source
-
amount(optional):
integer
amount
-
currencyCode(optional):
string
currency code
-
shipping(optional):
integer
shipping charge
-
subTotal(optional):
integer
subTotal
-
subTotalByFrequency(optional):
array subTotalByFrequency
subtotal by frequency
-
tax(optional):
integer
tax
-
taxByFrequency(optional):
array taxByFrequency
tax calculated by frequency
-
total(optional):
integer
total
-
totalWithoutTax(optional):
integer
total without tax
Nested Schema : returnRequests
Type:
array
The list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1(optional):
string
Address Line 1 for this shipping address.
-
address2(optional):
string
Address Line 2 for this shipping address.
-
address3(optional):
string
Address Line 3 for this shipping address.
-
city(optional):
string
City for this shipping address.
-
companyName(optional):
string
Company name for this shipping address.
-
country(optional):
string
Country code for this shipping address.
-
countryName(optional):
string
Country name for this shipping address.
-
county(optional):
string
County for this shipping address.
-
email(optional):
string
Email for this shipping address.
-
faxNumber(optional):
string
Fax number for this shipping address.
-
firstName(optional):
string
First name for this shipping address.
-
jobTitle(optional):
string
Job title for this shipping address.
-
lastName(optional):
string
Last name for this shipping address.
-
middleName(optional):
string
Middle name for this shipping address.
-
phoneNumber(optional):
string
Phone number for this shipping address.
-
postalCode(optional):
string
Postal code for this shipping address.
-
prefix(optional):
string
Prefix for this shipping address.
-
state(optional):
string
State code for this shipping address.
-
stateName(optional):
string
State name for this shipping address.
-
suffix(optional):
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
cost(optional):
number
shipping cost.
-
displayName(optional):
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount(optional):
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount(optional):
string
tax amount in secondary currency.
-
value(optional):
string
method type of shipment
Nested Schema : shoppingCart
Type:
object
Shopping cart information.
Show Source
-
items(optional):
array items
Items in the cart.
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
Show Source
-
amount(optional):
number
The monetary amount.
-
cityTax(optional):
number
The monetary amount of city tax.
-
countryTax(optional):
number
The monetary amount of country tax.
-
countyTax(optional):
number
The monetary amount of county tax.
-
districtTax(optional):
number
Tax amount for the district.
-
isTaxIncluded(optional):
boolean
Indicates if tax is included in price.
-
miscTax(optional):
number
Miscellaneous Tax amount.
-
secondaryCurrencyTaxAmount(optional):
number
The monetary total amount of tax.
-
stateTax(optional):
number
Tax amount for the state.
-
valueAddedTax(optional):
number
Value Added Tax amount.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Promotion description.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Description of the promotion
-
promotionId(optional):
string
Id of the promotion
-
promotionLevel(optional):
string
Level of the promotion
-
totalAdjustment(optional):
string
Total adjustment caused by the promotion
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Promotion description.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
Nested Schema : items
Type:
Show Source
object
-
couonInfo(optional):
array couonInfo
The couopn Info
-
promotionValue(optional):
string
The value for promotion
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Description of the promotion
-
promotionId(optional):
string
Id of the promotion
-
promotionLevel(optional):
string
Level of the promotion
-
totalAdjustment(optional):
string
Total adjustment caused by the promotion
Nested Schema : items
Type:
Show Source
object
-
comment(optional):
string
The comment string.
-
creationDate(optional):
string
Date on which the comment was created.
-
repositoryId(optional):
string
The repository id of the comment record.
Nested Schema : billingAddress
Type:
object
Billing address for the order.
Show Source
-
address1(optional):
string
Address line 1 for this billing address.
-
address2(optional):
string
Address line 2 for this billing address.
-
address3(optional):
string
Address line 3 for this billing address.
-
city(optional):
string
City for this billing address.
-
companyName(optional):
string
Company name for this billing address.
-
country(optional):
string
Country code for this billing address.
-
countryName(optional):
string
Country name for this billing address.
-
county(optional):
string
County for this billing address.
-
email(optional):
string
Email for this billing address.
-
faxNumber(optional):
string
Fax number for this billing address.
-
firstName(optional):
string
First name for this billing address.
-
jobTitle(optional):
string
Job title for this billing address.
-
lastName(optional):
string
Last name for this billing address.
-
middleName(optional):
string
Middle name for this billing address.
-
phoneNumber(optional):
string
Phone number for this billing address.
-
postalCode(optional):
string
Postal code for this billing address.
-
prefix(optional):
string
Prefix for this billing address.
-
state(optional):
string
State code for this billing address.
-
stateName(optional):
string
State name for this billing address.
-
suffix(optional):
string
Suffix for this billing address.
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The amount associated with this Payment Group.
-
amountAuthorized(optional):
number
The amount authorized with this Payment Group.
-
billingAddress(optional):
object billingAddress
Billing address for the order.
-
cardNumber(optional):
string
The masked credit card number.
-
cardType(optional):
string
Payment method. e.g. physicalGiftCard/ creditCard
-
firstName(optional):
string
First name associated with this Payment Group.
-
lastName(optional):
string
Last name associated with this Payment Group.
-
paidAmount(optional):
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId(optional):
string
Id of this payment Group.
-
paymentState(optional):
string
The Payment Group state.
-
paymentStateDetailsAsUser(optional):
string
The payment state description as string.
-
refundAmount(optional):
number
The amount that has been credited to-date for this Payment Group.
-
token(optional):
string
Token associated with this Payment Group.
-
totalDue(optional):
number
The current working total order price including all discounts, tax, and billing costs.
-
type(optional):
string
Payment method type
-
uiIntervention(optional):
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.
Show Source
-
address1(optional):
string
Address line 1 for this billing address.
-
address2(optional):
string
Address line 2 for this billing address.
-
address3(optional):
string
Address line 3 for this billing address.
-
city(optional):
string
City for this billing address.
-
companyName(optional):
string
Company name for this billing address.
-
country(optional):
string
Country code for this billing address.
-
countryName(optional):
string
Country name for this billing address.
-
county(optional):
string
County for this billing address.
-
email(optional):
string
Email for this billing address.
-
faxNumber(optional):
string
Fax number for this billing address.
-
firstName(optional):
string
First name for this billing address.
-
jobTitle(optional):
string
Job title for this billing address.
-
lastName(optional):
string
Last name for this billing address.
-
middleName(optional):
string
Middle name for this billing address.
-
phoneNumber(optional):
string
Phone number for this billing address.
-
postalCode(optional):
string
Postal code for this billing address.
-
prefix(optional):
string
Prefix for this billing address.
-
state(optional):
string
State code for this billing address.
-
stateName(optional):
string
State name for this billing address.
-
suffix(optional):
string
Suffix for this billing address.
Nested Schema : currency
Type:
object
Currency of the PriceList group.
Show Source
-
currencyCode(optional):
string
Currency Code.
-
displayName(optional):
string
Display Name.
-
fractionalDigits(optional):
integer
Fractional Digits.
-
numericCode(optional):
string
Numeric Code.
-
repositoryId(optional):
string
Repository Id.
-
symbol(optional):
string
currency Symbol.
Nested Schema : items
Type:
Show Source
object
-
profileId(optional):
string
the profile id of the user
-
profileType(optional):
string
the profile type of the user that requested the quote
-
requestDate/quoteDate/rejectionDate(optional):
number
the request/quote/rejection date for the note
-
requesterNote/providerNote/rejectionNote(optional):
string
the requester/provider/rejection note
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
integer
amount
-
frequency(optional):
string
frequency of the recurring charges
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
integer
amount
-
frequency(optional):
string
frequency for the recurring charges
Nested Schema : items
Type:
Show Source
object
-
createdDate(optional):
string
The creation date of the return request.
-
returnRequestId(optional):
string
The return request id.
-
state(optional):
string
The status of the return request.
-
stateKey(optional):
string
State key for return request which is not localized
-
totalRefund(optional):
number
The total amount to be refunded on return.
-
totalReturnQuantity(optional):
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
Show Source
object
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
shippingAddress(optional):
object shippingAddress
shipping address for the order.
-
shippingMethod(optional):
object shippingMethod
Shipping method information.
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order.
-
trackingInfo(optional):
array trackingInfo
Tracking Information for the Order
-
trackingNumber(optional):
string
Shipping tracking number
Nested Schema : priceInfo
Type:
object
Price information of the order.
Show Source
-
amount(optional):
number
The raw number that represents the price.
-
billing(optional):
number
The billing cost of the order.
-
currencyCode(optional):
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
primaryCurrencyTotal(optional):
number
The current total in loyalty points in case of mix currency
-
secondaryCurrencyShipingAmount(optional):
number
The current total shipping amount in monetry currency
-
secondaryCurrencyTaxAmount(optional):
number
The current total tax amount in monetry currency
-
secondaryCurrencyTotal(optional):
number
The current total (sum ofshipping and tax)amount in monetry currency
-
shippingSurchargeValue(optional):
number
The total shiiping surcharge value in the order
-
subTotal(optional):
number
The subtotal of the order before applying order-level promotions.
-
tax(optional):
number
The tax on the order.
-
total(optional):
number
The current working total, including all promotions, tax, and billing costs.
-
totalWithoutTax(optional):
number
The cost of the order without including tax
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1(optional):
string
Address Line 1 for this shipping address.
-
address2(optional):
string
Address Line 2 for this shipping address.
-
address3(optional):
string
Address Line 3 for this shipping address.
-
city(optional):
string
City for this shipping address.
-
companyName(optional):
string
Company name for this shipping address.
-
country(optional):
string
Country code for this shipping address.
-
countryName(optional):
string
Country name for this shipping address.
-
county(optional):
string
County for this shipping address.
-
email(optional):
string
Email for this shipping address.
-
faxNumber(optional):
string
Fax number for this shipping address.
-
firstName(optional):
string
First name for this shipping address.
-
jobTitle(optional):
string
Job title for this shipping address.
-
lastName(optional):
string
Last name for this shipping address.
-
middleName(optional):
string
Middle name for this shipping address.
-
phoneNumber(optional):
string
Phone number for this shipping address.
-
postalCode(optional):
string
Postal code for this shipping address.
-
prefix(optional):
string
Prefix for this shipping address.
-
state(optional):
string
State code for this shipping address.
-
stateName(optional):
string
State name for this shipping address.
-
suffix(optional):
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
cost(optional):
number
shipping cost.
-
displayName(optional):
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount(optional):
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount(optional):
string
tax amount in secondary currency.
-
value(optional):
string
method type of shipment
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
Show Source
-
amount(optional):
number
The amount.
-
cityTax(optional):
number
The amount of city tax.
-
countryTax(optional):
number
The amount of country tax.
-
countyTax(optional):
number
The amount of county tax.
-
currencyCode(optional):
string
The three character currency code.
-
districtTax(optional):
number
Tax amount for the district.
-
isTaxIncluded(optional):
boolean
Is tax included in the product itself or not
-
miscTax(optional):
number
miscellaneous tax
-
secondaryCurrencyTaxAmount(optional):
number
The monetary total amount of tax.
-
stateTax(optional):
number
Tax amount for the state.
-
valueAddedTax(optional):
number
The amount of value added tax.
Nested Schema : items
Type:
Show Source
object
-
carrierId(optional):
string
Carrier Id for Tracking
-
carrierName(optional):
string
Carrier Name for Tracking
-
carrierUrl(optional):
string
Carrier URL for Tracking
-
trackingNumber(optional):
string
Tracking Number
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id of commerce item.
-
childItems(optional):
array childItems
Child items of the commerce item
-
commerceItemId(optional):
string
Commerce Id of the returned item
-
configuratorId(optional):
string
configurator id of the configurable product
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
array detailedRecurringChargeInfo
detailed recurring charge info for the item
-
discountAmount(optional):
number
Total discount applied to commerce item.
-
discountInfo(optional):
array discountInfo
discount information of the product
-
displayName(optional):
string
Display name of commerce item.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
number
The Price of the product as per the external pricing system.
-
externalPriceQuantity(optional):
integer
Quantity of the product, the customer is allowed to buy at the external price.
-
externalRecurringCharge(optional):
string
external recurring charge for the given item
-
externalRecurringChargeDuration(optional):
integer
external recurring charge duration
-
externalRecurringChargeFrequency(optional):
string
external recurring charge frequency
-
imageInfo(optional):
object imageInfo
Image information
-
isPriceOverridden(optional):
boolean
Indicates if commerce item price is overridden or not.
-
listPrice(optional):
number
list price of commerce item
-
onSale(optional):
boolean
indicates if product is on sale or not.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
overriddenPrice(optional):
number
overridden price of commerce item.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
price(optional):
number
The raw number that represents the price.
-
priceOverridenBy(optional):
string
Name of the agent who has overridden item price.
-
priceOverrideReason(optional):
object priceOverrideReason
Price override reason map
-
productId(optional):
string
Product Id of commerce item.
-
quantity(optional):
number
Quantity of the items.
-
rawTotalPrice(optional):
number
Raw total price of commerceItem
-
recurringCharge(optional):
integer
recurring charge at the item level
-
returnedQuantity(optional):
number
Returned Quantity
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shippingSurchargeValue(optional):
number
Shipping surcharge amount for commerce item.
-
stateDetailsAsUser(optional):
string
State description of the commerce item.
-
status(optional):
string
State of the commerce item.
-
subTotal(optional):
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.
-
tax(optional):
number
The amount of tax paid for this item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
number
Sale price or list price of commerceItem.
-
variant(optional):
array variant
Sku option information
Nested Schema : detailedRecurringChargeInfo
Type:
array
detailed recurring charge info for the item
Show Source
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : imageInfo
Type:
object
Image information
Show Source
-
primaryThumbImageURL(optional):
string
The primary thumb URL
Nested Schema : priceOverrideReason
Type:
object
Price override reason map
Show Source
-
displayValue(optional):
string
price override reason value
-
key(optional):
string
price override reason key
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku Id of the child item
-
childItems(optional):
array childItems
Child items of the commerce item
-
commerceItemId(optional):
string
commerce item id of the child item
-
configurablePropertyId(optional):
string
configurable property id of the child item
-
configurationOptionId(optional):
string
configuration option id of the child item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display name of the child product
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
isAddOnItem(optional):
boolean
Indicates whether child item is add on item or not
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
Product Id of the child item
-
quantity(optional):
number
Quantity of the child item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
Image route
-
selectedOptions(optional):
array selectedOptions
The array of variants of the child item.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku Id of the child item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display name of the child product
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
Product Id of the child item
-
quantity(optional):
number
Quantity of the child item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
Image route
-
selectedOptions(optional):
array selectedOptions
The array of variants of the child item.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The varian option name.
-
optionValue(optional):
string
The variant option value
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The varian option name.
-
optionValue(optional):
string
The variant option value
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
integer
amount
-
currencyCode(optional):
string
currency code
-
detailedUnitPrice(optional):
integer
detailed unit price
-
discounted(optional):
boolean
whether the given item is discounted or not
- orderDiscountShare(optional): integer
-
quantity(optional):
integer
Quantity of the item
-
secondaryCurrencyTaxAmount(optional):
integer
secondary currency tax amount
-
tax(optional):
integer
tax calculated on the recurring charges of the item
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
Coupon code.
-
promotionDesc(optional):
string
Description of the promotion.
-
promotionId(optional):
string
Id of the promotion.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The SKU option name.
-
optionValue(optional):
string
The SKU option value.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Promotion description.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Description of the promotion
-
promotionId(optional):
string
Id of the promotion
-
promotionLevel(optional):
string
Level of the promotion
-
totalAdjustment(optional):
string
Total adjustment caused by the promotion
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Promotion description.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
Nested Schema : items
Type:
Show Source
object
-
couonInfo(optional):
array couonInfo
The couopn Info
-
value(optional):
string
The value for promotion
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Description of the promotion
-
promotionId(optional):
string
Id of the promotion
-
promotionLevel(optional):
string
Level of the promotion
-
totalAdjustment(optional):
string
Total adjustment caused by the promotion
Nested Schema : items
Type:
Show Source
object
-
productId:skuId(optional):
number
Maximum orderable quantity for the commerce item
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The amount associated with this Payment Group.
-
amountAuthorized(optional):
number
The amount authorized with this Payment Group.
-
billingAddress(optional):
object billingAddress
Billing address for the order.
-
cardNumber(optional):
string
The masked credit card number.
-
cardType(optional):
string
Payment method. e.g. physicalGiftCard/ creditCard
-
firstName(optional):
string
First name associated with this Payment Group.
-
lastName(optional):
string
Last name associated with this Payment Group.
-
originalPaymentGroupId(optional):
string
Payment group id of the original order.
-
paidAmount(optional):
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId(optional):
string
Id of this payment Group.
-
paymentState(optional):
string
The Payment Group state.
-
paymentStateDetailsAsUser(optional):
string
The payment state description as string.
-
refundAmount(optional):
number
The amount that has been credited to-date for this Payment Group.
-
seqNum(optional):
string
Sequence Number of the payment. In multiple paymnets, there can be any number of payments.
-
token(optional):
string
Token associated with this Payment Group.
-
totalDue(optional):
number
The current working total order price including all discounts, tax, and billing costs.
-
type(optional):
string
Payment method type
-
uiIntervention(optional):
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.
Show Source
-
address1(optional):
string
Address line 1 for this billing address.
-
address2(optional):
string
Address line 2 for this billing address.
-
address3(optional):
string
Address line 3 for this billing address.
-
city(optional):
string
City for this billing address.
-
companyName(optional):
string
Company name for this billing address.
-
country(optional):
string
Country code for this billing address.
-
countryName(optional):
string
Country name for this billing address.
-
county(optional):
string
County for this billing address.
-
email(optional):
string
Email for this billing address.
-
faxNumber(optional):
string
Fax number for this billing address.
-
firstName(optional):
string
First name for this billing address.
-
jobTitle(optional):
string
Job title for this billing address.
-
lastName(optional):
string
Last name for this billing address.
-
middleName(optional):
string
Middle name for this billing address.
-
phoneNumber(optional):
string
Phone number for this billing address.
-
postalCode(optional):
string
Postal code for this billing address.
-
prefix(optional):
string
Prefix for this billing address.
-
state(optional):
string
State code for this billing address.
-
stateName(optional):
string
State name for this billing address.
-
suffix(optional):
string
Suffix for this billing address.
Nested Schema : items
Type:
Show Source
object
-
displayValue(optional):
string
price override reason value
-
key(optional):
string
price override reason key
Nested Schema : items
Type:
Show Source
object
-
tags(optional):
array tags
The tags the promotion upsell message is associated with.
-
text(optional):
string
The promotion upsell message.
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
email(optional):
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName(optional):
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
lastName(optional):
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName(optional):
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber(optional):
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
shippingAddress(optional):
object shippingAddress
shipping address for the order.
-
shippingMethod(optional):
object shippingMethod
Shipping method information.
-
store(optional):
object store
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order.
-
trackingInfo(optional):
array trackingInfo
Tracking Information for the Order
-
trackingNumber(optional):
string
Shipping tracking number
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
Nested Schema : priceInfo
Type:
object
Price information of the order.
Show Source
-
amount(optional):
number
The raw number that represents the price.
-
billing(optional):
number
The billing cost of the order.
-
currencyCode(optional):
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
primaryCurrencyTotal(optional):
number
The current total in loyalty points in case of mix currency
-
secondaryCurrencyShipingAmount(optional):
number
The current total shipping amount in monetry currency
-
secondaryCurrencyTaxAmount(optional):
number
The current total tax amount in monetry currency
-
secondaryCurrencyTotal(optional):
number
The current total (sum ofshipping and tax)amount in monetry currency
-
shippingSurchargeValue(optional):
number
The total shiiping surcharge value in the order
-
subTotal(optional):
number
The subtotal of the order before applying order-level promotions.
-
tax(optional):
number
The tax on the order.
-
total(optional):
number
The current working total, including all promotions, tax, and billing costs.
-
totalWithoutTax(optional):
number
The cost of the order without including tax
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1(optional):
string
Address Line 1 for this shipping address.
-
address2(optional):
string
Address Line 2 for this shipping address.
-
address3(optional):
string
Address Line 3 for this shipping address.
-
city(optional):
string
City for this shipping address.
-
companyName(optional):
string
Company name for this shipping address.
-
country(optional):
string
Country code for this shipping address.
-
countryName(optional):
string
Country name for this shipping address.
-
county(optional):
string
County for this shipping address.
-
email(optional):
string
Email for this shipping address.
-
faxNumber(optional):
string
Fax number for this shipping address.
-
firstName(optional):
string
First name for this shipping address.
-
jobTitle(optional):
string
Job title for this shipping address.
-
lastName(optional):
string
Last name for this shipping address.
-
middleName(optional):
string
Middle name for this shipping address.
-
phoneNumber(optional):
string
Phone number for this shipping address.
-
postalCode(optional):
string
Postal code for this shipping address.
-
prefix(optional):
string
Prefix for this shipping address.
-
state(optional):
string
State code for this shipping address.
-
stateName(optional):
string
State name for this shipping address.
-
suffix(optional):
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
cost(optional):
number
shipping cost.
-
displayName(optional):
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount(optional):
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount(optional):
string
tax amount in secondary currency.
-
value(optional):
string
method type of shipment
Nested Schema : store
Type:
object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1(optional):
string
Address line 1 of the store.
-
address2(optional):
string
Address line 2 of the store.
-
address3(optional):
string
Address line 3 of the store.
-
city(optional):
string
The city in which the store resides.
-
country(optional):
string
The country in which the store resides.
-
county(optional):
string
The county in which the store resides.
-
email(optional):
string
The email address of the store.
-
faxNumber(optional):
string
The fax number of the store.
-
hours(optional):
string
The opening hours of the store.
-
locationId(optional):
string
The location id of the store.
-
name(optional):
string
Name of the store.
-
phoneNumber(optional):
string
The phone number of the store.
-
postalCode(optional):
string
The postal code of the store.
-
stateAddress(optional):
string
The state in which the store resides.
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
Show Source
-
amount(optional):
number
The amount.
-
cityTax(optional):
number
The amount of city tax.
-
countryTax(optional):
number
The amount of country tax.
-
countyTax(optional):
number
The amount of county tax.
-
currencyCode(optional):
string
The three character currency code.
-
districtTax(optional):
number
Tax amount for the district.
-
isTaxIncluded(optional):
boolean
Is tax included in the product itself or not
-
miscTax(optional):
number
miscellaneous tax
-
secondaryCurrencyTaxAmount(optional):
number
The monetary total amount of tax.
-
stateTax(optional):
number
Tax amount for the state.
-
valueAddedTax(optional):
number
The amount of value added tax.
Nested Schema : items
Type:
Show Source
object
-
carrierId(optional):
string
Carrier Id for Tracking
-
carrierName(optional):
string
Carrier Name for Tracking
-
carrierUrl(optional):
string
Carrier URL for Tracking
-
trackingNumber(optional):
string
Tracking Number
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
availabilityDate(optional):
string
The Availability date of commerce Item.
-
backOrderQuantity(optional):
number
Back Order Quantity of the Items.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id of commerce item.
-
childItems(optional):
array childItems
Child items of the commerce item
-
commerceItemId(optional):
string
Unique id of the line item
-
configuratorId(optional):
string
Configuration id of the configurable product
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display name of commerce item.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
number
The Price of the product as per the external pricing system.
-
externalPriceQuantity(optional):
integer
Quantity of the product, the customer is allowed to buy at the external price.
-
imageInfo(optional):
object imageInfo
The image information.
-
listPrice(optional):
number
list price of commerce item.
-
onSale(optional):
boolean
Indicates if product is on sale or not.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
preOrderQuantity(optional):
number
Pre Order Quantity of the Items.
-
price(optional):
number
The raw number that represents the price.
-
productId(optional):
string
Product Id of commerce item.
-
quantity(optional):
number
Quantity of the items.
-
rawTotalPrice(optional):
number
Raw total price of commerce item
-
returnedQuantity(optional):
number
Returned quantity
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shippingSurchargeValue(optional):
number
Shipping surcharge amount for commerce item.
-
stateDetailsAsUser(optional):
string
State description of the commerce item.
-
status(optional):
integer
State of the commerce item.
-
tax(optional):
number
The amount of tax paid for this item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
number
Sale price or list price of commerceItem.
-
variant(optional):
array variant
Sku Information
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : imageInfo
Type:
object
The image information.
Show Source
-
primaryThumbImageURL(optional):
string
The primary thumb URL
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku Id of the child item
-
childItems(optional):
array childItems
Child items of the commerce item
-
commerceItemId(optional):
string
commerce item id of the child item
-
configurablePropertyId(optional):
string
configurable property id of the child item
-
configurationOptionId(optional):
string
configuration option id of the child item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display name of the child product
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
isAddOnItem(optional):
boolean
Indicates whether child item is add on item or not
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
Product Id of the child item
-
quantity(optional):
number
Quantity of the child item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
Product path
-
selectedOptions(optional):
array selectedOptions
Child Product Variant Information.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku Id of the child item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display name of the child product
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
Product Id of the child item
-
quantity(optional):
number
Quantity of the child item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
Product path
-
selectedOptions(optional):
array selectedOptions
Child Product Variant Information.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute.
-
optionValue(optional):
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute.
-
optionValue(optional):
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The SKU option name.
-
optionValue(optional):
string
The SKU option value.
Example Response (application/json)
{
"originalOrderId":"o160415",
"pricingMessages":{
"promotionUpsellMessages":[
{
"text":"Spend $20 more get free shipping!",
"tags":[
"CART_UPSELL"
]
},
{
"text":"You have qualified for a free Sports DVD!",
"tags":[
"BANNER_UPSELL",
"CART_UPSELL"
]
}
]
},
"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":[
],
"billingProfileId":"billingProfile-123",
"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",
"configurationOptionId":"co40001",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod40001",
"displayName":"Intel Pentium Dual Core",
"isAddOnItem":true,
"externalData":[
],
"parentAssetKey":"12345",
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":"12345",
"configurablePropertyId":"cp40001",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku40001",
"assetKey":"23456",
"commerceItemId":"ci19000424",
"route":"/intel-pentium-dual-core/product/prod40001",
"customerAccountId":"customerAcc-123",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
},
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod40007",
"displayName":"8 GB Kingston Sodimm DDR3 1600MHz",
"isAddOnItem":false,
"externalData":[
],
"parentAssetKey":"12345",
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"childItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod40009",
"displayName":"Intel Pentium i9 Core",
"externalData":[
],
"parentAssetKey":"12345",
"billingAccountId":"billingAcc-123",
"rootAssetKey":"98765",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku40009",
"assetKey":"84848",
"route":"/intel-pentium-dual-core/product/prod40001",
"customerAccountId":"customerAcc-123",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"rootAssetKey":"12345",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku40007",
"assetKey":"98765",
"commerceItemId":"ci19000425",
"route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007",
"customerAccountId":"customerAcc-123",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"configuratorId":"36379716",
"assetKey":"12345",
"overriddenPrice":"",
"commerceItemId":"ci1000785",
"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,
"parentAssetKey":null,
"tax":37.4,
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"camcordersku_1_3",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"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":[
{
"firstName":null,
"emailAddress":null,
"phoneNumber":null,
"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"
},
"middleName":null,
"store":{
"country":"USA",
"hours":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM",
"address3":null,
"address2":"15th Floor",
"city":"San Francisco",
"address1":"475 Sansome Street",
"postalCode":"94111",
"county":null,
"stateAddress":"CA",
"phoneNumber":"(617) 386-1200",
"locationId":"testLoc2",
"name":"Cloud Store - SanFrancisco",
"faxNumber":"(617) 386-1200",
"email":"store113@example.com"
},
"type":"inStorePickupShippingGroup",
"items":[
{
"serviceAccountId":"serviceAcc-123",
"availablePickupDate":null,
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"Product_18Cxi",
"preferredPickupDate":null,
"externalData":[
],
"parentAssetKey":null,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"Sku_18Dxi",
"assetKey":"84756",
"customerAccountId":"customerAcc-123",
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"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",
"originOfOrder":"contactCenter",
"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. 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|
|------------------|------------------|
|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|
|28410|The structure of add-ons defined for the order is invalid|
|28329|One of the dynamic properties is not writable by the Agent user|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code