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
Body ()
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
Nested Schema : order
Type: object
Show Source
Nested Schema : orderQualificationOrganization
Type: object
Show Source
Nested Schema : profile
Type: object
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
Nested Schema : payments
Type: array
Show Source
Nested Schema : priceInfo
Type: object
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
Show Source
Nested Schema : shippingGroups
Type: array
Show Source
Nested Schema : shippingMethod
Type: object
Show Source
Nested Schema : shoppingCart
Type: object
Show Source
Nested Schema : taxPriceInfo
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Show Source
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: array
Whether this item is discounted.
Show Source
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: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The map values associated with an externalData item.
Show Source
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: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Show Source
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : allApprovers
Type: array
list of all the approvers
Show Source
Nested Schema : ancestorOrganizations
Type: array
List of ancestors for the Organization
Show Source
Nested Schema : approvers
Type: array
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
Nested Schema : childOrganizations
Type: array
Show Source
Nested Schema : contacts
Type: array
Show Source
Nested Schema : contract
Type: object
Contract
Show Source
Nested Schema : derivedBillingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : derivedContract
Type: object
Contract
Show Source
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
Nested Schema : siteOrganizationProperties
Type: object
Site Organization Properties
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : site
Type: object
Site information
Show Source
Nested Schema : contract
Type: object
Contract
Show Source
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : loyaltyPrograms
Type: array
Show Source
Nested Schema : sitePropertiesList
Type: array
The list of site related properties for the profile
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
The site related properties for the profile
Show Source
Nested Schema : site
Type: object
The site data
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : orderQualification_response
Type: object
Show Source
Nested Schema : error
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top