1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Webhook
  4. Shopper Profile Update

Shopper Profile Update

post

/ccadmin/v1/webhook/profileUpdate

The details of customer profile being updated on Oracle Commerce Cloud.

Request

Supported Media Types
Body ()
A registered shopper has changed their account details
Root Schema : updateProfile_request
Type: object
A registered shopper has changed their account details
Show Source
Example:
{
    "profileId":"110632",
    "profile":{
        "lastPurchaseDate":"2020-05-08T07:13:55.000Z",
        "dynamicPropertyMapLong":{
        },
        "GDPRProfileP13nConsentDate":null,
        "GDPRProfileP13nConsentGranted":false,
        "secondaryAddresses":{
            "Address":{
                "country":"US",
                "lastName":"ded",
                "types":[
                ],
                "address3":"",
                "city":"www",
                "address2":"www",
                "prefix":"",
                "address1":"wew",
                "postalCode":"12001",
                "companyName":"",
                "county":"",
                "suffix":"",
                "firstName":"cdc",
                "phoneNumber":"9876543210",
                "item-id":null,
                "repositoryId":"121072",
                "faxNumber":"",
                "middleName":"",
                "state":"NY"
            }
        },
        "shippingSurchargePriceList":{
        },
        "firstPurchaseDate":"2020-05-08T07:13:55.000Z",
        "profileType":"b2b_user",
        "loyaltyPrograms":[
        ],
        "lastPurchaseAmount":77.98,
        "registrationDate":"2020-05-08T06:27:13.680Z",
        "sessionOrganization":{
            "id":"300002"
        },
        "lifetimeAOV":77.98,
        "id":"110632",
        "derivedSalePriceList":{
        },
        "homeAddress":{
            "country":"Not available",
            "lastName":null,
            "types":[
            ],
            "address3":null,
            "city":"Not available",
            "address2":null,
            "prefix":null,
            "address1":"Not available",
            "postalCode":"Not available",
            "companyName":null,
            "county":null,
            "suffix":null,
            "firstName":null,
            "phoneNumber":null,
            "item-id":null,
            "repositoryId":"120633",
            "faxNumber":null,
            "middleName":null,
            "state":"Not available"
        },
        "daytimeTelephoneNumber":null,
        "customerContactId":null,
        "taxExempt":false,
        "dynamicPropertyMapBigString":{
        },
        "active":true,
        "lastVisitDate":"2020-05-08T07:38:38.455Z",
        "taxExemptionCode":null,
        "previousVisitDate":"2020-05-08T07:29:27.928Z",
        "version":7,
        "abandonedOrderCount":0,
        "firstName":"test123",
        "defaultCreditCard":null,
        "lifetimeCurrencyCode":"USD",
        "derivedTaxExemptionCode":null,
        "currentOrganization":{
            "id":"300002"
        },
        "secondaryOrganizations":[
            {
                "id":"400001"
            }
        ],
        "shippingAddresses":[
            {
                "country":"US",
                "lastName":"ded",
                "types":[
                ],
                "address3":"",
                "city":"www",
                "address2":"www",
                "prefix":"",
                "address1":"wew",
                "postalCode":"12001",
                "companyName":"",
                "county":"",
                "suffix":"",
                "firstName":"cdc",
                "phoneNumber":"9876543210",
                "item-id":null,
                "repositoryId":"121072",
                "faxNumber":"",
                "middleName":"",
                "state":"NY"
            }
        ],
        "derivedPriceListGroup":{
            "isTaxIncluded":false,
            "endDate":null,
            "displayName":"test price list group",
            "listPriceList":{
            },
            "active":true,
            "isPointsBased":false,
            "locale":"en_GB",
            "basePriceListGroup":null,
            "shippingSurchargePriceList":{
            },
            "deleted":false,
            "taxCalculationType":"doNotCalculateTax",
            "ancestorPriceListGroups":[
            ],
            "salePriceList":{
            },
            "currency":{
                "currencyType":null,
                "symbol":"??",
                "deleted":false,
                "displayName":"British Pound Sterling",
                "fractionalDigits":2,
                "currencyCode":"GBP",
                "numericCode":"826"
            },
            "id":"TEST_PRICE_LIST_GROUP",
            "includeAllProducts":false,
            "startDate":null
        },
        "lastName":"rest123",
        "roles":[
            {
                "name":"Role 1",
                "repositoryId":"role1",
                "description":null,
                "accessRights":[
                    {
                        "displayName":"Custom Access Right",
                        "name":"Custom Access Right",
                        "repositoryId":"customAccessRight",
                        "description":"Custom Access Right",
                        "id":"customAccessRight",
                        "type":"generic"
                    }
                ],
                "id":"role1",
                "type":"role"
            },
            {
                "relativeTo":{
                    "externalOrganizationId":null,
                    "id":"or-100001"
                },
                "function":"buyer",
                "name":"Buyer",
                "repositoryId":"100002",
                "description":null,
                "accessRights":[
                ],
                "id":"100002",
                "type":"organizationalRole"
            }
        ],
        "numberOfOrders":1,
        "locale":"en",
        "login":"aa@example.com",
        "receiveEmailDate":"2020-05-08T06:27:13.573Z",
        "sitePropertiesList":[
            {
                "site":{
                    "id":"siteUS"
                },
                "properties":{
                    "numberOfVisits":4,
                    "GDPRProfileP13nConsentDate":null,
                    "GDPRProfileP13nConsentGranted":false,
                    "receiveEmail":"yes",
                    "receiveEmailDate":"2020-05-08T06:27:13.573Z"
                }
            }
        ],
        "lifetimeSpend":77.98,
        "dynamicPropertyMapString":{
        },
        "email":"aa@example.com",
        "numberOfVisits":4,
        "siteProperties":{
            "siteUS":{
                "numberOfVisits":4,
                "GDPRProfileP13nConsentDate":null,
                "GDPRProfileP13nConsentGranted":false,
                "receiveEmail":"yes",
                "receiveEmailDate":"2020-05-08T06:27:13.573Z"
            }
        },
        "receiveEmail":"yes",
        "priceListGroup":{
            "isTaxIncluded":false,
            "endDate":null,
            "displayName":"STEPPED Test list",
            "listPriceList":{
            },
            "active":true,
            "isPointsBased":false,
            "locale":"en_GB",
            "basePriceListGroup":null,
            "shippingSurchargePriceList":{
            },
            "deleted":false,
            "taxCalculationType":"doNotCalculateTax",
            "ancestorPriceListGroups":[
            ],
            "salePriceList":{
            },
            "currency":{
                "currencyType":null,
                "symbol":"??",
                "deleted":false,
                "displayName":"British Pound Sterling",
                "fractionalDigits":2,
                "currencyCode":"GBP",
                "numericCode":"826"
            },
            "id":"TEST_STEPPED_GBP",
            "includeAllProducts":false,
            "startDate":null
        },
        "dateOfBirth":null,
        "shippingAddress":{
            "country":"US",
            "lastName":"ded",
            "types":[
            ],
            "address3":"",
            "city":"www",
            "address2":"www",
            "prefix":"",
            "address1":"wew",
            "postalCode":"12001",
            "companyName":"",
            "county":"",
            "suffix":"",
            "firstName":"cdc",
            "phoneNumber":"9876543210",
            "item-id":null,
            "repositoryId":"121072",
            "faxNumber":"",
            "middleName":"",
            "state":"NY"
        },
        "firstVisitDate":"2018-12-18T11:31:43.401Z",
        "middleName":null,
        "lastActivity":"2020-05-08T06:27:13.681Z",
        "billingAddress":null,
        "dynamicPropertyMapDouble":{
        },
        "derivedShippingSurchargePriceList":{
        },
        "abandonedOrders":[
        ]
    },
    "siteId":"siteUS",
    "type":"atg.dps.ProfileUpdate"
}
Nested Schema : profile
Type: object
Show Source
Nested Schema : abandonedOrders
Type: object
Set of Abandoned orders
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : currentOrganization
Type: object
The current Organization
Show Source
Nested Schema : defaultCreditCard
Type: object
Show Source
Nested Schema : derivedPriceListGroup
Type: object
Show Source
Nested Schema : derivedSalePriceList
Type: object
Show Source
Nested Schema : derivedShippingSurchargePriceList
Type: object
Show Source
Nested Schema : homeAddress
Type: object
Home address
Show Source
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : parentOrganization
Type: object
The parent Organization
Show Source
Nested Schema : priceListGroup
Type: object
Show Source
Nested Schema : roles
Type: array
List of user roles.
Show Source
Nested Schema : secondaryAddresses
Type: array
List of secondary addresses associated with profile. 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 : secondaryOrganizations
Type: array
List of secondary organizations that need to associate with the user.
Show Source
Nested Schema : sessionOrganization
Type: object
The session Organization
Show Source
Nested Schema : shippingAddress
Type: object
Shipping address
Show Source
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile. 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 : shippingSurchargePriceList
Type: object
Show Source
Nested Schema : siteProperties
Type: object
Site Properties
Show Source
Nested Schema : sitePropertiesList
Type: array
The list of site related properties for the profile
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : cardProps
Type: object
Nested Schema : currency
Type: object
Show Source
Nested Schema : listPriceList
Type: object
Show Source
Nested Schema : salePriceList
Type: object
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : listPriceList
Type: object
Show Source
Nested Schema : salePriceList
Type: object
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : accessRights
Type: array
Access rights associated with this role.
Show Source
Nested Schema : relativeTo
Type: object
Organization in which the role applies. Only returned for organizationalRole.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
Types of address. Like SHIPPING, BILLING
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • This property will be added to webhook payload only if includeChangesOnly property is set to true for the specific webhook. Supported values include CREATE, UPDATE and DELETE. This indicates that the corresponding entity is either created or updated or deleted.
  • ID of the organization to be assigned.
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
Types of address. Like SHIPPING, BILLING
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
The site related properties for the profile
Show Source
Nested Schema : site
Type: object
The site data
Show Source
Back to Top

Response

Supported Media Types

200 Response

No response is returned as this is an event webhook
Body ()
Root Schema : emptyResponse
Show Source
Back to Top