External Price Validation
post
                    /ccadmin/v1/webhook/externalPricing
This web hook is triggered when a request is made to place the order and it performs a validation of the external price details in the cart. If the external prices sent by the external system is different to that in the request  , a price change message will be displayed on the storefront and the new external price info will be set on the corresponding commerce items. Storefront will display a message listing failed items if there are unpriced items in the cart. A response code of 5001 is returned for valid external prices and 5002 otherwise.
                Request
Supported Media Types
                - application/json
 
This web hook is triggered when a request is made to place the current order and it performs a validation of the external price details in the cart. A response code of 5001 is returned for valid external prices and 5002 otherwise
                
                
                
                Root Schema : externalPricing_request
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThis web hook is triggered when a request is made to place the current order and it performs a validation of the external price details in the cart. A response code of 5001 is returned for valid external prices and 5002 otherwise
    
    
    
    
        Show Source
        - 
            currencyCode(optional): 
            string
            
 - 
            exchangeRate(optional): 
            number
            exchangeRate
 - 
            externalPrices(optional): 
            array  externalPrices
            
            
 - 
            operation(optional): 
            string
            
 - 
            order(optional): 
            object  order
            
            
 - 
            organization(optional): 
            object  externalPriceRequestOrganization
            
            
 - 
            profile(optional): 
            object  profile
            
            
 - 
            secondaryCurrencyCode(optional): 
            string
            Secondary currencyCode
 
Example:
    
    
{
    "profile":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "customerContactId":"abcTest",
        "loyaltyPrograms":[
        ],
        "receiveEmail":"no",
        "middleName":null,
        "id":"se-570031",
        "locale":"en",
        "sitePropertiesList":[
            {
                "site":{
                    "id":"siteUS"
                },
                "properties":{
                    "GDPRProfileP13nConsentDate":null,
                    "GDPRProfileP13nConsentGranted":false,
                    "receiveEmail":"no",
                    "receiveEmailDate":null
                }
            }
        ],
        "email":"kim@example.com",
        "daytimeTelephoneNumber":null
    },
    "externalPrices":[
        {
            "commerceItemId":"ci3000446",
            "externalPriceQuantity":2,
            "childItems":[
                {
                    "commerceItemId":"ci3000447",
                    "catRefId":"childSku1"
                },
                {
                    "commerceItemId":"ci3000448",
                    "catRefId":"childSku2"
                }
            ],
            "catRefId":"sku50001",
            "externalPrice":30
        }
    ],
    "currencyCode":"USD",
    "operation":"externalPricing",
    "order":{
        "taxPriceInfo":{
            "cityTax":0,
            "secondaryCurrencyTaxAmount":0,
            "amount":0,
            "valueAddedTax":0,
            "countyTax":0,
            "isTaxIncluded":false,
            "miscTax":0,
            "districtTax":0,
            "stateTax":0,
            "countryTax":0
        },
        "shippingGroups":[
            {
                "lastName":"Muir",
                "firstName":"John",
                "phoneNumber":"123456789",
                "discountInfo":{
                    "orderDiscount":0,
                    "shippingDiscount":0,
                    "discountDescList":[
                    ]
                },
                "shippingMethod":{
                    "secondaryCurrencyTaxAmount":0,
                    "shippingTax":0,
                    "cost":0,
                    "taxCode":"",
                    "value":"standardShippingMethod",
                    "shippingMethodDescription":"Standard"
                },
                "shippingGroupId":"sg40431",
                "shippingAddress":{
                    "lastName":"Anderson",
                    "country":"US",
                    "address3":"",
                    "address2":"",
                    "city":"Syracuse",
                    "prefix":"",
                    "address1":"21 Cedar Ave",
                    "postalCode":"13202",
                    "companyName":"",
                    "jobTitle":"",
                    "county":"",
                    "suffix":"",
                    "firstName":"Kim",
                    "phoneNumber":"212-555-1977",
                    "faxNumber":"",
                    "alias":"Home",
                    "middleName":"",
                    "state":"NY",
                    "email":"kim@example.com"
                },
                "store":{
                    "country":"USA",
                    "hours":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM",
                    "address3":null,
                    "address2":"4th Floor",
                    "city":"Boston",
                    "address1":"One Beacon Street",
                    "postalCode":"2108",
                    "county":null,
                    "stateAddress":"MA",
                    "phoneNumber":"(617) 386-1200",
                    "locationId":"Boston138",
                    "name":"CRS Home - Boston #138",
                    "faxNumber":"(617) 386-1200",
                    "email":"store138@example.com"
                },
                "type":"inStorePickupShippingGroup",
                "items":[
                    {
                        "availablePickupDate":"2018-05-19T13:00:00.000Z",
                        "rawTotalPrice":0,
                        "returnedQuantity":0,
                        "dynamicProperties":[
                            {
                                "id":"customCommerceItemShortTextProp",
                                "label":"Custom ShortText Property at the Commerce Item level",
                                "value":"TESTVALUE"
                            },
                            {
                                "id":"customCommerceItemNumberProp",
                                "label":"Custom Number Property at the Commerce Item level",
                                "value":1234
                            }
                        ],
                        "shippingSurchargeValue":0,
                        "externalData":[
                        ],
                        "discountAmount":0,
                        "preOrderQuantity":0,
                        "childItems":[
                            {
                                "unitPrice":0,
                                "addOnItem":false,
                                "amount":0,
                                "quantity":2,
                                "productId":"prod40001",
                                "rawTotalPrice":0,
                                "salePrice":0,
                                "displayName":"Laptop Parts1",
                                "detailedItemPriceInfo":[
                                ],
                                "externalData":[
                                ],
                                "catRefId":"childSku1",
                                "commerceItemId":"ci3000447",
                                "route":"/laptop-parts1/product/prod40001",
                                "selectedOptions":[
                                ],
                                "siteId":"siteUS",
                                "id":"ci3000447",
                                "shopperInput":{
                                },
                                "listPrice":0
                            },
                            {
                                "unitPrice":0,
                                "addOnItem":false,
                                "amount":0,
                                "quantity":21,
                                "productId":"prod40002",
                                "rawTotalPrice":0,
                                "salePrice":0,
                                "displayName":"Laptop Parts2",
                                "detailedItemPriceInfo":[
                                ],
                                "externalData":[
                                ],
                                "catRefId":"childSku2",
                                "commerceItemId":"ci3000448",
                                "route":"/laptop-parts2/product/prod40002",
                                "selectedOptions":[
                                ],
                                "siteId":"siteUS",
                                "id":"ci3000448",
                                "shopperInput":{
                                },
                                "listPrice":0
                            }
                        ],
                        "configuratorId":"18225092",
                        "externalPrice":30,
                        "commerceItemId":"ci1528990958825",
                        "price":0,
                        "onSale":false,
                        "stateDetailsAsUser":"The item has been initialized within the shipping group",
                        "commerceId":"ci3000446",
                        "unitPrice":0,
                        "amount":0,
                        "quantity":1,
                        "productId":"prod50001",
                        "salePrice":0,
                        "preferredPickupDate":"2018-05-19T13:00:00.000Z",
                        "externalPriceQuantity":2,
                        "catRefId":"sku50001",
                        "discountInfo":[
                        ],
                        "siteId":"siteUS",
                        "shopperInput":{
                        },
                        "backOrderQuantity":0,
                        "listPrice":0,
                        "status":"INITIAL"
                    }
                ],
                "email":"john.muir@example.com"
            }
        ],
        "creationTime":1.52899109387E12,
        "orderId":"o30427",
        "lastModifiedDate":"2018-06-14T15:44:53.870Z",
        "creationSiteId":"siteUS",
        "dynamicProperties":[
        ],
        "payments":[
        ],
        "shippingMethod":{
            "shippingTax":0,
            "cost":0,
            "value":"standardShippingMethod"
        },
        "priceListGroup":{
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup"
        },
        "orderStatus":"Incomplete",
        "cartName":"My Cart",
        "creationDate":"2018-06-14T15:44:53.870Z",
        "orderProfileId":"120102",
        "priceInfo":{
            "amount":0,
            "total":0,
            "shipping":0,
            "shippingSurchargeValue":0,
            "tax":0,
            "subTotal":0,
            "currencyCode":null,
            "totalWithoutTax":0
        },
        "discountInfo":{
            "unclaimedCouponMultiPromotions":{
            },
            "orderCouponsMap":{
            },
            "orderDiscount":0,
            "shippingDiscount":0,
            "orderImplicitDiscountList":[
            ],
            "unclaimedCouponsMap":{
            },
            "claimedCouponMultiPromotions":{
            }
        },
        "shoppingCart":{
            "numberOfItems":1,
            "items":[
                {
                    "primaryThumbImageURL":"/img/no-image.jpg",
                    "rawTotalPrice":0,
                    "displayName":"Laptop1",
                    "dynamicProperties":[
                        {
                            "id":"customCommerceItemShortTextProp",
                            "label":"Custom ShortText Property at the Commerce Item level",
                            "value":"TESTVALUE"
                        },
                        {
                            "id":"customCommerceItemNumberProp",
                            "label":"Custom Number Property at the Commerce Item level",
                            "value":1234
                        }
                    ],
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "isItemValid":true,
                    "childItems":[
                        {
                            "unitPrice":0,
                            "addOnItem":false,
                            "amount":0,
                            "quantity":2,
                            "productId":"prod40001",
                            "rawTotalPrice":0,
                            "salePrice":0,
                            "displayName":"Laptop Parts1",
                            "detailedItemPriceInfo":[
                            ],
                            "externalData":[
                            ],
                            "catRefId":"childSku1",
                            "commerceItemId":"ci3000447",
                            "route":"/laptop-parts1/product/prod40001",
                            "selectedOptions":[
                            ],
                            "siteId":"siteUS",
                            "id":"ci3000447",
                            "shopperInput":{
                            },
                            "listPrice":0
                        },
                        {
                            "unitPrice":0,
                            "addOnItem":false,
                            "amount":0,
                            "quantity":21,
                            "productId":"prod40002",
                            "rawTotalPrice":0,
                            "salePrice":0,
                            "displayName":"Laptop Parts2",
                            "detailedItemPriceInfo":[
                            ],
                            "externalData":[
                            ],
                            "catRefId":"childSku2",
                            "commerceItemId":"ci3000448",
                            "route":"/laptop-parts2/product/prod40002",
                            "selectedOptions":[
                            ],
                            "siteId":"siteUS",
                            "id":"ci3000448",
                            "shopperInput":{
                            },
                            "listPrice":0
                        }
                    ],
                    "configuratorId":"18225092",
                    "externalPrice":30,
                    "commerceItemId":"ci1528990958825",
                    "price":0,
                    "variant":[
                    ],
                    "onSale":false,
                    "id":"ci3000446",
                    "unitPrice":0,
                    "amount":0,
                    "quantity":1,
                    "productId":"prod50001",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                    ],
                    "giftWithPurchaseCommerceItemMarkers":[
                    ],
                    "externalPriceQuantity":2,
                    "catRefId":"sku50001",
                    "skuProperties":[
                        {
                            "propertyType":"sku-base",
                            "name":"Not Returnable",
                            "id":"nonreturnable",
                            "value":false
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Name",
                            "id":"displayName",
                            "value":null
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Active",
                            "id":"active",
                            "value":true
                        },
                        {
                            "propertyType":"sku-base",
                            "name":"Id",
                            "id":"id",
                            "value":"sku50001"
                        }
                    ],
                    "discountInfo":[
                    ],
                    "siteId":"siteUS",
                    "shopperInput":{
                    },
                    "listPrice":0
                }
            ]
        },
        "giftWithPurchaseInfo":[
        ],
        "siteId":"siteUS",
        "shippingAddress":{
            "lastName":"Anderson",
            "country":"US",
            "address3":"",
            "address2":"",
            "city":"Syracuse",
            "prefix":"",
            "address1":"21 Cedar Ave",
            "postalCode":"13202",
            "companyName":"",
            "jobTitle":"",
            "county":"",
            "suffix":"",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "faxNumber":"",
            "alias":"Home",
            "middleName":"",
            "state":"NY",
            "email":"kim@example.com"
        }
    }
}Nested Schema : order
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            cartName(optional): 
            string
            Cart name for this order.
 - 
            creationDate(optional): 
            string
            
 - 
            creationSiteId(optional): 
            string
            The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
 - 
            creationTime(optional): 
            integer
            
 - 
            discountInfo(optional): 
            object  discountInfo
            
            The discount information.
 - 
            dynamicProperties(optional): 
            array  dynamicProperties
            
            List of dynamic properties at line item level.
 - 
            lastModifiedDate(optional): 
            integer
            
 - 
            orderId(optional): 
            string
            
 - 
            orderProfileId(optional): 
            string
            
 - 
            orderStatus(optional): 
            string
            
 - 
            payments(optional): 
            array  payments
            
            
 - 
            priceInfo(optional): 
            object  priceInfo
            
            
 - 
            recurringChargePriceInfo(optional): 
            object  recurringChargePriceInfo
            
            Recurring charge price information.
 - 
            shippingAddress(optional): 
            object  shippingAddress
            
            
 - 
            shippingGroups(optional): 
            array  shippingGroups
            
            
 - 
            shippingMethod(optional): 
            object  shippingMethod
            
            
 - 
            shoppingCart(optional): 
            object  shoppingCart
            
            
 - 
            siteId(optional): 
            string
            
 - 
            taxPriceInfo(optional): 
            object  taxPriceInfo
            
            
 
Nested Schema : externalPriceRequestOrganization
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            active(optional): 
            boolean
            Active status of an Organization. Should be true or false. By default the value is set to true
 - 
            allApprovers(optional): 
            array  allApprovers
            
            list of all the approvers
 - 
            ancestorOrganizations(optional): 
            array  ancestorOrganizations
            
            List of ancestors for the Organization
 - 
            approvalRequired(optional): 
            boolean
            Approval flag is required for the organization, by default it is set to false
 - 
            approvers(optional): 
            array  approvers
            
            
 - 
            billingAddress(optional): 
            object  billingAddress
            
            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.
 - 
            childOrganizations(optional): 
            array  childOrganizations
            
            
 - 
            contacts(optional): 
            array  contacts
            
            
 - 
            contract(optional): 
            object  contract
            
            Contract
 - 
            customerType(optional): 
            string
            Customer Type for Organization
 - 
            delegateApprovalManagement(optional): 
            boolean
            This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
 - 
            derivedApprovalRequired(optional): 
            boolean
            Approval flag is required for the organization, by default it is set to false
 - 
            derivedBillingAddress(optional): 
            object  derivedBillingAddress
            
            Default billing address of the profile
 - 
            derivedContract(optional): 
            object  derivedContract
            
            Contract
 - 
            derivedCustomerType(optional): 
            string
            Derived customer type of the Organization
 - 
            derivedDunsNumber(optional): 
            string
            Derived dunsNumber of the Organization
 - 
            derivedShippingAddress(optional): 
            object  derivedShippingAddress
            
            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.
 - 
            derivedTaxReferenceNumber(optional): 
            string
            Derived taxReferenceNumber of the Organization
 - 
            derivedType(optional): 
            string
            Derived type of the Organization
 - 
            dunsNumber(optional): 
            string
            DUNS Number for Organization. Should be 9 digit number
 - 
            externalOrganizationId(optional): 
            string
            External id of the organization.
 - 
            id(optional): 
            string
            Id of the Organization
 - 
            name(optional): 
            string
            The name for Organization
 - 
            siteOrganizationProperties(optional): 
            object  siteOrganizationProperties
            
            Site Organization Properties
 - 
            taxReferenceNumber(optional): 
            string
            Tax Reference Number of the Organization
 - 
            type(optional): 
            string
            Type for Organization
 - 
            useExternalApprovalWebhook(optional): 
            boolean
            Flag to enable/disable Order Approval check from External Webhook
 
Nested Schema : profile
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            customerContactId(optional): 
            string
            The external customer contact id.
 - 
            daytimeTelephoneNumber(optional): 
            string
            The day time phone number of the profile
 - 
            email(optional): 
            string
            
 - 
            firstName(optional): 
            string
            
 - 
            id(optional): 
            string
            Id
 - 
            lastName(optional): 
            string
            
 - 
            locale(optional): 
            string
            
 - 
            loyaltyPrograms(optional): 
            array  loyaltyPrograms
            
            Loyalty Programs Information
 - 
            receiveEmail(optional): 
            string
            The string representation of whether the user wants to recieve email or not
 - 
            sitePropertiesList(optional): 
            array  sitePropertiesList
            
            The list of site related properties for the profile
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            commerceItemId(optional): 
            string
            
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 
Nested Schema : externalPriceRequestChild
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            commerceItemId(optional): 
            string
            
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 
Nested Schema : discountInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe discount information.
    
    
    
    
        Show Source
        - 
            orderCouponsMap(optional): 
            object  orderCouponsMap
            
            The coupons that were claimed.
 - 
            orderDiscount(optional): 
            number
            The order discount.
 - 
            shippingDiscount(optional): 
            number
            The shipping discount.
 
Nested Schema : dynamicProperties
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayList of dynamic properties at line item level.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : priceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            amount(optional): 
            number
            
 - 
            currencyCode(optional): 
            string
            
 - 
            primaryCurrencyTotal(optional): 
            number
            The primary currency total amount.
 - 
            secondaryCurrencyShippingAmount(optional): 
            number
            The secondary currency shipping amount.
 - 
            secondaryCurrencyTaxAmount(optional): 
            number
            The secondary currency tax amount.
 - 
            secondaryCurrencyTotal(optional): 
            number
            The secondary currency total amount.
 - 
            shipping(optional): 
            number
            
 - 
            shippingSurchargeValue(optional): 
            number
            
 - 
            subTotal(optional): 
            number
            
 - 
            tax(optional): 
            number
            
 - 
            total(optional): 
            number
            
 - 
            totalWithoutTax(optional): 
            number
            
 
Nested Schema : recurringChargePriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectRecurring charge price information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount of this recurring charge.
 - 
            currencyCode(optional): 
            string
            The currency code for the monetary amounts. A three character currency code such as USD.
 - 
            frequencyAmountTotals(optional): 
            array  frequencyAmountTotals
            
            The total for each recurring charge frequency
 - 
            frequencyTaxTotals(optional): 
            array  frequencyTaxTotals
            
            The tax for each recurring charge frequency
 - 
            shipping(optional): 
            number
            Cost of shipping the product.
 - 
            subTotal(optional): 
            number
            The sub-total price of the recurring charge.
 - 
            tax(optional): 
            number
            Monetary tax amount.
 - 
            total(optional): 
            number
            The total price of the recurring charge.
 - 
            totalWithoutTax(optional): 
            number
            Total of recurring amount without tax included.
 
Nested Schema : shippingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            address1(optional): 
            string
            
 - 
            address2(optional): 
            string
            
 - 
            address3(optional): 
            string
            
 - 
            city(optional): 
            string
            
 - 
            companyName(optional): 
            string
            
 - 
            country(optional): 
            string
            
 - 
            county(optional): 
            string
            
 - 
            email(optional): 
            string
            
 - 
            faxNumber(optional): 
            integer
            
 - 
            firstName(optional): 
            string
            
 - 
            jobTitle(optional): 
            string
            
 - 
            lastName(optional): 
            string
            
 - 
            middleName(optional): 
            string
            
 - 
            phoneNumber(optional): 
            integer
            
 - 
            postalCode(optional): 
            string
            
 - 
            prefix(optional): 
            string
            
 - 
            state(optional): 
            string
            
 - 
            suffix(optional): 
            string
            
 
Nested Schema : shoppingCart
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            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
 - 
            numberOfItems(optional): 
            integer
            
 
Nested Schema : taxPriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            amount(optional): 
            number
            
 - 
            cityTax(optional): 
            number
            
 - 
            countryTax(optional): 
            number
            
 - 
            countyTax(optional): 
            number
            
 - 
            districtTax(optional): 
            number
            
 - 
            isTaxIncluded(optional): 
            boolean
            
 - 
            miscTax(optional): 
            number
            
 - 
            secondaryCurrencyTaxAmount(optional): 
            number
            tax amount in secondaryCurrency
 - 
            stateTax(optional): 
            number
            
 - 
            valueAddedTax(optional): 
            number
            
 
Nested Schema : orderCouponsMap
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe coupons that were claimed.
    
    
    
    
        Show Source
        - 
            couponCode(optional): 
            object  couponCode
            
            Coupon Code.
 
Nested Schema : couponCode
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectCoupon Code.
    
    
    
    
        Show Source
        - 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).
 - 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.
 - 
            promotionId(optional): 
            string
            The Id of the promotion.
 - 
            promotionLevel(optional): 
            string
            The promotion level.
 - 
            promotionLongDesc(optional): 
            string
            The description of the promotion.
 - 
            promotionName(optional): 
            string
            The display name of the promotion.
 - 
            totalAdjustment(optional): 
            number
            Total adjustment caused by the promotion.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            The dynamic property id.
 - 
            label(optional): 
            string
            The dynamic property label.
 - 
            value(optional): 
            string
            The dynamic property value.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            amount(optional): 
            integer
            
 - 
            balance(optional): 
            number
            
 - 
            gatewayName(optional): 
            string
            
 - 
            giftCardNumber(optional): 
            integer
            
 - 
            isAmountRemaining(optional): 
            boolean
            
 - 
            maskedCardNumber(optional): 
            string
            
 - 
            paymentGroupId(optional): 
            string
            
 - 
            paymentMethod(optional): 
            string
            
 - 
            paymentState(optional): 
            string
            
 - 
            uiIntervention(optional): 
            string
            
 
Nested Schema : frequencyAmountTotals
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe total for each recurring charge frequency
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : frequencyTaxTotals
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe tax for each recurring charge frequency
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            frequency(optional): 
            string
            The frequency for the item's total e.g. Monthly.
 - 
            total(optional): 
            string
            The total amount for the frequency.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            frequency(optional): 
            string
            The frequency for the item's tax e.g. Monthly.
 - 
            tax(optional): 
            string
            The tax amount for the frequency.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            childItems(optional): 
            array  childItems
            
            
 - 
            discountInfo(optional): 
            object  discountInfo
            
            The discount information.
 - 
            email(optional): 
            string
            The email address of the person responsible for picking up the contents of this shipping group.Example:
john.muir@oracle.com - 
            firstName(optional): 
            string
            The first name of the person responsible for picking up the contents of this shipping group.Example:
John - 
            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
 - 
            lastName(optional): 
            string
            The second name of the person responsible for picking up the contents of this shipping group.Example:
Muir - 
            phoneNumber(optional): 
            string
            The phone number of the person responsible for picking up the contents of this shipping group.Example:
1231231234 - 
            priceInfo(optional): 
            object  priceInfo
            
            The price information.
 - 
            recurringChargePriceInfo(optional): 
            object  recurringChargePriceInfo
            
            Recurring charge price information.
 - 
            shippingAddress(optional): 
            object  shippingAddress
            
            The shipping address details.
 - 
            shippingGroupId(optional): 
            string
            The shipping Group idExample:
sg1234 - 
            shippingMethod(optional): 
            object  shippingMethod
            
            The shipping method details for the order.
 - 
            store(optional): 
            object  store
            
            The store is present in the request if the type is inStorePickupShippingGroup.
 - 
            taxPriceInfo(optional): 
            object  taxPriceInfo
            
            The shipping address details.
 - 
            type(optional): 
            string
            the shippingGroup typeExample:
inStorePickupShippingGroup 
Nested Schema : discountInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe discount information.
    
    
    
    
        Show Source
        - 
            claimedCouponMultiPromotions(optional): 
            object  claimedCouponMultiPromotions
            
            
 - 
            orderCouponsMap(optional): 
            object  orderCouponsMap
            
            The coupons that were claimed.
 - 
            orderDiscount(optional): 
            number
            The order discount.Example:
0 - 
            orderImplicitDiscountList(optional): 
            array  orderImplicitDiscountList
            
            
 - 
            shippingDiscount(optional): 
            number
            The shipping discount.Example:
5.6 - 
            unclaimedCouponMultiPromotions(optional): 
            object  unclaimedCouponMultiPromotions
            
            
 - 
            unclaimedCouponsMap(optional): 
            object  unclaimedCouponsMap
            
            
 
Nested Schema : priceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe price information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The total order amount.Example:
24.99 - 
            currencyCode(optional): 
            string
            The currency code.Example:
USD - 
            lkpValExcludingFreeShip(optional): 
            number
            The total shipping cost excluding items with free shipping.Example:
0 - 
            shipping(optional): 
            number
            The total shipping cost.Example:
14.95 - 
            shippingSurchargeValue(optional): 
            number
            Extra handling costs for shipping the productsExample:
0 - 
            subTotal(optional): 
            number
            Sub-total.Example:
24.99 - 
            tax(optional): 
            number
            The total tax amount.Example:
7.99 - 
            total(optional): 
            number
            The order total.Example:
47.93 - 
            totalWithoutTax(optional): 
            number
            The total amount without tax.Example:
39.49 
Nested Schema : recurringChargePriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectRecurring charge price information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount of this recurring charge.
 - 
            currencyCode(optional): 
            string
            The currency code for the monetary amounts. A three character currency code such as USD.
 - 
            frequencyAmountTotals(optional): 
            array  frequencyAmountTotals
            
            The total for each recurring charge frequency
 - 
            frequencyTaxTotals(optional): 
            array  frequencyTaxTotals
            
            The tax for each recurring charge frequency
 - 
            shipping(optional): 
            number
            Cost of shipping the product.
 - 
            subTotal(optional): 
            number
            The sub-total price of the recurring charge.
 - 
            tax(optional): 
            number
            Monetary tax amount.
 - 
            total(optional): 
            number
            The total price of the recurring charge.
 - 
            totalWithoutTax(optional): 
            number
            Total of recurring amount without tax included.
 
Nested Schema : shippingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping address details.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address snippet.Example:
1 main st - 
            address2(optional): 
            string
            Address snippet.
 - 
            address3(optional): 
            string
            Address snippet.
 - 
            city(optional): 
            string
            City.Example:
Cambridge - 
            companyName(optional): 
            string
            Company name.Example:
oracle - 
            country(optional): 
            string
            Country.
 - 
            county(optional): 
            string
            County.
 - 
            email(optional): 
            string
            Email address.Example:
john.muir@oracle.com - 
            faxNumber(optional): 
            string
            Fax number.
 - 
            firstName(optional): 
            string
            First nameExample:
John - 
            jobTitle(optional): 
            string
            Job title.Example:
manager - 
            lastName(optional): 
            string
            Last name.Example:
Muir - 
            middleName(optional): 
            string
            Middle name.Example:
Morgan - 
            phoneNumber(optional): 
            string
            Phone number.Example:
1111111111 - 
            postalCode(optional): 
            string
            Postal code.Example:
1122 - 
            prefix(optional): 
            string
            Name prefix.
 - 
            state(optional): 
            string
            State.Example:
MA - 
            suffix(optional): 
            string
            Name suffix.
 
Nested Schema : shippingMethod
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping method details for the order.
    
    
    
    
        Show Source
        - 
            cost(optional): 
            number
            The total cost of shipping.
 - 
            secondaryCurrencyTaxAmount(optional): 
            number
            tax amount in secondaryCurrency
 - 
            shippingMethodDescription(optional): 
            string
            
 - 
            shippingTax(optional): 
            number
            
 - 
            taxCode(optional): 
            string
            
 - 
            value(optional): 
            string
            The shipping method applied to the order.
 
Nested Schema : store
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe store is present in the request if the type is inStorePickupShippingGroup.
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            Address line 1 of store.Example:
One Beacon Street - 
            address2(optional): 
            string
            Address line 2 of store.Example:
4th Floor - 
            address3(optional): 
            string
            Address line 3 of store.Example:
Main Street - 
            city(optional): 
            string
            The store's city.Example:
Boston - 
            country(optional): 
            string
            The country of the storeExample:
USA - 
            county(optional): 
            string
            The store's countyExample:
MA - 
            email(optional): 
            string
            The store's email address.Example:
store138@example.com - 
            faxNumber(optional): 
            string
            Fax number.Example:
(617) 386-1200 - 
            hours(optional): 
            string
            The store's opening hours.Example:
Mon - Sat 10AM - 7PM Sun 11AM - 6 PM - 
            locationId(optional): 
            string
            The store's location Id.Example:
Boston138 - 
            name(optional): 
            string
            The store's name.Example:
Boston Store #138 - 
            phoneNumber(optional): 
            string
            The store's phone number.Example:
(617) 386-1201 - 
            postCode(optional): 
            string
            The store's post code.Example:
2108 - 
            stateAddress(optional): 
            string
            The store's state address.Example:
MA 
Nested Schema : taxPriceInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe shipping address details.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The total order amount.Example:
5.99 - 
            cityTax(optional): 
            number
            City TaxExample:
3.9 - 
            countryTax(optional): 
            number
            Country Tax.Example:
0 - 
            countyTax(optional): 
            number
            County Tax.Example:
0 - 
            districtTax(optional): 
            number
            District Tax.Example:
0 - 
            isTaxIncluded(optional): 
            boolean
            If Tax is included?Example:
false - 
            miscTax(optional): 
            number
            Misc Tax.Example:
1.87 - 
            secondaryCurrencyTaxAmount(optional): 
            number
            taxAmount in secondaryCurrencyExample:
0 - 
            stateTax(optional): 
            number
            State Tax.Example:
3.9 - 
            valueAddedTax(optional): 
            number
            Value Added Tax.Example:
0 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            addOnItem(optional): 
            boolean
            Whether this child item is an add-on (internally configured) or not (externally configured).
 - 
            amount(optional): 
            number
            The corresponding monetary amount.
 - 
            catRefId(optional): 
            string
            The catalog reference id.
 - 
            commerceItemId(optional): 
            string
            The commerce item id.
 - 
            configurablePropertyId(optional): 
            string
            ID of the catalog's configurableProperty associated with this item.
 - 
            configurationOptionId(optional): 
            string
            ID of the catalog's configurationOption associated with this item.
 - 
            detailedItemPriceInfo(optional): 
            array  detailedItemPriceInfo
            
            
 - 
            displayName(optional): 
            string
            Display name of the item
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            id(optional): 
            string
            Id of the child item
 - 
            listPrice(optional): 
            number
            The monetary amount of the list price.
 - 
            productId(optional): 
            string
            
 - 
            quantity(optional): 
            number
            Quantity of the item.
 - 
            rawTotalPrice(optional): 
            number
            
 - 
            route(optional): 
            string
            Path to the product.
 - 
            salePrice(optional): 
            number
            
 - 
            shopperInput(optional): 
            object  shopperInput
            
            Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
 - 
            unitPrice(optional): 
            number
            Price per unit of the item.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shopperInput
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       
       
    
    
    
    
    
    
    Map of shopper input keys to values
    
    
    
    
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : claimedCouponMultiPromotions
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            couponCode(optional): 
            string
            Example:
CPN123 - 
            promotions(optional): 
            array  promotions
            
            
 
Nested Schema : orderCouponsMap
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe coupons that were claimed.
    
    
    
    
        Show Source
        - 
            couponCode(optional): 
            object  couponCode
            
            Coupon Code.
 
Nested Schema : unclaimedCouponMultiPromotions
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            couponCode(optional): 
            string
            Example:
CPN123 - 
            promotionInfo(optional): 
            array  promotionInfo
            
            
 
Nested Schema : unclaimedCouponsMap
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            couponCode(optional): 
            string
            Example:
CPN123 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            promotionID(optional): 
            string
            Example:
PRM123 - 
            secondaryCurrencyTotalAdjustment(optional): 
            integer
            Example:
0 - 
            totalAdjustment(optional): 
            integer
            Example:
0 
Nested Schema : couponCode
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectCoupon Code.
    
    
    
    
        Show Source
        - 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).Example:
false - 
            promotionDesc(optional): 
            string
            Description of the promotion. Retained for backward compatibility.Example:
Spend 10 Get 10% Off - 
            promotionId(optional): 
            string
            The Id of the promotion.Example:
promo123 - 
            promotionLevel(optional): 
            string
            The promotion level.Example:
order - 
            promotionLongDesc(optional): 
            string
            The description of the promotion.Example:
<p>desc Spend 10 Get 10% Off</p> - 
            promotionName(optional): 
            string
            The display name of the promotion.Example:
10% Off - 
            totalAdjustment(optional): 
            number
            Total adjustment caused by the promotion.Example:
-11.1 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            external(optional): 
            boolean
            States whether this promotion was applied by an external system (only present on external promotions).Example:
true - 
            promotionDesc(optional): 
            string
            Example:
the order related promotion - 
            promotionId(optional): 
            string
            Example:
PRM1234 - 
            promotionLevel(optional): 
            string
            promotion level - order or itemExample:
order - 
            promotionLongDesc(optional): 
            string
            Example:
Detailed desc of promotion - 
            promotionName(optional): 
            string
            Example:
PROMO1 - 
            secondaryCurrencyTotalAdjustment(optional): 
            string
            The total adjustment for secondary currencyExample:
0 - 
            totalAdjustment(optional): 
            string
            The total adjustment.Example:
5.6 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            promotionDesc(optional): 
            string
            Example:
description of the promotion - 
            promotionID(optional): 
            string
            Example:
PRM123 - 
            promotionLevel(optional): 
            string
            Example:
order - 
            promotionLongDesc(optional): 
            string
            Example:
long desc of promotion - 
            promotionName(optional): 
            string
            Example:
PRMName - 
            totalAdjustment(optional): 
            integer
            Example:
0 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the item by the third party system.
 - 
            amount(optional): 
            number
            The monetary amount.Example:
24.99 - 
            availabilityDate(optional): 
            string(date-time)
            The availability date for preOrdered/backOrdered quantity.Example:
2018-06-13T18:09:53.493Z - 
            availablePickupDate(optional): 
            string
            The items available store pickup date.Example:
2018-05-19T13:00:00.000Z - 
            backOrderQuantity(optional): 
            integer
            The back ordered quantity included.Example:
0 - 
            catRefId(optional): 
            string
            The reference ID of the catalog this commerce item references. Typically the SKU id.Example:
Sku_9F - 
            childItems(optional): 
            array  childItems
            
            
 - 
            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
 - 
            commerceId(optional): 
            string
            Commerce ID for this commerce item.Example:
ci12343 - 
            commerceItemId(optional): 
            string
            Commerce Item ID for this commerce item.Example:
ci123545 - 
            configuratorId(optional): 
            string
            
 - 
            detailedItemPriceInfo(optional): 
            array  detailedItemPriceInfo
            
            
 - 
            detailedRecurringChargeInfo(optional): 
            object  detailedRecurringChargeInfo
            
            Detailed Item Price Information.
 - 
            discountAmount(optional): 
            number
            The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)Example:
0 - 
            discountInfo(optional): 
            array  discountInfo
            
            Whether this item is discounted.
 - 
            dynamicProperties(optional): 
            array  dynamicProperties
            
            List of dynamic properties at line item level.
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            inventoryLocationId(optional): 
            string
            Defines the inventory location that services the referenced commerce item.
 - 
            listPrice(optional): 
            number
            The monetary amount of the list price.Example:
24.99 - 
            onSale(optional): 
            boolean
            Whether is on sale.Example:
false - 
            preferredPickupDate(optional): 
            string
            The items preferred store pickup date.Example:
2018-05-19T13:00:00.000Z - 
            preOrderQuantity(optional): 
            integer
            The pre ordered quantity included.Example:
0 - 
            price(optional): 
            number
            Example:
24.99 - 
            productId(optional): 
            string
            The ID of the product.Example:
product_9e - 
            quantity(optional): 
            integer
            The number of items covered by this price infoExample:
1 - 
            rawTotalPrice(optional): 
            number
            The raw total price.Example:
24.99 - 
            returnedQuantity(optional): 
            integer
            Example:
0 - 
            salePrice(optional): 
            number
            The sale priceExample:
0 - 
            shippingSurchargeValue(optional): 
            number
            Extra handling cost for shipping the product.Example:
0 - 
            shopperInput(optional): 
            object  shopperInput
            
            Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
 - 
            siteId(optional): 
            string
            The ID of the site on which the item was added.
 - 
            stateDetailsAsUser(optional): 
            string
            Example:
details of shippingItem - 
            status(optional): 
            string
            Example:
INITIAL - 
            unitPrice(optional): 
            number
            Example:
24.99 
Nested Schema : detailedRecurringChargeInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDetailed Item Price Information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount for the recurring charge.
 - 
            currencyCode(optional): 
            string
            The three character currency code for the monetary amounts.
 - 
            detailedUnitPrice(optional): 
            number
            The detailed unit price: amount / quantity. (read-only)
 - 
            discounted(optional): 
            boolean
            Whether the price is discounted.
 - orderDiscountShare(optional): number
 - 
            quantity(optional): 
            integer
            The number of items covered by this recurring charge price info
 - 
            tax(optional): 
            number
            Monetary tax amount.
 
Nested Schema : dynamicProperties
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayList of dynamic properties at line item level.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shopperInput
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       
       
    
    
    
    
    
    
    Map of shopper input keys to values
    
    
    
    
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            amount(optional): 
            number
            Example:
24.99 - 
            currencyCode(optional): 
            string
            Example:
USD - 
            detailedUnitPrice(optional): 
            number
            Example:
24.99 - 
            discounted(optional): 
            boolean
            Example:
false - orderDiscountShare(optional): integer
 - 
            quantity(optional): 
            integer
            Example:
1 - 
            secondaryCurrencyTaxAmount(optional): 
            number
            tax amount in secondaryCurrencyExample:
0 - 
            tax(optional): 
            number
            Example:
0 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            coupon(optional): 
            string
            Example:
CPN123 - 
            external(optional): 
            boolean
            if promotion is externalExample:
false - 
            giftWithPurchaseDiscountInfo(optional): 
            array  giftWithPurchaseDiscountInfo
            
            
 - 
            promotionDesc(optional): 
            string
            Example:
promotion desc - 
            promotionId(optional): 
            string
            Example:
PRM123 - 
            promotionLevel(optional): 
            string
            Example:
item - 
            promotionLongDesc(optional): 
            string
            Example:
detailed desc of promotion - 
            promotionName(optional): 
            string
            Example:
Promotion BAC - 
            totalAdjustment(optional): 
            string
            Example:
0 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            giftWithPurchaseType(optional): 
            string
            the gift type.For example product or skuExample:
product - 
            gitWithPurchaseDetail(optional): 
            string
            Example:
details of gift - 
            gitWithPurchaseIdentifier(optional): 
            integer
            Example:
1223344 - 
            promotionDesc(optional): 
            string
            Example:
GWP Promotion description - 
            promotionId(optional): 
            string
            Example:
PRM1234 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            The dynamic property id.Example:
11502 - 
            label(optional): 
            string
            The dynamic property label.Example:
dyn_prop - 
            value(optional): 
            string
            The dynamic property value.Example:
12 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : frequencyAmountTotals
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe total for each recurring charge frequency
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : frequencyTaxTotals
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe tax for each recurring charge frequency
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            frequency(optional): 
            string
            The frequency for the item's total e.g. Monthly.
 - 
            total(optional): 
            string
            The total amount for the frequency.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            frequency(optional): 
            string
            The frequency for the item's tax e.g. Monthly.
 - 
            tax(optional): 
            string
            The tax amount for the frequency.
 
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- 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            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
 - 
            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
 - 
            configuratorId(optional): 
            string
            
 - 
            description(optional): 
            string
            
 - 
            detailedItemPriceInfo(optional): 
            array  detailedItemPriceInfo
            
            
 - 
            detailedRecurringChargeInfo(optional): 
            object  detailedRecurringChargeInfo
            
            Detailed Item Price Information.
 - 
            discountAmount(optional): 
            number
            
 - 
            discountInfo(optional): 
            array  discountInfo
            
            The discount information.
 - 
            displayName(optional): 
            string
            
 - 
            dynamicProperties(optional): 
            array  dynamicProperties
            
            List of dynamic properties at line item level.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            id(optional): 
            string
            
 - 
            isItemValid(optional): 
            boolean
            
 - 
            listPrice(optional): 
            number
            
 - 
            onSale(optional): 
            boolean
            
 - 
            price(optional): 
            number
            
 - 
            primaryThumbImageURL(optional): 
            string
            
 - 
            productId(optional): 
            string
            
 - 
            quantity(optional): 
            integer
            
 - 
            rawTotalPrice(optional): 
            number
            
 - 
            salePrice(optional): 
            number
            
 - 
            secondaryCurrencyShippingSurcharge(optional): 
            integer
            
 - 
            shippingSurchargeValue(optional): 
            integer
            
 - 
            shopperInput(optional): 
            object  shopperInput
            
            Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
 - 
            siteId(optional): 
            string
            The ID of the site on which the item was added.
 - 
            unitPrice(optional): 
            number
            
 - 
            variant(optional): 
            array  variant
            
            List of variants for the product.
 
Nested Schema : childItems
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayRepresents 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 : detailedRecurringChargeInfo
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDetailed Item Price Information.
    
    
    
    
        Show Source
        - 
            amount(optional): 
            number
            The monetary amount for the recurring charge.
 - 
            currencyCode(optional): 
            string
            The three character currency code for the monetary amounts.
 - 
            detailedUnitPrice(optional): 
            number
            The detailed unit price: amount / quantity. (read-only)
 - 
            discounted(optional): 
            boolean
            Whether the price is discounted.
 - orderDiscountShare(optional): number
 - 
            quantity(optional): 
            integer
            The number of items covered by this recurring charge price info
 - 
            tax(optional): 
            number
            Monetary tax amount.
 
Nested Schema : dynamicProperties
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayList of dynamic properties at line item level.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shopperInput
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       
       
    
    
    
    
    
    
    Map of shopper input keys to values
    
    
    
    
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            addOnItem(optional): 
            boolean
            Whether this child item is an add-on (internally configured) or not (externally configured).
 - 
            amount(optional): 
            number
            The corresponding monetary amount.
 - 
            catRefId(optional): 
            string
            The catalog reference id.
 - 
            commerceItemId(optional): 
            string
            The commerce item id.
 - 
            configurablePropertyId(optional): 
            string
            ID of the catalog's configurableProperty associated with this item.
 - 
            configurationOptionId(optional): 
            string
            ID of the catalog's configurationOption associated with this item.
 - 
            detailedItemPriceInfo(optional): 
            array  detailedItemPriceInfo
            
            
 - 
            displayName(optional): 
            string
            Display name of the item
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            id(optional): 
            string
            Id of the child item
 - 
            listPrice(optional): 
            number
            The monetary amount of the list price.
 - 
            productId(optional): 
            string
            
 - 
            quantity(optional): 
            number
            Quantity of the item.
 - 
            rawTotalPrice(optional): 
            number
            
 - 
            route(optional): 
            string
            Path to the product.
 - 
            salePrice(optional): 
            number
            
 - 
            shopperInput(optional): 
            object  shopperInput
            
            Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
 - 
            siteId(optional): 
            string
            The ID of the site on which the item was added.
 - 
            unitPrice(optional): 
            number
            Price per unit of the item.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shopperInput
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       
       
    
    
    
    
    
    
    Map of shopper input keys to values
    
    
    
    
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            coupon(optional): 
            string
            The coupon ID.
 - 
            promotionDesc(optional): 
            string
            The promotion description.
 - 
            promotionId(optional): 
            string
            The promotion ID.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            id(optional): 
            string
            The dynamic property id.
 - 
            label(optional): 
            string
            The dynamic property label.
 - 
            value(optional): 
            string
            The dynamic property value.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            optionName(optional): 
            string
            The variant option name.
 - 
            optionValue(optional): 
            string
            The variant option value.
 
Nested Schema : ancestorOrganizations
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayList of ancestors for the Organization
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : billingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe 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
        - 
            address1(optional): 
            string
            the address1 of the address
 - 
            address2(optional): 
            string
            the address2 of the address
 - 
            city(optional): 
            string
            the city of the address
 - 
            companyName(optional): 
            string
            the company name of the address
 - 
            country(optional): 
            string
            the country of the address
 - 
            externalAddressId(optional): 
            string
            External ID of the address
 - 
            phoneNumber(optional): 
            string
            the phone Number of the address
 - 
            postalCode(optional): 
            string
            the postal Code of the address
 - 
            repositoryId(optional): 
            string
            Repository Id of the address
 - 
            state(optional): 
            string
            the state of the address
 
Nested Schema : contract
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectContract
    
    
    
    
        Show Source
        - 
            catalog(optional): 
            object  catalog
            
            Catalog associated with contract
 - 
            creationDate(optional): 
            string
            Contract creation date time stamp
 - 
            description(optional): 
            string
            Description for contract
 - 
            displayName(optional): 
            string
            Name of the contract
 - 
            endDate(optional): 
            string
            Contract end date time stamp
 - 
            externalContractReference(optional): 
            string
            External contract reference
 - 
            priceListGroup(optional): 
            object  priceListGroup
            
            Price ListGroup associated with contract
 - 
            repositoryId(optional): 
            string
            Repository Id of the contract
 - 
            startDate(optional): 
            string
            Contract start date time stamp
 - 
            terms(optional): 
            object  terms
            
            Terms and Conditions
 
Nested Schema : derivedBillingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectDefault billing address of the profile
    
    
    
    
        Show Source
        - 
            address1(optional): 
            string
            the address1 of the billing address
 - 
            address2(optional): 
            string
            the address2 of the billing address
 - 
            city(optional): 
            string
            the city of the billing address
 - 
            country(optional): 
            string
            the country of the billing address
 - 
            county(optional): 
            string
            the county of the billing address
 - 
            externalAddressId(optional): 
            string
            External ID of the address
 - 
            firstName(optional): 
            string
            the first name of the billing address
 - 
            lastName(optional): 
            string
            the last name of the billing address
 - 
            phoneNumber(optional): 
            string
            the phone Number of the billing address
 - 
            postalCode(optional): 
            string
            the postal Code of the billing address
 - 
            repositoryId(optional): 
            string
            the id of the billing address
 - 
            state(optional): 
            string
            the state of the billing address
 
Nested Schema : derivedContract
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectContract
    
    
    
    
        Show Source
        - 
            catalog(optional): 
            object  catalog
            
            Catalog associated with contract
 - 
            creationDate(optional): 
            string
            Contract creation date time stamp
 - 
            description(optional): 
            string
            Description for contract
 - 
            displayName(optional): 
            string
            Name of the contract
 - 
            endDate(optional): 
            string
            Contract end date time stamp
 - 
            externalContractReference(optional): 
            string
            External contract reference
 - 
            priceListGroup(optional): 
            object  priceListGroup
            
            Price ListGroup associated with contract
 - 
            repositoryId(optional): 
            string
            Repository Id of the contract
 - 
            startDate(optional): 
            string
            Contract start date time stamp
 - 
            terms(optional): 
            object  terms
            
            Terms and Conditions
 
Nested Schema : derivedShippingAddress
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe 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
        - 
            address1(optional): 
            string
            the address1 of the address
 - 
            address2(optional): 
            string
            the address2 of the address
 - 
            city(optional): 
            string
            the city of the address
 - 
            companyName(optional): 
            string
            the company name shipping address
 - 
            country(optional): 
            string
            the country of the address
 - 
            externalAddressId(optional): 
            string
            External ID of the address
 - 
            phoneNumber(optional): 
            string
            the phone Number of the company address
 - 
            postalCode(optional): 
            string
            the postal Code of the address
 - 
            repositoryId(optional): 
            string
            Repository Id of the address
 - 
            state(optional): 
            string
            the state of the address
 
Nested Schema : siteOrganizationProperties
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSite Organization Properties
    
    
    
    
        Show Source
        - 
            site(optional): 
            object  site
            
            Site information
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            firstName(optional): 
            string
            the first name of the approver
 - 
            lastName(optional): 
            string
            the last name of the apporver
 - 
            middleName(optional): 
            string
            the middle name of the approver
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            active(optional): 
            boolean
            Active flag of the organization.
 - 
            id(optional): 
            string
            Id of the organization.
 - 
            name(optional): 
            string
            Name of the organization.
 - 
            repositoryId(optional): 
            string
            Repository Id of the organization.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
objectNested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
objectNested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
objectNested Schema : catalog
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectCatalog associated with contract
    
    
    
    
        Show Source
        - 
            displayName(optional): 
            string
            Name of the catalog
 - 
            id(optional): 
            string
            id of the catalog
 - 
            status(optional): 
            string
            
 
Nested Schema : priceListGroup
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPrice ListGroup associated with contract
    
    
    
    
        Show Source
        - 
            repositoryId(optional): 
            string
            Repository Id of the price list group
 
Nested Schema : terms
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectTerms and Conditions
    
    
    
    
        Show Source
        - 
            repositoryId(optional): 
            string
            Repository Id of terms and conditions
 - 
            terms(optional): 
            string
            Terms and Conditions
 
Nested Schema : catalog
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectCatalog associated with contract
    
    
    
    
        Show Source
        - 
            displayName(optional): 
            string
            Name of the catalog
 - 
            id(optional): 
            string
            id of the catalog
 - 
            status(optional): 
            string
            
 
Nested Schema : priceListGroup
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPrice ListGroup associated with contract
    
    
    
    
        Show Source
        - 
            repositoryId(optional): 
            string
            Repository Id of the price list group
 
Nested Schema : terms
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectTerms and Conditions
    
    
    
    
        Show Source
        - 
            repositoryId(optional): 
            string
            Repository Id of terms and conditions
 - 
            terms(optional): 
            string
            Terms and Conditions
 
Nested Schema : site
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSite information
    
    
    
    
        Show Source
        - 
            approvalRequired(optional): 
            boolean
            Approval flag is required for the organization, by default it is set to false
 - 
            contract(optional): 
            object  contract
            
            Contract
 - 
            delegateApprovalManagement(optional): 
            boolean
            This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
 - 
            orderPriceLimit(optional): 
            number
            Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
 - 
            useExternalApprovalWebhook(optional): 
            boolean
            Flag to enable/disable Order Approval check from External Webhook
 
Nested Schema : contract
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectContract
    
    
    
    
        Show Source
        - 
            catalog(optional): 
            object  catalog
            
            Catalog associated with contract
 - 
            creationDate(optional): 
            string
            Contract creation date time stamp
 - 
            description(optional): 
            string
            Description for contract
 - 
            displayName(optional): 
            string
            Name of the contract
 - 
            endDate(optional): 
            string
            Contract end date time stamp
 - 
            externalContractReference(optional): 
            string
            External contract reference
 - 
            priceListGroup(optional): 
            object  priceListGroup
            
            Price ListGroup associated with contract
 - 
            repositoryId(optional): 
            string
            Repository Id of the contract
 - 
            startDate(optional): 
            string
            Contract start date time stamp
 - 
            terms(optional): 
            object  terms
            
            Terms and Conditions
 
Nested Schema : catalog
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectCatalog associated with contract
    
    
    
    
        Show Source
        - 
            displayName(optional): 
            string
            Name of the catalog
 - 
            id(optional): 
            string
            id of the catalog
 - 
            status(optional): 
            string
            
 
Nested Schema : priceListGroup
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPrice ListGroup associated with contract
    
    
    
    
        Show Source
        - 
            repositoryId(optional): 
            string
            Repository Id of the price list group
 
Nested Schema : terms
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectTerms and Conditions
    
    
    
    
        Show Source
        - 
            repositoryId(optional): 
            string
            Repository Id of terms and conditions
 - 
            terms(optional): 
            string
            Terms and Conditions
 
Nested Schema : sitePropertiesList
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayThe list of site related properties for the profile
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            membershipId(optional): 
            string
            membershipId of the profile.
 - 
            programId(optional): 
            string
            programId of Loyalty Program
 - 
            programName(optional): 
            string
            programName of Loyalty Program
 - 
            repositoryId(optional): 
            string
            repository Id
 - 
            status(optional): 
            string
            status of Enrollment
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            properties(optional): 
            object  properties
            
            The site related properties for the profile
 - 
            site(optional): 
            object  site
            
            The site data
 
Nested Schema : properties
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe site related properties for the profile
    
    
    
    
        Show Source
        - 
            GDPRProfileP13nConsentDate(optional): 
            string
            The date on which GDPR personalization consent was granted by the user.
 - 
            GDPRProfileP13nConsentGranted(optional): 
            boolean
            If user has given consent for his/her profile information to be used for personalization purposes.
 - 
            receiveEmail(optional): 
            string
            Indicates whether the user should receive marketing emails on the current site. Can be yes or no.
 - 
            receiveEmailDate(optional): 
            string
            The date on which email marketing consent was granted by the user.
 
Response
Supported Media Types
                - application/json
 
200 Response
Following model is returned when operation succeeds.
                
                
                    Root Schema : externalPricing_response
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
    objectExample:
    
    
{
    "externalPrices":[
        {
            "commerceItemId":"ci1528990958825",
            "messages":[
                "testMessage1",
                "testMessage2"
            ],
            "externalPriceQuantity":5,
            "childItems":[
                {
                    "configurationOptionId":"configOptIDC1P11536825979556",
                    "addOnItem":true,
                    "quantity":2,
                    "configurablePropertyId":"configPropIDC1P11536825979556",
                    "shopperInput":{
                        "fontSIID1536825979556":"Times New Roman",
                        "shrtTxtSIID1536825979556":"This is the P1parent1Prod1536825979556"
                    },
                    "catRefId":"childSku1"
                },
                {
                    "quantity":21,
                    "catRefId":"childSku2"
                },
                {
                    "quantity":3,
                    "catRefId":"childSku3"
                }
            ],
            "catRefId":"Sku_23Dxyi",
            "externalPrice":25,
            "statusCode":"5102"
        },
        {
            "commerceItemId":"ci1528990958844",
            "statusCode":"5104"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9091/ccstore/v1/testExternalPricing/setPartialFailureResponseForExternalPriceInfo"
        }
    ],
    "Operation":"externalPricing",
    "responseCode":"5002"
}Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            commerceItemId(optional): 
            string
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            messages(optional): 
            array  messages
            
            
 - 
            serviceId(optional): 
            string
            
 - 
            statusCode(optional): 
            string
            The status code. The following are the status codes returned in webhook response to Oracle Commerce Cloud: |Status Code|Description| |------------------|------------------| |5101|All okay, prices validated and is fine| |5102|the item needs to be updated with the external price info.| |5103|The item is unpriced| |5104|The item is externally validated and everything is fine|
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            addOnItem(optional): 
            boolean
            Whether this child item is an add-on (internally configured) or not (externally configured).
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            configurablePropertyId(optional): 
            string
            ID of the catalog's configurableProperty associated with this item.
 - 
            configurationOptionId(optional): 
            string
            ID of the catalog's configurationOption associated with this item.
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            shopperInput(optional): 
            object  shopperInput
            
            Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : shopperInput
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
       objectAdditional Properties Allowed
       Show Source
       
       
    
    
    
    
    
    
    Map of shopper input keys to values
    
    
    
    
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            
 - 
            activationDate(optional): 
            string
            
 - 
            asset(optional): 
            boolean
            The flag that defines it the item is an asset or not.
 - 
            assetKey(optional): 
            string
            The assetKey assigned when the item is a service.
 - 
            catRefId(optional): 
            string
            
 - 
            childItems(optional): 
            array  childItems
            
            
 - 
            deactivationDate(optional): 
            string
            
 - 
            externalData(optional): 
            array  externalData
            
            External data to be associated with a commerce item, provided by a third party system.
 - 
            externalPrice(optional): 
            number
            
 - 
            externalPriceQuantity(optional): 
            integer
            
 - 
            externalRecurringCharge(optional): 
            number
            
 - 
            externalRecurringChargeDuration(optional): 
            string
            
 - 
            externalRecurringChargeFrequency(optional): 
            string
            
 - 
            parentAssetKey(optional): 
            string
            The parentAssetKey assigned when the item is a service.
 - 
            quantity(optional): 
            number
            
 - 
            rootAssetKey(optional): 
            string
            The rootAssetKey assigned when the item is a service.
 - 
            serviceId(optional): 
            string
            
 - 
            transactionDate(optional): 
            string
            ISO formatted Date on which the service action should be triggered.
 
Nested Schema : externalData
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayExternal data to be associated with a commerce item, provided by a third party system.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.
 
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            actionCode(optional): 
            string
            The action code that has been set on the externalData item by the third party system.
 - 
            name(optional): 
            string
            The name to be associated with the externalData item.
 - 
            values(optional): 
            object  values
            
            The map values associated with an externalData item.
 
Nested Schema : values
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe map values associated with an externalData item.
    
    
    
    
        Show Source
        - 
            key(optional): 
            string
            Map key defined by external system.
 - 
            value(optional): 
            string
            Map value defined by external system.