REST API for Oracle Commerce Cloud December 2017

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

Body Parameter

Root Schema : request

Properties

locale: Type: string

Locale of the requested additional properties.
order: Type: object order

Additional Properties Allowed:

An OCC order
priceGroup: Type: string

Price group info.
siteId: Type: string

Id of the curent site.

Nested Schema : order

Type: object

An OCC order

Properties

appliedPromotions: Type: array appliedPromotions

Additional Properties Allowed:
id: Type: string

Internal OCC ID
op: Type: string

The order operation being performed.
orderId: Type: string

The ID
payments: Type: array payments

Additional Properties Allowed:

List of payments.
profileId: Type: string

The ID of the shopper profile that owns the order.
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:
shoppingCart: Type: object shoppingCart

Required: true

Additional Properties Allowed:

Nested Schema : appliedPromotions

Type: array

Items

Type: string

Nested Schema : payments

Type: array

List of payments.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shoppingCart

Type: object

Properties

coupons: Type: array coupons

Additional Properties Allowed:
items: Type: array items

Additional Properties Allowed:
orderTotal: Type: number

The monetary total: amount + shipping + tax.

Nested Schema : items

Type: object

Properties

amount: Type: number

Amount to be paid using this paymentMethod.
cardCVV: Type: string

Credit/Debit card secret pin. PaymentMethodType: card.
cardNumber: Type: string

Credit/Debit card number used for payment. PaymentMethodType: card.
cardType: Type: string

Credit/Debit card type. e.g. visa. PaymentMethodType: card.
cardTypeName: Type: string

Credit/Debit card type name. e.g. Visa. Payment type:card.
endMonth: Type: string

Credit/Debit card expiry month. PaymentMethodType: card.
endYear: Type: string

Credit/Debit card expiry year. PaymentMethodType: card.
giftCardNumber: Type: string

Gift card number.
giftCardPin: Type: string

Gift card secret PIN.
nameOnCard: Type: string

Name on the credit/debit card. PaymentMethodType: card.
PayerID: Type: string

Payer ID relevant to paypal checkout type. PaymentMethodType: paypalCheckout.
PaymentGroupId: Type: string

Payment Group ID relevant to the PaymentMethodType.
paymentId: Type: string

Payment ID relevant to the PaymentMethodType. PaymentMethodType: paypalCheckout
PONumber: Type: string

Purchase order number for invoice payment. Payment type: invoice
type: Type: string

Required: true

Nested Schema : items

Type: object

Properties

items: Type: array items

Additional Properties Allowed:
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

Nested Schema : items

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

Properties

address1: Type: string

Required: true

Address Line 1.
address2: Type: string

Address Line 2.
address3: Type: string

Address Line 3.
alias: Type: string
city: Type: string

Required: true

The city of the customer
country: Type: string

Required: true

The country of the customer
email: Type: string

Required: true

The email of the customer
firstName: Type: string

Required: true

The first name of the customer
isDefaultAddress: Type: boolean
lastName: Type: string

Required: true

The last name of customer
middleName: Type: string

The middle name of the customer
phoneNumber: Type: string

Required: true

The phone number of the customer
postalCode: Type: string

Required: true

The postal code
repositoryId: Type: string
selectedCountry: Type: string

Required: true
selectedState: Type: string

Required: true

The state
state: Type: string

Required: true

The state
state_ISOCode: Type: string

Required: true

The state represented by ISO code

Nested Schema : shippingMethod

Type: object

Properties

value: Type: string

Required: true

Selected shipping method

Nested Schema : items

Type: object

Properties

catRefId: Type: string

Required: true

catRefId of the product
productId: Type: string

Required: true

The ID of the product.
quantity: Type: integer

Required: true

The quantity included.

Nested Schema : coupons

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

code: Type: string

Required: true

Code of the coupon applied.
description: Type: string

Description of promotion
id: Type: string

Required: true

Id of the promotion
level: Type: string

Required: true

The promotion level.
status: Type: string

Required: true

Nested Schema : items

Type: object

Properties

catRefId: Type: string

Required: true

catRefId of the product
displayName: Type: string

The product's display name.
listPrice: Type: number

The monetary amount of the list price.
onSale: Type: boolean

Whether is on sale.
productId: Type: string

Required: true

The ID of the product.
quantity: Type: integer

Required: true

The quantity included.
rawTotalPrice: Type: number

The raw total price.
stockStatus: Type: string
unitPrice: Type: 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

Body

Root Schema : response

Properties

payments: Type: array payments

Additional Properties Allowed:

Unique Items Required: true

Array of payments and their associated properties.

Nested Schema : payments

Type: array

Unique Items Required: true

Array of payments and their associated properties.

Items

Type: object items

Additional Properties Allowed: false

Nested Schema : items

Type: object

Properties

paymentMethod: Type: string

Required: true

The payment method type such as card, physicalGiftCard etc
paymentMethodName: Type: string

Required: true

Displayed name for the payment method
properties: Type: object properties

Required: true

Additional Properties Allowed: false

A custom named property that represents an additional property associated with the parent payment type.
summaryDisplayProperties: Type: array summaryDisplayProperties

Additional Properties Allowed:

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.

Nested Schema : properties

Type: object

A custom named property that represents an additional property associated with the parent payment type.

Properties

Property name that matches this regex: ^[a-zA-Z1-9]+$: Type: object Property name that matches this regex: ^[a-zA-Z1-9]+$

Additional Properties Allowed: false

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.

Items

Type: string

Nested Schema : Property name that matches this regex: ^[a-zA-Z1-9]+$

Type: object

Properties

default: Type: string

Required: true

Default value for the property
hidden: Type: boolean

Defines whether visible in the UI
label: Type: string

Required: true

Displayed text used to describe the property
options: Type: object options

Additional Properties Allowed: false

Collection of potential values for the property
required: Type: boolean

Required: true

Whether a value is required
type: Required: true

Allowed Values: [ "shortText", "richText", "date", "number", "checkbox" ]

Type of the property
uiEditorType: Required: true

Allowed Values: [ "shortText", "richText", "date", "number", "checkbox", "list" ]

The user interface type used to display / edit the property.

Nested Schema : options

Type: object

Collection of potential values for the property

Properties

Property name that matches this regex: ^[a-zA-Z1-9]+$: Type: string

Example 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
                }
            }
        },
        {
            "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 deffered payment",
            "properties":{
                "CPF":{
                    "uiEditorType":"number",
                    "default":null,
                    "hidden":false,
                    "label":"Relevant number to enter",
                    "type":"number",
                    "required":true
                }
            }
        }
    ]
}