orderQualification
post
/ccadmin/v1/webhook/orderQualification
A webhook for preforming order qualification operations prior to the order being submitted. This webhook is fired during the order submit flow.
Request
Supported Media Types
- application/json
A webhook for preforming order qualification operations prior to the order being submitted. This webhook is fired during the order submit flow and will be executed after final order pricing has been performed.
Root Schema : orderQualification_request
Type:
object
A webhook for preforming order qualification operations prior to the order being submitted. This webhook is fired during the order submit flow and will be executed after final order pricing has been performed.
Show Source
-
operation(optional):
string
-
order(optional):
object order
-
organization(optional):
object orderQualificationOrganization
-
profile(optional):
object profile
Example:
{
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"customerContactId":"se-570031",
"receiveEmail":"no",
"currentOrganization":null,
"parentOrganization":null,
"locale":"en",
"email":"kim@example.com",
"sitePropertiesList":[
{
"site":{
"id":"siteUS"
},
"properties":{
"numberOfVisits":29,
"GDPRProfileP13nConsentDate":null,
"GDPRProfileP13nConsentGranted":false,
"receiveEmail":"no",
"receiveEmailDate":null
}
}
],
"daytimeTelephoneNumber":null
},
"order":{
"taxPriceInfo":{
"cityTax":0,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"valueAddedTax":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"countryTax":0
},
"shippingGroups":[
{
"shippingMethod":{
"secondaryCurrencyTaxAmount":0,
"shippingTax":0,
"cost":0,
"taxIncluded":true,
"taxCode":"",
"value":"groundShippingMethod",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg220413",
"shippingAddress":{
"lastName":"test",
"country":"US",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"test",
"phoneNumber":"212-555-1977",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"NY",
"email":"test@example.com"
},
"type":"hardgoodShippingGroup",
"items":[
{
"rawTotalPrice":0,
"returnedQuantity":0,
"shippingSurchargeValue":0,
"externalData":[
],
"discountAmount":0,
"preOrderQuantity":0,
"childItems":[
],
"configuratorId":"18225093",
"externalPrice":0,
"commerceItemId":"ci1493723487427",
"price":0,
"onSale":false,
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci21000413",
"unitPrice":0,
"assetable":false,
"amount":0,
"quantity":2,
"pointOfNoRevision":false,
"productId":"laptop",
"salePrice":0,
"externalRecurringCharge":50,
"externalPriceQuantity":-1,
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku50001",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"shopperInput":{
},
"asset":false,
"backOrderQuantity":0,
"listPrice":0,
"status":"INITIAL"
}
]
}
],
"creationTime":1.554728617709E12,
"orderId":"o210413",
"lastModifiedDate":"2019-04-08T13:03:37.709Z",
"shippingMethod":{
"shippingTax":0,
"cost":0,
"value":"groundShippingMethod"
},
"orderStatus":"Incomplete",
"cartName":"o210413",
"creationDate":"2019-04-08T13:03:37.709Z",
"orderProfileId":"se-570031",
"orderAction":"order",
"priceInfo":{
"amount":0,
"total":0,
"shipping":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":0,
"currencyCode":null,
"totalWithoutTax":0
},
"shoppingCart":{
"numberOfItems":2,
"items":[
{
"primaryThumbImageURL":"/img/no-image.jpg",
"rawTotalPrice":0,
"displayName":"Laptop",
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"description":"laptop",
"isItemValid":true,
"childItems":[
],
"configuratorId":"18225093",
"externalPrice":0,
"commerceItemId":"ci1493723487427",
"price":0,
"variant":[
],
"onSale":false,
"id":"ci21000413",
"state":"Added to order",
"stateKey":"INITIAL",
"unitPrice":0,
"assetable":false,
"amount":0,
"quantity":2,
"productId":"laptop",
"salePrice":0,
"detailedItemPriceInfo":[
],
"externalRecurringCharge":50,
"orderDiscountInfos":[
],
"giftWithPurchaseCommerceItemMarkers":[
],
"externalPriceQuantity":-1,
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku50001",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"shopperInput":{
},
"asset":false,
"listPrice":0
}
]
},
"siteId":"siteUS",
"shippingAddress":{
"lastName":"test",
"country":"US",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"test",
"phoneNumber":"212-555-1977",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"NY",
"email":"test@example.com"
}
}
}
Nested Schema : order
Type:
Show Source
object
-
assetable(optional):
string
A flag that denotes if the order contains one or more items that are assetable.
-
creationDate(optional):
string
-
creationTime(optional):
integer
-
discountInfo(optional):
object discountInfo
The discount information.
-
dynamicProperties(optional):
array dynamicProperties
List of dynamic properties at line item level.
-
lastModifiedDate(optional):
integer
-
orderId(optional):
string
-
orderProfileId(optional):
string
-
orderStatus(optional):
string
-
payments(optional):
array payments
-
priceInfo(optional):
object priceInfo
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shippingAddress(optional):
object shippingAddress
-
shippingGroups(optional):
array shippingGroups
-
shippingMethod(optional):
object shippingMethod
-
shoppingCart(optional):
object shoppingCart
-
siteId(optional):
string
-
taxPriceInfo(optional):
object taxPriceInfo
Nested Schema : orderQualificationOrganization
Type:
Show Source
object
-
active(optional):
boolean
Active status of an Organization. Should be true or false. By default the value is set to true
-
allApprovers(optional):
array allApprovers
list of all the approvers
-
ancestorOrganizations(optional):
array ancestorOrganizations
List of ancestors for the Organization
-
approvalRequired(optional):
boolean
Approval flag is required for the organization, by default it is set to false
-
approvers(optional):
array approvers
-
billingAddress(optional):
object billingAddress
The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
-
childOrganizations(optional):
array childOrganizations
-
contacts(optional):
array contacts
-
contract(optional):
object contract
Contract
-
customerType(optional):
string
Customer Type for Organization
-
delegateApprovalManagement(optional):
boolean
This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
-
derivedApprovalRequired(optional):
boolean
Approval flag is required for the organization, by default it is set to false
-
derivedBillingAddress(optional):
object derivedBillingAddress
Default billing address of the profile
-
derivedContract(optional):
object derivedContract
Contract
-
derivedCustomerType(optional):
string
Derived customer type of the Organization
-
derivedDunsNumber(optional):
string
Derived dunsNumber of the Organization
-
derivedShippingAddress(optional):
object derivedShippingAddress
The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.
-
derivedTaxReferenceNumber(optional):
string
Derived taxReferenceNumber of the Organization
-
derivedType(optional):
string
Derived type of the Organization
-
dunsNumber(optional):
string
DUNS Number for Organization. Should be 9 digit number
-
externalOrganizationId(optional):
string
External id of the organization.
-
id(optional):
string
Id of the Organization
-
name(optional):
string
The name for Organization
-
siteOrganizationProperties(optional):
object siteOrganizationProperties
Site Organization Properties
-
taxReferenceNumber(optional):
string
Tax Reference Number of the Organization
-
type(optional):
string
Type for Organization
-
useExternalApprovalWebhook(optional):
boolean
Flag to enable/disable Order Approval check from External Webhook
Nested Schema : profile
Type:
Show Source
object
-
customerContactId(optional):
string
The id property for the the customers contact record.
-
daytimeTelephoneNumber(optional):
string
The day time phone number of the profile
-
email(optional):
string
-
firstName(optional):
string
-
id(optional):
string
Id
-
lastName(optional):
string
-
locale(optional):
string
-
loyaltyPrograms(optional):
array loyaltyPrograms
-
middleName(optional):
string
-
receiveEmail(optional):
string
The string representation of whether the user wants to recieve email or not
-
sitePropertiesList(optional):
array sitePropertiesList
The list of site related properties for the profile
Nested Schema : discountInfo
Type:
object
The discount information.
Show Source
-
orderCouponsMap(optional):
array orderCouponsMap
The list of all the coupons with the order.
-
orderDiscount(optional):
integer
The order discount.
-
shippingDiscount(optional):
integer
The shipping discount.
Nested Schema : dynamicProperties
Type:
array
List of dynamic properties at line item level.
Show Source
Nested Schema : priceInfo
Type:
Show Source
object
-
amount(optional):
number
-
currencyCode(optional):
string
-
primaryCurrencyTotal(optional):
number
The primary currency total amount.
-
secondaryCurrencyShippingAmount(optional):
number
The secondary currency shipping amount.
-
secondaryCurrencyTaxAmount(optional):
number
The secondary currency tax amount.
-
secondaryCurrencyTotal(optional):
number
The secondary currency total amount.
-
shipping(optional):
number
-
shippingSurchargeValue(optional):
number
-
subTotal(optional):
number
-
tax(optional):
number
-
total(optional):
number
-
totalWithoutTax(optional):
number
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
Show Source
object
-
address1(optional):
string
-
address2(optional):
string
-
address3(optional):
string
-
city(optional):
string
-
companyName(optional):
string
-
country(optional):
string
-
county(optional):
string
-
email(optional):
string
-
faxNumber(optional):
integer
-
firstName(optional):
string
-
jobTitle(optional):
string
-
lastName(optional):
string
-
middleName(optional):
string
-
phoneNumber(optional):
integer
-
postalCode(optional):
string
-
prefix(optional):
string
-
state(optional):
string
-
suffix(optional):
string
Nested Schema : shoppingCart
Type:
Show Source
object
-
items(optional):
array items
The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
-
itemsIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present
-
numberOfItems(optional):
integer
Nested Schema : taxPriceInfo
Type:
Show Source
object
-
amount(optional):
number
-
cityTax(optional):
number
-
countryTax(optional):
number
-
countyTax(optional):
number
-
districtTax(optional):
number
-
isTaxIncluded(optional):
boolean
-
miscTax(optional):
number
-
secondaryCurrencyTaxAmount(optional):
number
tax amount in secondaryCurrency
-
stateTax(optional):
number
-
valueAddedTax(optional):
number
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
The promotion description.
-
promotionId(optional):
string
The promotion ID.
-
promotionLevel(optional):
string
The promotion level.
-
totalAdjustment(optional):
string
The total adjustment.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The dynamic property id.
-
label(optional):
string
The dynamic property label.
-
value(optional):
string
The dynamic property value.
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
integer
-
balance(optional):
number
-
gatewayName(optional):
string
-
giftCardNumber(optional):
integer
-
isAmountRemaining(optional):
boolean
-
maskedCardNumber(optional):
string
-
paymentGroupId(optional):
string
-
paymentMethod(optional):
string
-
paymentState(optional):
string
-
uiIntervention(optional):
string
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
discountInfo(optional):
array discountInfo
The discount information.
-
items(optional):
array items
-
itemsIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present
-
priceInfo(optional):
object priceInfo
The price information.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
taxPriceInfo(optional):
object taxPriceInfo
The shipping address details.
Nested Schema : priceInfo
Type:
object
The price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
lkpValExcludingFreeShip(optional):
number
The total shipping cost excluding items with free shipping.
-
secondaryCurrencyShippingAmount(optional):
number
The secondary currency shipping amount.
-
secondaryCurrencyTaxAmount(optional):
number
The secondary currency tax amount.
-
shipping(optional):
number
The total shipping cost.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products
-
subTotal(optional):
number
Sub-total.
-
tax(optional):
number
The total tax amount.
-
total(optional):
number
The order total.
-
totalWithoutTax(optional):
number
The total amount without tax.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
object
The shipping address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
cost(optional):
number
The total cost of shipping.
-
secondaryCurrencyShippingAmount(optional):
number
The secondary currency shipping amount.
-
secondaryCurrencyTaxAmount(optional):
number
The secondary currency tax amount.
-
shippingMethodDescription(optional):
string
-
shippingTax(optional):
number
-
taxCode(optional):
string
-
value(optional):
string
The shipping method applied to the order.
Nested Schema : taxPriceInfo
Type:
object
The shipping address details.
Show Source
-
amount(optional):
number
The total order amount.
-
cityTax(optional):
number
City Tax
-
countryTax(optional):
number
Country Tax.
-
countyTax(optional):
number
County Tax.
-
districtTax(optional):
number
District Tax.
-
isTaxIncluded(optional):
boolean
If Tax is included?
-
miscTax(optional):
number
Misc Tax.
-
secondaryCurrencyTaxAmount(optional):
number
taxAmount in secondaryCurrency
-
stateTax(optional):
number
State Tax.
-
valueAddedTax(optional):
number
Value Added Tax.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the third party system.
-
activationDate(optional):
string
The activation date in ISO format.
-
amount(optional):
number
The monetary amount.
-
asset(optional):
boolean
The flag that defines it the item is an asset or not.
-
assetable(optional):
string
Flag to denote that the item is a potential service.
-
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(date-time)
The availability date for preOrdered/backOrdered quantity.
-
backOrderQuantity(optional):
integer
The back ordered quantity included.
-
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
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
childItems(optional):
array childItems
-
childItemsIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present
-
commerceId(optional):
string
Commerce ID for this commerce item.
-
commerceItemId(optional):
string
Commerce Item ID for this commerce item.
-
configuratorId(optional):
string
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedItemPriceInfo(optional):
array detailedItemPriceInfo
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountAmount(optional):
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
-
discountInfo(optional):
array discountInfo
Whether this item is discounted.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a third party system.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
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):
integer
The pre ordered quantity included.
-
price(optional):
number
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The number of items covered by this price info
-
rawTotalPrice(optional):
number
The raw total price.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
salePrice(optional):
number
The sale price
-
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
Extra handling cost for shipping the product.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
stateDetailsAsUser(optional):
string
-
status(optional):
string
-
unitPrice(optional):
number
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the third party system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The map values associated with an externalData item.
Nested Schema : values
Type:
object
The map values associated with an externalData item.
Show Source
-
key(optional):
string
Map key defined by external system.
-
value(optional):
string
Map value defined by external system.
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : items
Type:
array
The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the third party system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that defines it the item is an asset or not.
-
assetable(optional):
string
-
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
-
childItems(optional):
array childItems
Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
-
childItemsIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present
-
configuratorId(optional):
string
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
description(optional):
string
-
detailedItemPriceInfo(optional):
array detailedItemPriceInfo
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountAmount(optional):
number
-
discountInfo(optional):
array discountInfo
The discount information.
-
displayName(optional):
string
-
dynamicProperties(optional):
array dynamicProperties
List of dynamic properties at line item level.
-
externalPrice(optional):
number
-
externalPriceQuantity(optional):
integer
-
externalRecurringCharge(optional):
number
-
externalRecurringChargeDuration(optional):
string
-
externalRecurringChargeFrequency(optional):
string
-
id(optional):
string
-
isItemValid(optional):
boolean
-
listPrice(optional):
number
-
onSale(optional):
boolean
-
orderDiscountInfos(optional):
array orderDiscountInfos
Array of order promotions affecting this 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
-
primaryThumbImageURL(optional):
string
-
productId(optional):
string
-
quantity(optional):
integer
-
rawTotalPrice(optional):
number
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
salePrice(optional):
number
-
secondaryCurrencyShippingSurcharge(optional):
integer
-
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):
integer
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
unitPrice(optional):
number
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : childItems
Type:
array
Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
array
List of dynamic properties at line item level.
Show Source
Nested Schema : orderDiscountInfos
Type:
array
Array of order promotions affecting this item.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The coupon ID.
-
promotionDesc(optional):
string
The promotion description.
-
promotionId(optional):
string
The promotion ID.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The dynamic property id.
-
label(optional):
string
The dynamic property label.
-
value(optional):
string
The dynamic property value.
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The amount of discount this item received from the promotion.
-
couponCodes(optional):
array couponCodes
One or more coupon codes used to grant the order promotion providing the discount.
-
promotionId(optional):
string
The promotion id that resulted in the discount.
Nested Schema : couponCodes
Type:
array
One or more coupon codes used to grant the order promotion providing the discount.
Show Source
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : ancestorOrganizations
Type:
array
List of ancestors for the Organization
Show Source
Nested Schema : billingAddress
Type:
object
The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of the address
-
country(optional):
string
the country of the address
-
phoneNumber(optional):
string
the phone Number of the address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
Nested Schema : contract
Type:
object
Contract
Show Source
-
catalog(optional):
object catalog
Catalog associated with contract
-
creationDate(optional):
string
Contract creation date time stamp
-
description(optional):
string
Description for contract
-
displayName(optional):
string
Name of the contract
-
endDate(optional):
string
Contract end date time stamp
-
externalContractReference(optional):
string
External contract reference
-
priceListGroup(optional):
object priceListGroup
Price ListGroup associated with contract
-
repositoryId(optional):
string
Repository Id of the contract
-
startDate(optional):
string
Contract start date time stamp
-
terms(optional):
object terms
Terms and Conditions
Nested Schema : derivedBillingAddress
Type:
object
Default billing address of the profile
Show Source
-
address1(optional):
string
the address1 of the billing address
-
address2(optional):
string
the address2 of the billing address
-
city(optional):
string
the city of the billing address
-
country(optional):
string
the country of the billing address
-
county(optional):
string
the county of the billing address
-
externalAddressId(optional):
string
External ID of the address
-
firstName(optional):
string
the first name of the billing address
-
lastName(optional):
string
the last name of the billing address
-
phoneNumber(optional):
string
the phone Number of the billing address
-
postalCode(optional):
string
the postal Code of the billing address
-
repositoryId(optional):
string
the id of the billing address
-
state(optional):
string
the state of the billing address
Nested Schema : derivedContract
Type:
object
Contract
Show Source
-
catalog(optional):
object catalog
Catalog associated with contract
-
creationDate(optional):
string
Contract creation date time stamp
-
description(optional):
string
Description for contract
-
displayName(optional):
string
Name of the contract
-
endDate(optional):
string
Contract end date time stamp
-
externalContractReference(optional):
string
External contract reference
-
priceListGroup(optional):
object priceListGroup
Price ListGroup associated with contract
-
repositoryId(optional):
string
Repository Id of the contract
-
startDate(optional):
string
Contract start date time stamp
-
terms(optional):
object terms
Terms and Conditions
Nested Schema : derivedShippingAddress
Type:
object
The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name shipping address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External ID of the address
-
phoneNumber(optional):
string
the phone Number of the company address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
Nested Schema : siteOrganizationProperties
Type:
object
Site Organization Properties
Show Source
-
site(optional):
object site
Site information
Nested Schema : items
Type:
Show Source
object
-
firstName(optional):
string
the first name of the approver
-
lastName(optional):
string
the last name of the apporver
-
middleName(optional):
string
the middle name of the approver
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Active flag of the organization.
-
id(optional):
string
Id of the organization.
-
name(optional):
string
Name of the organization.
-
repositoryId(optional):
string
Repository Id of the organization.
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
displayName(optional):
string
Name of the catalog
-
id(optional):
string
id of the catalog
-
status(optional):
string
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
repositoryId(optional):
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId(optional):
string
Repository Id of terms and conditions
-
terms(optional):
string
Terms and Conditions
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
displayName(optional):
string
Name of the catalog
-
id(optional):
string
id of the catalog
-
status(optional):
string
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
repositoryId(optional):
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId(optional):
string
Repository Id of terms and conditions
-
terms(optional):
string
Terms and Conditions
Nested Schema : site
Type:
object
Site information
Show Source
-
approvalRequired(optional):
boolean
Approval flag is required for the organization, by default it is set to false
-
contract(optional):
object contract
Contract
-
delegateApprovalManagement(optional):
boolean
This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
-
orderPriceLimit(optional):
number
Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
-
useExternalApprovalWebhook(optional):
boolean
Flag to enable/disable Order Approval check from External Webhook
Nested Schema : contract
Type:
object
Contract
Show Source
-
catalog(optional):
object catalog
Catalog associated with contract
-
creationDate(optional):
string
Contract creation date time stamp
-
description(optional):
string
Description for contract
-
displayName(optional):
string
Name of the contract
-
endDate(optional):
string
Contract end date time stamp
-
externalContractReference(optional):
string
External contract reference
-
priceListGroup(optional):
object priceListGroup
Price ListGroup associated with contract
-
repositoryId(optional):
string
Repository Id of the contract
-
startDate(optional):
string
Contract start date time stamp
-
terms(optional):
object terms
Terms and Conditions
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
displayName(optional):
string
Name of the catalog
-
id(optional):
string
id of the catalog
-
status(optional):
string
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
repositoryId(optional):
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId(optional):
string
Repository Id of terms and conditions
-
terms(optional):
string
Terms and Conditions
Nested Schema : sitePropertiesList
Type:
array
The list of site related properties for the profile
Show Source
Nested Schema : items
Type:
Show Source
object
-
membershipId(optional):
string
Membership id of user.
-
profileId(optional):
string
User profile id
-
programId(optional):
string
Program id of loyalty program
-
programName(optional):
string
Loyalty program name
-
status(optional):
string
status of Enrollment. It must be in any of 'RequestForEnrollment', 'Enrolled', 'RequestForUnenrollment', 'Unenrolled', 'Failed' states.
Nested Schema : items
Type:
Show Source
object
-
properties(optional):
object properties
The site related properties for the profile
-
site(optional):
object site
The site data
Nested Schema : properties
Type:
object
The site related properties for the profile
Show Source
-
GDPRProfileP13nConsentDate(optional):
string
The date on which GDPR personalization consent was granted by the user.
-
GDPRProfileP13nConsentGranted(optional):
boolean
If user has given consent for his/her profile information to be used for personalization purposes.
-
receiveEmail(optional):
string
Indicates whether the user should receive marketing emails on the current site. Can be yes or no.
-
receiveEmailDate(optional):
string
The date on which email marketing consent was granted by the user.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : orderQualification_response
Type:
Show Source
object
Example:
{
"errors":[
],
"responseCode":"74505"
}