requestQuote
post
/ccagent/v1/orders/quote
Request Quote. Request for a quote on an incomplete order or request for a requote on a quoted order. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCOrganization: string
the organization Id in which order should be created
-
x-ccsite: string
the site id on which the orders needs to be placed
Root Schema : requestQuote_request
Type:
Show Source
object-
amountRemaining:
number
amount to authorize.
-
appliedPromotions:
array appliedPromotions
The array of applied promotions. If not supplied, it utilizes the promotions in the current incomplete order.
-
billingAddress:
object billingAddress
Billing address for the order.
-
id(required):
string
the order id for the order which is to be quoted. If undefined, the current incomplete order for profile is selected
-
note:
string
the requester note supplied with the quote request
-
payments:
array payments
List of payments
-
profileId(required):
string
Profile id.
-
requestChannel:
string
request Channel name. Possible values are 'agent' or 'asa'.
-
shippingAddress:
object shippingAddress
The shipping address details. If not supplied, it utilizes the shipping address in the current incomplete order.
-
shippingGroups:
array shippingGroups
The shipping groups for the order. If not supplied, it utilizes the shipping groups in the current incomplete order.
-
shippingMethod:
object shippingMethod
The shipping method details for the order. If not supplied, it utilizes the shipping method in the current incomplete order.
-
shoppingCart:
object shoppingCart
The shopping cart contents of the current order. If not supplied, it utilizes the items in the current incomplete order.
-
submissionErrorCodes:
array submissionErrorCodes
Set of error codes recorded during each unsuccessful retry of queued orders.
-
submissionErrorMessages:
array submissionErrorMessages
List of failure reasons recorded during each unsuccessful retry of queued orders.
-
submissionProgress:
array submissionProgress
Checkpoints crossed successfully during each unsuccessful retry of queued orders.
Example:
{
"note":"Sample Quote",
"shippingGroups":[
{
"shippingMethod":{
"value":"standardShippingMethod"
},
"shippingAddress":{
"lastName":"Anderson",
"country":"United States",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"alias":"Home",
"faxNumber":"",
"middleName":"",
"state":"New York",
"selectedState":"NY",
"email":"kim@example.com",
"state_ISOCode":"US-NY"
},
"items":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"Product_18Cxi",
"externalData":[
],
"parentAssetKey":null,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"Sku_18Dxi",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
]
}
],
"appliedPromotions":[
],
"profileId":"se-570031",
"payments":[
{
"cardCVV":"service",
"amount":"43.19",
"cardType":"",
"type":"card",
"cardNumber":"service"
}
],
"amountRemaining":"43.19",
"shoppingCart":{
"coupons":[
],
"items":[
{
"quantity":1,
"productId":"Product_18Cxi",
"catRefId":"Sku_18Dxi"
}
],
"orderTotal":43.19
},
"id":"o90419",
"billingAddress":{
"lastName":"Anderson",
"country":"United States",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"alias":"Home",
"faxNumber":"",
"middleName":"",
"state":"New York",
"selectedState":"NY",
"email":"kim@example.com",
"state_ISOCode":"US-NY"
},
"requestChannel":"agent"
}Nested Schema : appliedPromotions
Type:
arrayThe array of applied promotions. If not supplied, it utilizes the promotions in the current incomplete order.
Show Source
Nested Schema : billingAddress
Type:
objectBilling address for the order.
Show Source
-
address1(required):
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city(required):
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country(required):
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName(required):
string
First name for this billing address.
-
isDefaultAddress:
boolean
Is the Address is used as default address or not.
-
jobTitle:
string
Job title for this billing address.
-
lastName(required):
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode(required):
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state(required):
string
State for this billing address.
-
state_ISOCode:
string
The state ISO code of the shipping address.
-
suffix:
string
Suffix for this billing address.
Nested Schema : shippingAddress
Type:
objectThe shipping address details. If not supplied, it utilizes the shipping address in the current incomplete order.
Show Source
-
address1(required):
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias:
string
Address alias.
-
city(required):
string
City.
-
companyName:
string
Company name.
-
country(required):
string
Country.
-
county:
string
County.
-
email(required):
string
Email address.
-
faxNumber:
string
Fax number.
-
firstName(required):
string
First name.
-
isDefaultAddress:
boolean
Is the Address is used as default address or not.
-
jobTitle:
string
Job title.
-
lastName(required):
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode(required):
string
Postal code.
-
prefix:
string
Name prefix.
-
selectedCountry(required):
string
Country code.
-
selectedState(required):
string
State code.
-
state(required):
string
State.
-
state_ISOCode(required):
string
State ISO code.
-
suffix:
string
Name suffix.
Nested Schema : shippingGroups
Type:
arrayThe shipping groups for the order. If not supplied, it utilizes the shipping groups in the current incomplete order.
Show Source
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order. If not supplied, it utilizes the shipping method in the current incomplete order.
Show Source
-
value(required):
string
The shipping method applied to the order.
Nested Schema : shoppingCart
Type:
objectThe shopping cart contents of the current order. If not supplied, it utilizes the items in the current incomplete order.
Show Source
-
coupons:
array coupons
The array of coupons applied to the order.
-
items(required):
array items
The array of products in the shopping cart.
-
orderTotal:
number
The total price of the order.
Nested Schema : submissionErrorCodes
Type:
arraySet of error codes recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionErrorMessages
Type:
arrayList of failure reasons recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionProgress
Type:
arrayCheckpoints crossed successfully during each unsuccessful retry of queued orders.
Show Source
Nested Schema : items
Type:
Show Source
object-
cardCVV(required):
string
credit card CVV.
-
cardNumber(required):
string
credit card number.
-
cardType(required):
string
credit card type.
-
endMonth(required):
string
credit card expiry month.
-
endYear(required):
integer
credit card expiry year.
-
giftCardNumber:
string
Gift card number used for payment. Payment type: physicalGiftCard(this field should be used when giftcards are used)
-
giftCardPin:
string
Gift card pin. Payment type: physicalGiftCard(this field should be used when giftcards are used)
-
nameOnCard(required):
string
name printed on credit card.
-
paymentGroupId:
string
Payment Group Id of the gift card payment group. Payment type: physicalGiftCard
-
PONumber:
string
Purchase order number for invoice payment. Payment type: invoice
-
type(required):
string
payment type. payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard
Nested Schema : items
Type:
Show Source
object-
email:
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName:
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items(required):
array items
The array of products in the shipping group.
-
lastName:
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName:
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber:
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
shippingAddress(required):
object shippingAddress
The shipping address details.
-
shippingMethod(required):
object shippingMethod
The shipping method details for the order.
-
store:
object store
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
type:
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1(required):
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias:
string
Address alias.
-
city(required):
string
City.
-
companyName:
string
Company name.
-
country(required):
string
Country.
-
county:
string
County.
-
email(required):
string
Email address.
-
faxNumber:
string
Fax number.
-
firstName(required):
string
First name.
-
jobTitle:
string
Job title.
-
lastName(required):
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode(required):
string
Postal code.
-
prefix:
string
Name prefix.
-
selectedCountry(required):
string
Country code.
-
selectedState(required):
string
State code.
-
state(required):
string
State.
-
state_ISOCode(required):
string
State ISO code.
-
suffix:
string
Name suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
Show Source
-
value(required):
string
The shipping method applied to the order.
Nested Schema : store
Type:
objectInformation about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1:
string
Address line 1 of the store.
-
address2:
string
Address line 2 of the store.
-
address3:
string
Address line 3 of the store.
-
city:
string
The city in which the store resides.
-
country:
string
The country in which the store resides.
-
county:
string
The county in which the store resides.
-
email:
string
The email address of the store.
-
faxNumber:
string
The fax number of the store.
-
hours:
string
The opening hours of the store.
-
locationId:
string
The location id of the store.
-
name:
string
Name of the store.
-
phoneNumber:
string
The phone number of the store.
-
postalCode:
string
The postal code of the store.
-
stateAddress:
string
The state in which the store resides.
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
availablePickupDate:
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId(required):
string
The category to which the product belongs.
-
configuratorId:
string
Configuration id of the configurable product
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
preferredPickupDate:
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
productId(required):
string
ID of the product in the cart.
-
quantity(required):
integer
The quantity of the product in this shipping group.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
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-
code(required):
string
The coupon code.
-
description:
string
The coupon description.
-
id(required):
string
The coupon id.
-
level(required):
string
The level of the coupon (whether the coupon is item level, etc).
-
status(required):
string
The current status of the coupon.
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId(required):
string
The category to which the product belongs.
-
childItems:
array childItems
Child items of the commerce item
-
configuratorId:
string
Configuration id of the configurable product
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice:
number
A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
-
externalPriceQuantity:
integer
The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
-
giftWithPurchaseSelections:
array giftWithPurchaseSelections
The array of gift with purchase selections to be made.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(required):
string
ID of the product in the cart.
-
quantity(required):
integer
The quantity of the product in the cart.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseSelections
Type:
arrayThe array of gift with purchase selections to be made.
Show Source
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the sub commerce item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId(required):
string
Sku Id of the child item
-
childItems:
array childItems
Child items of the commerce item
-
commerceItemId:
string
commerce item id of the child item
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this sub commerce item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this sub commerce item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(required):
string
Product Id of the child item
-
quantity(required):
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId(required):
string
Sku Id of the child item
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(required):
string
Product Id of the child item
-
quantity(required):
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
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-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
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-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
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-
catRefId:
string
The product variant Id. Include this Id when you are wishing to mark this as a gift with purchase selection you wish to change out
-
giftWithPurchaseIdentifier(required):
integer
The identifier that links this gift with purchase to the giftWithPurchaseInfo.
-
giftWithPurchaseQuantity(required):
integer
The total quantity of the commerceItem that is giftWithPurchaseQuantity.
-
productId:
string
ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out
-
promotionId(required):
string
The promotion id.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : requestQuote_response
Type:
Show Source
object-
allowAlternateCurrency:
boolean
A site level setting which enables the shopper to split the payment amount in points and monetary currency, irrespective of the order level price list group.
-
approvalSystemMessages:
array approvalSystemMessages
The array of messages which are stored during order processing
-
creationDate:
string
The creation date in ISO format.
-
creationSiteId:
string
The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
-
creationTime:
number
The creation time in long seconds.
-
discountInfo:
object discountInfo
The discount information.
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
exchangeRate:
number
The coversion rate used to convert values from primary currency to secondary currency. Primary currency refers to to currency code associated with the order level price list group.
-
giftWithPurchaseCommerceItemMarkers:
array giftWithPurchaseCommerceItemMarkers
The array of giftWithPurchaseCommerceItemMarkers.
-
giftWithPurchaseOrderMarkers:
array giftWithPurchaseOrderMarkers
gift with purchase order marker information
-
id:
string
The order ID.
-
lastModifiedDate:
string
The order recent modified date in ISO format.
-
markers:
array markers
Order markers
-
orderAction:
string
The action performed on the order
-
orderComments:
array orderComments
The list of all logged comments for the order.
-
paymentGroups:
array paymentGroups
List of payment Groups for the order.
-
payShippingInSecondaryCurrency:
boolean
secondary currency code in mix currency flow
-
payTaxInSecondaryCurrency:
boolean
it is flag to enable loyalty point with monetary currency payment
-
priceInfo:
object priceInfo
The price information.
-
priceListGroup:
object priceListGroup
The price list group object.
-
pricingMessages:
object pricingMessages
The Pricing messages information.
-
profile:
object profile
Profile Information for the order.
-
quoteInfo:
object quoteInfo
the quote information of the order
-
returnRequests:
array returnRequests
The list of the requests raised for the order.
-
secondaryCurrencyCode:
string
The currency code of secondary currency associated with the site.
-
shippingAddress:
object shippingAddress
The shipping address details.
-
shippingGroups:
array shippingGroups
The shipping groups for the order.
-
shippingMethod:
object shippingMethod
The shipping method details for the order.
-
shoppingCart:
object shoppingCart
The shopping cart contents of the current order.
-
siteId:
string
The ID of the site on which the order was placed.
-
state:
string
the state of the order
-
stateDetailsAsUser:
string
Order State description for this order.Incorporates changes made by merchant from admin UI, if any.
-
stateString:
string
Order state as key string.
-
taxPriceInfo:
object taxPriceInfo
tax price information for the order
Nested Schema : approvalSystemMessages
Type:
arrayThe array of messages which are stored during order processing
Show Source
Nested Schema : discountInfo
Type:
objectThe discount information.
Show Source
-
orderDiscount:
number
The order discount.
-
orderDiscountDescList:
array orderDiscountDescList
The list of all the order discounts.
-
secondaryCurrencyShippingDiscount:
number
The shipping discount in secondary currency in case of mix currency scenario.
-
shippingDiscount:
number
The shipping discount.
Nested Schema : dynamicProperties
Type:
arrayRead-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
arrayThe array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
arraygift with purchase order marker information
Show Source
Nested Schema : orderComments
Type:
arrayThe list of all logged comments for the order.
Show Source
Nested Schema : priceInfo
Type:
objectThe price information.
Show Source
-
amount:
number
The total order amount.
-
currencyCode:
string
The currency code.
-
primaryCurrencyTotal:
number
The current total in loyalty points in case of multi currency
-
secondaryCurrencyShippingAmount:
number
The current total shipping amount in monetary currency
-
secondaryCurrencyShippingSurchargeValue:
number
Extra handling costs for shipping the products in monetary currency.
-
secondaryCurrencyTaxAmount:
number
The current total tax amount in monetary currency
-
secondaryCurrencyTotal:
number
The current total (sum ofshipping and tax)amount in monetary currency
-
shipping:
number
The total shipping cost.
-
shippingSurchargeValue:
number
Extra handling costs for shipping the products.
-
subTotal:
number
Sub-total.
-
tax:
number
The total tax amount.
-
total:
number
The order total.
Nested Schema : priceListGroup
Type:
objectThe price list group object.
Show Source
-
repositoryId:
string
Repository ID of the price list group.
Nested Schema : pricingMessages
Type:
objectThe Pricing messages information.
Show Source
-
GiftWithPurchaseMessages:
array GiftWithPurchaseMessages
The GWP messages information.
Nested Schema : profile
Type:
objectProfile Information for the order.
Show Source
-
email:
string
Email Address corresponding to the profile.
-
firstName:
string
First name of profile.
-
lastName:
string
Last name of profile.
-
middleName:
string
Middle name of profile.
-
organization:
object organization
The Organization associated with the B2B customer profile.
Nested Schema : quoteInfo
Type:
objectthe quote information of the order
Show Source
-
errorInfo:
array errorInfo
the array of errors, if any
-
expirationDate:
string
the expiration date of the quoted order, if any
-
externalId:
string
the external id for the quote
-
notes:
array notes
the notes (history) for the order
-
providerNote:
string
the provider note for the quoted order
-
quoteDate:
number
the date the order was quoted in milliseconds
-
rejectionDate:
string
rejection date of the quoted order
-
rejectionNote:
string
the rejection note for an order whose quote has been rejected by user
-
requestDate:
string
the date when the quote was requested in ISO format
Nested Schema : returnRequests
Type:
arrayThe list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1:
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias:
string
Address alias.
-
city:
string
City.
-
companyName:
string
Company name.
-
country:
string
Country.
-
county:
string
County.
-
email:
string
Email address.
-
faxNumber:
string
Fax number.
-
firstName:
string
First name
-
jobTitle:
string
Job title.
-
lastName:
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix:
string
Name prefix.
-
selectedCountry:
string
Country code.
-
selectedState:
string
State code.
-
state:
string
State.
-
state_ISOCode:
string
State ISO code.
-
suffix:
string
Name suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
Show Source
-
cost:
number
The total cost of shipping.
-
secondaryCurrencyShippingAmount:
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount:
string
tax amount in secondary currency.
-
value:
string
The shipping method applied to the order.
Nested Schema : shoppingCart
Type:
objectThe shopping cart contents of the current order.
Show Source
-
items:
array items
The array of products in the shopping cart.
Nested Schema : taxPriceInfo
Type:
objecttax price information for the order
Show Source
-
amount:
number
amount
-
cityTax:
number
city tax
-
countryTax:
number
country tax
-
countyTax:
number
county tax
-
districtTax:
number
district tax
-
isTaxIncluded:
boolean
if tax is included in the price
-
miscTax:
number
miscellaneous tax
-
secondaryCurrencyTaxAmount:
number
The monetary total amount of tax.
-
stateTax:
number
state tax
-
valueAddedTax:
number
value added tax
Nested Schema : items
Type:
Show Source
object-
coupon:
string
The coupon code.
-
promotionDesc:
string
The promotion description.
-
promotionId:
string
The promotion ID.
-
promotionLevel:
string
The promotion level.
Nested Schema : items
Type:
Show Source
object-
id:
string
The ID of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
automaticQuantity:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data:
integer
The gift hash code for this GWP promotion.
-
key:
string
atg.gwp
-
remainingQuantity:
number
The quantity of the commerce item that is not affected by GWP.
-
repositoryId:
string
The repository id
-
selectedQuantity:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value:
string
The GWP promotion id.
Nested Schema : items
Type:
Show Source
object-
automaticQuantity:
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data:
integer
Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity:
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
-
giftDetail:
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType:
string
The type of the gift. (sku, product)
-
key:
string
atg.gwp
-
quantity:
number
The total quantity of sku for this gift selection.
-
removedQuantity:
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity:
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity:
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value:
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object-
key:
string
Order marker key. In a marketing campaign marker, key signifies that it is a campaign marker and it also identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
-
value:
string
Order marker value. In a marketing campaign marker, value holds the marketing system's unique campaign ID.
Nested Schema : items
Type:
Show Source
object-
comment:
string
The comment string.
-
creationDate:
string
Date on which the comment was created.
-
repositoryId:
string
The repository id of the comment record.
Nested Schema : items
Type:
Show Source
object-
amount:
number
The amount associated with this Payment Group.
-
amountAuthorized:
number
The amount authorized with this Payment Group.
-
billingAddress:
object billingAddress
Billing address for the order.
-
cardNumber:
string
The masked credit card number.
-
cardType:
string
Payment method. e.g. physicalGiftCard/ creditCard
-
firstName:
string
First name associated with this Payment Group.
-
lastName:
string
Last name associated with this Payment Group.
-
paidAmount:
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId:
integer
Id of this payment Group.
-
paymentState:
string
The Payment Group state.
-
paymentStateDetailsAsUser:
string
The payment state description as string.
-
PONumber:
string
Purchase order number for invoice payment. Payment type: invoice
-
refundAmount:
number
The amount that has been credited to-date for this Payment Group.
-
token:
string
Token associated with this Payment Group.
-
totalDue:
number
The current working total order price including all discounts, tax, and billing costs.
-
type(required):
string
payment type. payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
-
zero_value_auto_authorized:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : billingAddress
Type:
objectBilling address for the order.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this billing address.
-
state_ISOCode:
string
The state ISON code of the shipping address.
-
suffix:
string
Suffix for this billing address.
Nested Schema : items
Type:
Show Source
object-
identifier:
string
The pricing message identifier.
-
params:
array params
The list of all message parameters.
-
priority:
integer
The pricing message priority.
-
summary:
string
The pricing message summary.
-
type:
string
The pricing message type.
Nested Schema : organization
Type:
objectThe Organization associated with the B2B customer profile.
Show Source
-
id:
string
The id of the organization.
-
name:
string
The name of of the organization.
Nested Schema : items
Type:
Show Source
object-
profileId:
string
the profile id of the user
-
profileType:
string
the profile type of the user that requested the quote
-
requestDate/quoteDate/rejectionDate:
number
the request/quote/rejection date for the note
-
requesterNote/providerNote/rejectionNote:
string
the requester/provider/rejection note
Nested Schema : items
Type:
Show Source
object-
createdDate:
string
The creation date of the return request.
-
returnRequestId:
string
The return request id.
-
state:
string
The status of the return request.
-
stateKey:
string
State key for return request which is not localized
-
totalRefund:
number
The total amount to be refunded on return.
-
totalReturnQuantity:
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
Show Source
object-
email:
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName:
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items:
array items
The array of products in the shipping group.
-
lastName:
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName:
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber:
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
priceInfo:
object priceInfo
The price information.
-
shippingAddress:
object shippingAddress
The shipping address details.
-
shippingMethod:
object shippingMethod
The shipping method details for the order.
-
status:
string
The shipping status.
-
store:
object store
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
surcharge:
number
The shipping surcharge.
-
trackingNumber:
string
The shipping tracking number
-
type:
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
Nested Schema : priceInfo
Type:
objectThe price information.
Show Source
-
amount:
number
The total order amount.
-
currencyCode:
string
The currency code.
-
primaryCurrencyTotal:
number
The current total in loyalty points in case of mix currency
-
secondaryCurrencyShippingAmount:
number
The current total shipping amount in monetary currency
-
secondaryCurrencyShippingSurchargeValue:
number
Extra handling costs for shipping the products in monetary currency.
-
secondaryCurrencyTaxAmount:
number
The current total tax amount in monetary currency
-
secondaryCurrencyTotal:
number
The current total (sum ofshipping and tax)amount in monetary currency
-
shipping:
number
The total shipping cost.
-
shippingSurchargeValue:
number
Extra handling costs for shipping the products.
-
subTotal:
number
Sub-total.
-
tax:
number
The total tax amount.
-
total:
number
The order total.
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1:
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias :
string
Address alias.
-
city:
string
City.
-
companyName:
string
Company name.
-
country:
string
Country.
-
county:
string
County.
-
email:
string
Email address.
-
faxNumber:
string
Fax number.
-
firstName:
string
First name
-
jobTitle:
string
Job title.
-
lastName:
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix:
string
Name prefix.
-
selectedCountry:
string
Country code.
-
selectedState:
string
State code.
-
state:
string
State.
-
state_ISOCode:
string
State ISO code.
-
suffix:
string
Name suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
Show Source
-
cost:
number
The total cost of shipping.
-
secondaryCurrencyShippingAmount:
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount:
string
tax amount in secondary currency.
-
shippingMethodDescription:
string
The description of the shipping method.
-
shippingTax:
number
The shipping tax.
-
value:
string
The shipping method applied to the order.
Nested Schema : store
Type:
objectInformation about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1:
string
Address line 1 of the store.
-
address2:
string
Address line 2 of the store.
-
address3:
string
Address line 3 of the store.
-
city:
string
The city in which the store resides.
-
country:
string
The country in which the store resides.
-
county:
string
The county in which the store resides.
-
email:
string
The email address of the store.
-
faxNumber:
string
The fax number of the store.
-
hours:
string
The opening hours of the store.
-
locationId:
string
The location id of the store.
-
name:
string
Name of the store.
-
phoneNumber:
string
The phone number of the store.
-
postalCode:
string
The postal code of the store.
-
stateAddress:
string
The state in which the store resides.
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
active:
boolean
active or not.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
availablePickupDate:
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
The category to which the product belongs.
-
childItems:
array childItems
Child items of the commerce item
-
configuratorId:
string
configurator id of the configurable product
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
discountInfo:
array discountInfo
The discount information.
-
displayName:
string
The name of the product.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice:
number
The Price of the product as per the external pricing system.
-
externalPriceQuantity:
integer
Quantity of the product, the customer is allowed to buy at the external price.
-
inventoryLocationId:
string
Defines the inventory location that services the referenced commerce item.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
pointOfNoRevision:
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preferredPickupDate:
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
price:
integer
The actual price of the product.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product.
-
rawTotalPrice:
integer
The raw price of the product.
-
relationshipType:
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice:
integer
The unit price of the product.
-
variant:
array variant
List of variants for the product.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
Sku Id of the child item
-
childItems:
array childItems
Child items of the commerce item
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
displayName:
string
Display name of the child product
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route:
string
Image route
-
selectedOptions:
array selectedOptions
The array of variants of the child item.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the sub commerce item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
Sku Id of the child item
-
commerceItemId:
string
commerce item id of the child item
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this sub commerce item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this sub commerce item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
displayName:
string
Display name of the child product
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route:
string
Image route
-
selectedOptions:
array selectedOptions
The array of variants of the child item.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
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:
string
The variant option name.
-
optionValue:
string
The variant option value
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
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:
string
The variant option name.
-
optionValue:
string
The variant option value
Nested Schema : items
Type:
Show Source
object-
coupon:
string
The coupon ID.
-
promotionDesc:
string
The promotion description.
-
promotionId:
string
The promotion ID.
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
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:
string
The variant option name.
-
optionValue:
string
The variant option value.
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
The category to which the product belongs.
-
childItems:
array childItems
Child items of the commerce item
-
configuratorId:
string
configurator id of the configurable product
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
discountInfo:
array discountInfo
The discount information.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice:
number
A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
-
externalPriceQuantity:
integer
The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
-
originalCommerceItemId:
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
price:
integer
The actual price of the product.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product.
-
rawTotalPrice:
integer
The raw price of the product.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shippingSurchargeValue:
integer
The extra handling cost for shipping the product.
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice:
integer
The unit price of the product.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the sub commerce item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
Sku Id of the child item
-
childItems:
array childItems
Child items of the commerce item
-
commerceItemId:
string
commerce item id of the child item
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this sub commerce item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this sub commerce item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
displayName:
string
Display name of the child product
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route:
string
Image route
-
selectedOptions:
array selectedOptions
The array of variants of the child item.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
Sku Id of the child item
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
displayName:
string
Display name of the child product
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route:
string
Image route
-
selectedOptions:
array selectedOptions
The array of variants of the child item.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
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:
string
The variant option name.
-
optionValue:
string
The variant option value
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
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:
string
The variant option name.
-
optionValue:
string
The variant option value
Nested Schema : items
Type:
Show Source
object-
coupon:
string
The coupon ID.
-
promotionDesc:
string
The promotion description.
-
promotionId:
string
The promotion ID.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
number
Total adjustment by the promotion.
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Example Response (application/json)
{
"creationTime":"1478607046000",
"orderComments":[
],
"sourceSystem":"Cloud Commerce",
"dynamicProperties":[
],
"stateString":"PENDING_QUOTE",
"paymentGroups":[
],
"priceInfo":{
"amount":1858.99,
"total":2045.51,
"shipping":35,
"shippingSurchargeValue":0,
"tax":151.52,
"subTotal":1858.99,
"currencyCode":"USD",
"totalWithoutTax":1893.99
},
"submissionProgress":[
],
"pricingMessages":{
},
"shoppingCart":{
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":1858.99,
"returnedQuantity":0,
"displayName":"Dr. Dolittle",
"shippingSurchargeValue":0,
"externalData":[
],
"billingProfileId":"billingProfile-123",
"discountAmount":0,
"billingAccountId":"billingAcc-123",
"imageInfo":{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100"
},
"assetKey":"12345",
"externalPrice":922,
"price":1858.99,
"variant":[
],
"onSale":false,
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"Added to order",
"serviceAccountId":"serviceAcc-123",
"unitPrice":14.99,
"quantity":3,
"productId":"Product_18Cxi",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":1844,
"quantity":2,
"tax":147.52,
"orderDiscountShare":0,
"detailedUnitPrice":922,
"currencyCode":"USD"
},
{
"discounted":false,
"amount":14.99,
"quantity":1,
"tax":1.2,
"orderDiscountShare":0,
"detailedUnitPrice":14.99,
"currencyCode":"USD"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"parentAssetKey":null,
"originalCommerceItemId":"o30417",
"tax":147.52,
"rootAssetKey":null,
"externalPriceQuantity":2,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"Sku_18Dxi",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"siteId":"siteUS",
"stateDescription":"INITIAL",
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"listPrice":14.99,
"status":0
}
]
},
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/orders/quote"
}
],
"id":"o90412",
"state":4004,
"quoteInfo":{
"providerNote":null,
"notes":[
{
"profileType":null,
"profileId":"se-570031",
"requestDate":"2016-11-08T12:48:11.481Z",
"requesterNote":"hi"
}
],
"rejectionDate":null,
"requestDate":"2016-11-08T12:48:11.481Z",
"errorInfo":null,
"externalId":null,
"rejectionNote":null,
"quoteDate":null,
"expirationDate":null
},
"stateDetailsAsUser":"This quote is pending",
"taxPriceInfo":{
"cityTax":0,
"amount":151.52,
"valueAddedTax":0,
"countyTax":75.76,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":75.76,
"countryTax":0
},
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":0,
"amount":151.52,
"valueAddedTax":0,
"countyTax":75.76,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":75.76,
"countryTax":0
},
"shippingMethod":{
"shippingTax":2.8,
"cost":35,
"displayName":"Standard",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"shippingGroupId":"sg100412",
"submittedDate":null,
"priceInfo":{
"amount":1858.99,
"total":2045.51,
"shipping":35,
"shippingSurchargeValue":0,
"tax":151.52,
"subTotal":1858.99,
"currencyCode":"USD",
"totalWithoutTax":1893.99
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"locationId":"SiteUS-GlenAllen187",
"siteId":"siteUS",
"shippingAddress":{
"lastName":"Anderson",
"country":"US",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"stateName":"New York",
"faxNumber":"",
"alias":"Home",
"middleName":"",
"state":"NY",
"countryName":"United States",
"email":"kim@example.com",
"selectedState":"NY",
"state_ISOCode":"US-NY"
},
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100",
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":44.97,
"returnedQuantity":0,
"displayName":"Dr. Dolittle",
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"externalPrice":922,
"price":1858.99,
"variant":[
],
"onSale":false,
"primaryImageAltText":"Dr. Dolittle",
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"serviceAccountId":"serviceAcc-123",
"unitPrice":14.99,
"primaryImageTitle":"Dr. Dolittle",
"quantity":3,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"productId":"Product_18Cxi",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":1844,
"quantity":2,
"tax":147.52,
"orderDiscountShare":0,
"detailedUnitPrice":922,
"currencyCode":"USD"
},
{
"discounted":false,
"amount":14.99,
"quantity":1,
"tax":1.2,
"orderDiscountShare":0,
"detailedUnitPrice":14.99,
"currencyCode":"USD"
}
],
"parentAssetKey":null,
"active":true,
"rootAssetKey":null,
"externalPriceQuantity":2,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"Sku_18Dxi",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/product/Product_18Cxi",
"siteId":"siteUS",
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"listPrice":14.99,
"status":"INITIAL"
}
],
"trackingNumber":null,
"status":"INITIAL"
}
],
"creationSiteId":"siteUS",
"approvalSystemMessages":[
"Order is pending approval because total is greater than the approved order limit."
],
"shippingMethod":{
"shippingTax":2.8,
"cost":35,
"displayName":"Standard",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"profile":{
"firstName":"Kim",
"lastName":"Anderson",
"middleName":null,
"email":"kim@example.com"
},
"priceListGroup":{
"repositoryId":"defaultPriceGroup"
},
"returnRequests":[
],
"creationDate":"2016-11-08T12:10:46.000Z",
"OrderAction":"order",
"submissionErrorCodes":[
],
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"submissionErrorMessages":[
],
"profileId":"se-570031",
"exchangeRequests":[
],
"giftWithPurchaseInfo":[
],
"siteId":"siteUS",
"shippingAddress":{
"lastName":"Anderson",
"country":"US",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"stateName":"New York",
"faxNumber":"",
"alias":"Home",
"middleName":"",
"state":"NY",
"countryName":"United States",
"email":"kim@example.com",
"selectedState":"NY",
"state_ISOCode":"US-NY"
},
"markers":[
],
"giftWithPurchaseOrderMarkers":[
]
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100094|Organization passed in the header is currently inactive|
|100095|The order or return request does not belong to the current organization of the shopper profile|
|100096|The organization associated to the order or return request was deleted / does not exist|
|100097|The organization associated to the order or return request is currently inactive|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|28107|If no order is found of the order id which is mentioned in request paylaod.|
|200106|No order data specified|
|200105|No Order id specified in request.|
|28315|Error occurred while updating the order.|
|200115|Error occurred at the time of pricing.|
|28364|Error occurred when quote is not allowed.|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|28365|Error occurred while requesting for quote|
|28300|Internal error while creating the order|
|100101|The shopper profile does not belong to organization passed in the header|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code