checkOrderApprovalWebhook

post

/ccadmin/v1/webhook/checkOrderApprovalWebhook

This event will be called if approval check from webhook is enabled from admin's approval setting page.

Request

Supported Media Types
Body ()
This event will be called if approval check from webhook is enabled from admin's approval setting page.
Root Schema : checkOrderApprovalWebhook_request
Type: object
This event will be called if approval check from webhook is enabled from admin's approval setting page.
Show Source
Nested Schema : request
Type: object
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
the value of the dynamic Properties
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
Show Source
Nested Schema : organization
Type: object
The organization related property object
Show Source
Nested Schema : priceInfo
Type: object
Show Source
Nested Schema : pricingMessages
Type: object
Nested Schema : profile
Type: object
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
Show Source
Nested Schema : shippingGroups
Type: array
Show Source
Nested Schema : shoppingCart
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: object
The list of all the coupons with the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
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 : abandonedOrders
Type: array
Show Source
Nested Schema : activePromotions
Type: array
Show Source
Nested Schema : allApprovers
Type: array
list of all the approvers
Show Source
Nested Schema : allSecondaryAddresses
Type: array
List of all shipping addresses associated with profile.
Show Source
Nested Schema : ancestors
Type: array
Show Source
Nested Schema : approvers
Type: array
Show Source
Nested Schema : comments
Type: array
Show Source
Nested Schema : contract
Type: object
Nested Schema : currentOrganization
Type: object
Show Source
Nested Schema : derivedBillingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : derivedCatalog
Type: object
Nested Schema : derivedPriceList
Type: object
Nested Schema : derivedPriceListGroup
Type: object
Nested Schema : derivedSalePriceList
Type: object
The derived sale price list from the user's parent organization
Show Source
Nested Schema : derivedShippingAddress
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : favoriteStores
Type: array
Show Source
Nested Schema : homeAddress
Type: object
Home address which is set on the profile
Show Source
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : parentOrganization
Type: object
This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated
Show Source
Nested Schema : priceList
Type: object
Nested Schema : priceListGroup
Type: object
The associated price list group for this user
Show Source
Nested Schema : purchaseLists
Type: array
Show Source
Nested Schema : roles
Type: array
List of user roles.
Show Source
Nested Schema : salePriceList
Type: object
Nested Schema : secondaryAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : secondaryOrganizations
Type: array
List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints
Show Source
Nested Schema : sessionOrganization
Type: object
Show Source
Nested Schema : shippingAddresses
Type: object
Default shipping address of the profile
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
The shipping surcharge price list for this user
Show Source
Nested Schema : siteProperties
Type: object
The site related properties for the profile
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: object
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
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Show Source
Nested Schema : secondaryAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : relativeTo
Type: object
organization ID of the role
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : secondaryAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : site
Type: object
The site data
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: object
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 : store
Type: object
The store is present in the request if the type is inStorePickupShippingGroup.
Show Source
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
Nested Schema : promotions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : promotionInfo
Type: array
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 : dynamicProperties
Type: array
List of dynamic properties at line item level.
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 : giftWithPurchaseDiscountInfo
Type: array
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
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: object
Show Source
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 : 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 : 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 : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
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 : couponCodes
Type: array
One or more coupon codes used to grant the order promotion providing the discount.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

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