1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Webhook
  4. Shopper Profile Create

Shopper Profile Create

post

/ccadmin/v1/webhook/profile

The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.

Request

Supported Media Types
Body ()
This Event is triggered when a profile is created/updated
Root Schema : profile_request
Type: object
This Event is triggered when a profile is created/updated
Show Source
Example:
{
    "profileId":"160004",
    "profile":{
        "lastPurchaseDate":null,
        "dynamicPropertyMapLong":{
        },
        "GDPRProfileP13nConsentDate":"2018-01-01T00:00:00.000Z",
        "GDPRProfileP13nConsentGranted":true,
        "secondaryAddresses":{
        },
        "shippingSurchargePriceList":null,
        "firstPurchaseDate":null,
        "profileType":null,
        "loyaltyPrograms":[
        ],
        "lastPurchaseAmount":0,
        "registrationDate":"2017-09-14T07:30:12.428Z",
        "sessionOrganization":null,
        "id":"160004",
        "lifetimeAOV":0,
        "daytimeTelephoneNumber":null,
        "derivedSalePriceList":null,
        "homeAddress":{
            "country":null,
            "lastName":null,
            "address3":null,
            "city":null,
            "address2":null,
            "prefix":null,
            "address1":null,
            "companyName":null,
            "postalCode":null,
            "county":null,
            "suffix":null,
            "externalAddressId":"abcTest",
            "firstName":null,
            "phoneNumber":null,
            "item-id":null,
            "repositoryId":"180004",
            "faxNumber":null,
            "middleName":null,
            "state":null
        },
        "customerContactId":"CRMID_12345",
        "taxExempt":false,
        "dynamicPropertyMapBigString":{
        },
        "active":true,
        "previousVisitDate":null,
        "lastVisitDate":null,
        "taxExemptionCode":null,
        "version":7,
        "abandonedOrderCount":0,
        "firstName":"SepNew",
        "defaultCreditCard":null,
        "creditCards":{
        },
        "derivedTaxExemptionCode":null,
        "currentOrganization":null,
        "secondaryOrganizations":[
        ],
        "shippingAddresses":[
        ],
        "derivedPriceListGroup":null,
        "lastName":"SepNew",
        "roles":[
            {
                "associations":[
                    {
                        "relatedItemId":null,
                        "type":"global"
                    }
                ],
                "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",
                "category":{
                    "displayName":"Custom Roles",
                    "repositoryId":"customRoleCategory",
                    "id":"customRoleCategory"
                }
            },
            {
                "associations":[
                    {
                        "relatedItemId":"or-100001",
                        "type":"organization"
                    }
                ],
                "relativeTo":{
                    "externalOrganizationId":null,
                    "id":"or-100001"
                },
                "function":"buyer",
                "name":"Buyer",
                "repositoryId":"100002",
                "description":null,
                "accessRights":[
                ],
                "id":"100002",
                "type":"organizationalRole",
                "category":{
                    "displayName":"Storefront Roles",
                    "repositoryId":"storefrontRoleCategory",
                    "id":"storefrontRoleCategory"
                }
            }
        ],
        "numberOfOrders":0,
        "locale":"en",
        "login":"example@example.com",
        "receiveEmailDate":"2018-01-01T00:00:00.000Z",
        "sitePropertiesList":[
            {
                "site":{
                    "id":"100001"
                },
                "properties":{
                    "GDPRProfileP13nConsentDate":"2018-01-01T00:00:00.000Z",
                    "GDPRProfileP13nConsentGranted":true,
                    "receiveEmail":"no",
                    "receiveEmailDate":"2018-01-01T00:00:00.000Z"
                }
            },
            {
                "site":{
                    "id":"100002"
                },
                "properties":{
                    "GDPRProfileP13nConsentDate":"2018-01-01T00:00:00.000Z",
                    "GDPRProfileP13nConsentGranted":true,
                    "receiveEmail":"no",
                    "receiveEmailDate":"2018-01-01T00:00:00.000Z"
                }
            },
            {
                "site":{
                    "id":"siteUS"
                },
                "properties":{
                    "GDPRProfileP13nConsentDate":"2018-01-01T00:00:00.000Z",
                    "GDPRProfileP13nConsentGranted":true,
                    "receiveEmail":"no",
                    "receiveEmailDate":"2018-01-01T00:00:00.000Z"
                }
            }
        ],
        "lifetimeSpend":0,
        "dynamicPropertyMapString":{
        },
        "email":"example@example.com",
        "siteProperties":{
            "100001":{
                "receiveEmail":"no"
            },
            "100002":{
                "receiveEmail":"no"
            },
            "siteUS":{
                "receiveEmail":"no"
            }
        },
        "comments":[
        ],
        "priceListGroup":null,
        "receiveEmail":"no",
        "dateOfBirth":null,
        "shippingAddress":null,
        "lastActivity":"2017-09-14T07:30:12.428Z",
        "middleName":null,
        "billingAddress":null,
        "derivedShippingSurchargePriceList":null,
        "dynamicPropertyMapDouble":{
        },
        "abandonedOrders":[
        ]
    },
    "siteId":"100002",
    "type":"atg.dps.ProfileUpdate"
}
Nested Schema : profile
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : comments
Type: array
the notes on the customer.
Show Source
Nested Schema : currentOrganization
Type: object
The current Organization
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 : relativeTo
Type: array
If not provided organization id will be cosidered as its parent organization ID.
Show Source
Nested Schema : roles
Type: array
List of user roles.
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 : sitePropertiesList
Type: array
The list of site related properties for the profile
Show Source
Nested Schema : items
Type: object
The info of the customer
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 : 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
  • Organization ID of the role to be assigned.
Nested Schema : items
Type: object
Show Source
Nested Schema : accessRights
Type: array
Access rights associated with this role.
Show Source
Nested Schema : associations
Type: array
Show Source
Nested Schema : category
Type: object
Category of the 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
  • It is the organization id to which role is associated. If the role is to be assigned in organization scope the relatedItemId is required and if the role is global scope then it should be null
  • If the role is to be assigned in organization scope the type is (organization) and if the role is global scope the type is (global).
Nested Schema : items
Type: object
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