asaAdditionalProperties
post
/ccadmin/v1/webhook/asaAdditionalProperties
The WebHook that is triggered to retrieve additional properties for display in the Assisted Selling Application UI.
Request
Supported Media Types
- application/json
Root Schema : request
Type:
Show Source
object-
locale:
string
Locale of the requested additional properties.
-
order:
object order
An OCC order
-
priceGroup:
string
Price group info.
-
siteId:
string
Id of the curent site.
Nested Schema : order
Type:
objectAn OCC order
Show Source
-
appliedPromotions(optional):
array appliedPromotions
-
id(optional):
string
Internal OCC ID
-
op(optional):
string
The order operation being performed when used from ASA application. The value of this field is fetchPaymentCustomProperties when used to fetch additional properties of custom currency payment in swagger metadata call
-
orderId(optional):
string
The ID
-
payments(optional):
array payments
List of payments.
-
profileId(optional):
string
The ID of the shopper profile that owns the order.
-
shippingGroups(optional):
array shippingGroups
-
shoppingCart:
object shoppingCart
Nested Schema : shoppingCart
Type:
Show Source
object-
coupons(optional):
array coupons
-
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
-
orderTotal(optional):
number
The monetary total: amount + shipping + tax.
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
Amount to be paid using this paymentMethod.
-
cardCVV(optional):
string
Credit/Debit card secret pin. PaymentMethodType: card.
-
cardNumber(optional):
string
Credit/Debit card number used for payment. PaymentMethodType: card.
-
cardType(optional):
string
Credit/Debit card type. e.g. visa. PaymentMethodType: card.
-
cardTypeName(optional):
string
Credit/Debit card type name. e.g. Visa. Payment type:card.
-
endMonth(optional):
string
Credit/Debit card expiry month. PaymentMethodType: card.
-
endYear(optional):
string
Credit/Debit card expiry year. PaymentMethodType: card.
-
giftCardNumber(optional):
string
Gift card number.
-
giftCardPin(optional):
string
Gift card secret PIN.
-
nameOnCard(optional):
string
Name on the credit/debit card. PaymentMethodType: card.
-
PayerID(optional):
string
Payer ID relevant to paypal checkout type. PaymentMethodType: paypalCheckout.
-
PaymentGroupId(optional):
string
Payment Group ID relevant to the PaymentMethodType.
-
paymentId(optional):
string
Payment ID relevant to the PaymentMethodType. PaymentMethodType: paypalCheckout
-
PONumber(optional):
string
Purchase order number for invoice payment. Payment type: invoice
-
type:
string
Nested Schema : items
Type:
Show Source
object-
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
-
shippingAddress(optional):
object shippingAddress
-
shippingMethod(optional):
object shippingMethod
Nested Schema : shippingAddress
Type:
Show Source
object-
address1:
string
Address Line 1.
-
address2(optional):
string
Address Line 2.
-
address3(optional):
string
Address Line 3.
-
alias(optional):
string
-
city:
string
The city of the customer
-
country:
string
The country of the customer
-
email(optional):
string
The email of the customer
-
firstName(optional):
string
The first name of the customer
-
isDefaultAddress(optional):
boolean
-
lastName(optional):
string
The last name of customer
-
middleName(optional):
string
The middle name of the customer
-
phoneNumber(optional):
string
The phone number of the customer
-
postalCode:
string
The postal code
-
repositoryId(optional):
string
-
selectedCountry:
string
-
selectedState:
string
The state
-
state(optional):
string
The state
-
state_ISOCode(optional):
string
The state represented by ISO code
Nested Schema : items
Type:
Show Source
object-
catRefId:
string
catRefId of the product
-
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
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
Nested Schema : items
Type:
arrayThe 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-
code:
string
Code of the coupon applied.
-
description(optional):
string
Description of promotion
-
id(optional):
string
Id of the promotion
-
level(optional):
string
The promotion level.
-
status(optional):
string
Nested Schema : items
Type:
Show Source
object-
catRefId:
string
catRefId of the product
-
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
-
displayName(optional):
string
The product's display name.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
rawTotalPrice(optional):
number
The raw total price.
-
stockStatus(optional):
string
-
unitPrice(optional):
number
The detailed unit price: amount / quantity.
Response
Supported Media Types
- application/json
200 Response
Additional properties to display in the Assisted Selling Application UI
Root Schema : response
Type:
Show Source
object-
payments(optional):
array payments
Unique Items Required:
trueArray of payments and their associated properties.
Nested Schema : payments
Type:
arrayUnique Items Required:
trueArray of payments and their associated properties.
Show Source
Nested Schema : items
Type:
Show Source
object-
paymentMethod:
string
The payment method type such as card, physicalGiftCard etc
-
paymentMethodName:
string
Displayed name for the payment method
-
paymentType(optional):
string
Allowed Values:
[ "cash", "generic" ]If the paymentMethod is not a predefined type, then this property is used to provide context for what kind of payment is being described, either generic or cash. If omitted, generic is the assumed type. -
properties:
object properties
Additional Properties Allowed: CustomPropertyTypeA custom named property that represents an additional property associated with the parent payment type. Property name should match this regex: ^[a-zA-Z1-9]+$
-
summaryDisplayProperties(optional):
array summaryDisplayProperties
Unique Items Required:
trueList of properties whose values will be displayed against a payment on an order. If omitted, the payment method name will be used in lieu.
Nested Schema : properties
Type:
objectAdditional Properties Allowed
Show Source
A custom named property that represents an additional property associated with the parent payment type. Property name should match this regex: ^[a-zA-Z1-9]+$
Nested Schema : summaryDisplayProperties
Type:
arrayUnique Items Required:
trueList of properties whose values will be displayed against a payment on an order. If omitted, the payment method name will be used in lieu.
Show Source
Nested Schema : CustomPropertyType
Type:
Show Source
object-
default:
string
Default value for the property
- hidden(optional): boolean
-
label:
string
Displayed text used to describe the property
-
options(optional):
object options
Additional Properties Allowed: additionalPropertiesCollection of potential values for the property. Property name should match this regex: ^[a-zA-Z1-9]+$
-
required:
boolean
Whether a value is required
-
type:
string
Allowed Values:
[ "shortText", "richText", "date", "number", "checkbox" ]Type of the property -
uiEditorType:
string
Allowed Values:
[ "shortText", "richText", "date", "number", "checkbox", "list" ]The user interface type used to display / edit the property.
Nested Schema : options
Type:
objectAdditional Properties Allowed
Show Source
Collection of potential values for the property. Property name should match this regex: ^[a-zA-Z1-9]+$
Example Response (application/json)
{
"payments":[
{
"summaryDisplayProperties":[
"installmentOptions"
],
"paymentMethod":"subscription",
"paymentMethodName":"Pay in Installments",
"properties":{
"installmentOptions":{
"uiEditorType":"list",
"default":null,
"options":{
"option3":"5 payments of $60",
"option4":"20 payments of $16",
"option1":"2 payments of $150",
"option2":"10 payments of $31"
},
"label":"Installment Options",
"type":"shortText",
"required":true
},
"nationalIdentificationCode":{
"uiEditorType":"shortText",
"default":null,
"label":"National ID",
"type":"shortText",
"required":true
}
},
"paymentType":"generic"
},
{
"paymentMethod":"card",
"paymentMethodName":"Pay by card",
"properties":{
"nationalIdentificationCode":{
"uiEditorType":"shortText",
"default":null,
"label":"National ID",
"type":"shortText",
"required":true
}
}
},
{
"paymentMethod":"deferred",
"paymentMethodName":"Some kind of deferred payment",
"properties":{
"CPF":{
"uiEditorType":"number",
"default":null,
"hidden":false,
"label":"Relevant number to enter",
"type":"number",
"required":true
}
},
"paymentType":"cash"
}
]
}