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
Body ()
Root Schema : request
Type: object
Show Source
Nested Schema : order
Type: object
An OCC order
Show Source
Nested Schema : appliedPromotions
Type: array
Show Source
Nested Schema : payments
Type: array
List of payments.
Show Source
Nested Schema : shippingGroups
Type: array
Show Source
Nested Schema : shoppingCart
Type: object
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 : shippingAddress
Type: object
Show Source
Nested Schema : shippingMethod
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupons
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Additional properties to display in the Assisted Selling Application UI
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : payments
Type: array
Unique Items Required: true
Array of payments and their associated properties.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
Additional 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: array
Unique Items Required: true
List 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: object
Show Source
Nested Schema : options
Type: object
Additional 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"
        }
    ]
}
Back to Top