Jump to

• Request
• Response

Shopper Profile Update

post

/ccadmin/v1/webhook/profileUpdate

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

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateProfile_request

Type: object

Show Source

• dateOfBirth: string
  The date of birth of the profile user.
• daytimeTelephoneNumber: string
  The phone Number of the profile.
• defaultBillToAddressIdByOrg: string
  The comma-separated values for default bill-to address IDs corresponding to organizations for the profile. These addresses belong to one of the bill-to addresses of the profile's organizations. This is applicable for B2B profiles.
• defaultShipToAddressIdByOrg: string
  The comma-separated values for default ship-to address IDs corresponding to organizations for the profile. These addresses belong to one of the ship-to addresses of the profile's organizations. This is applicable for B2B profiles.
• dynamicProperty: object dynamicProperty
  Dynamic property name and value.
• email: string
  The email address of the profile.
• firstName: string
  The first name of the profile.
• GDPRProfileP13nConsentGranted: boolean
  Indicates whether the customer has given consent for his/her profile information to be used for personalization purposes. Can be true or false.
• lastName: string
  The last name of the profile.
• login: string
  Login id to be used.
• receiveEmail: string
  Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.
• shippingAddresses: object shippingAddresses
  shipping address of the profile.

{
    "properties":{
        "dynamicProperty":{
            "description":"Dynamic property name and value.",
            "type":"object"
        },
        "lastName":{
            "description":"The last name of the profile.",
            "type":"string"
        },
        "firstName":{
            "description":"The first name of the profile.",
            "type":"string"
        },
        "GDPRProfileP13nConsentGranted":{
            "description":"Indicates whether the customer has given consent for his/her profile information to be used for personalization purposes. Can be true or false.",
            "type":"boolean"
        },
        "defaultBillToAddressIdByOrg":{
            "description":"The comma-separated values for default bill-to address IDs corresponding to organizations for the profile. These addresses belong to one of the bill-to addresses of the profile's organizations. This is applicable for B2B profiles.",
            "type":"string"
        },
        "receiveEmail":{
            "description":"Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.",
            "type":"string"
        },
        "dateOfBirth":{
            "description":"The date of birth of the profile user.",
            "type":"string"
        },
        "login":{
            "description":"Login id to be used.",
            "type":"string"
        },
        "email":{
            "description":"The email address of the profile.",
            "type":"string"
        },
        "daytimeTelephoneNumber":{
            "description":"The phone Number of the profile.",
            "type":"string"
        },
        "shippingAddresses":{
            "description":"shipping address of the profile.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"The last name of the shipping address.",
                    "type":"string"
                },
                "firstName":{
                    "description":"The first name of the shipping address.",
                    "type":"string"
                },
                "country":{
                    "description":"The country of the shipping address.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"The phone Number of the shipping address.",
                    "type":"string"
                },
                "address2":{
                    "description":"The address2 of the shipping address.",
                    "type":"string"
                },
                "city":{
                    "description":"The city of the shipping address.",
                    "type":"string"
                },
                "address1":{
                    "description":"The address1 of the shipping address.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"The postal Code of the shipping address.",
                    "type":"string"
                },
                "county":{
                    "description":"The county of the shipping address.",
                    "type":"string"
                },
                "isDefaultAddress":{
                    "description":"Indicates if its the default shipping address",
                    "type":"boolean"
                },
                "state":{
                    "description":"The state of the shipping address.",
                    "type":"string"
                }
            }
        },
        "defaultShipToAddressIdByOrg":{
            "description":"The comma-separated values for default ship-to address IDs corresponding to organizations for the profile. These addresses belong to one of the ship-to addresses of the profile's organizations. This is applicable for B2B profiles.",
            "type":"string"
        }
    },
    "example":{
        "dynamicPropertyMaritalStatus":"Married",
        "lastName":"Anderson",
        "firstName":"Kim",
        "GDPRProfileP13nConsentGranted":true,
        "defaultBillToAddressIdByOrg":"org1:110028,org2:110029",
        "receiveEmail":"yes",
        "dateOfBirth":"2017-11-14T00:00:00.000Z",
        "email":"[e-mail]",
        "daytimeTelephoneNumber":"212-555-1977",
        "shippingAddresses":[
            {
                "lastName":"Anderson",
                "country":"United States",
                "types":[
                    {
                        "id":"SHIPPING"
                    }
                ],
                "address3":"",
                "address2":"",
                "city":"Syracuse",
                "prefix":"",
                "address1":"21 Cedar Ave",
                "postalCode":"13202",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":false,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "faxNumber":"",
                "middleName":"",
                "state":"New York",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            },
            {
                "lastName":"Anderson",
                "country":"United States",
                "address3":"",
                "address2":"",
                "city":"Montgomery",
                "prefix":"",
                "address1":"21 Cedar Ave",
                "postalCode":"13202",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":true,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "faxNumber":"",
                "middleName":"",
                "state":"New York",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            }
        ],
        "defaultShipToAddressIdByOrg":"org1:130012,org2:130013"
    }
}

Example:

{
    "dynamicPropertyMaritalStatus":"Married",
    "lastName":"Anderson",
    "firstName":"Kim",
    "GDPRProfileP13nConsentGranted":true,
    "defaultBillToAddressIdByOrg":"org1:110028,org2:110029",
    "receiveEmail":"yes",
    "dateOfBirth":"2017-11-14T00:00:00.000Z",
    "email":"[e-mail]",
    "daytimeTelephoneNumber":"212-555-1977",
    "shippingAddresses":[
        {
            "lastName":"Anderson",
            "country":"United States",
            "types":[
                {
                    "id":"SHIPPING"
                }
            ],
            "address3":"",
            "address2":"",
            "city":"Syracuse",
            "prefix":"",
            "address1":"21 Cedar Ave",
            "postalCode":"13202",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":false,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "faxNumber":"",
            "middleName":"",
            "state":"New York",
            "selectedState":"NY",
            "state_ISOCode":"US-NY"
        },
        {
            "lastName":"Anderson",
            "country":"United States",
            "address3":"",
            "address2":"",
            "city":"Montgomery",
            "prefix":"",
            "address1":"21 Cedar Ave",
            "postalCode":"13202",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":true,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "faxNumber":"",
            "middleName":"",
            "state":"New York",
            "selectedState":"NY",
            "state_ISOCode":"US-NY"
        }
    ],
    "defaultShipToAddressIdByOrg":"org1:130012,org2:130013"
}

Nested Schema : dynamicProperty

Type: object

Dynamic property name and value.

Nested Schema : shippingAddresses

Type: object

shipping address of the profile.

Show Source

• address1: string
  The address1 of the shipping address.
• address2: string
  The address2 of the shipping address.
• city: string
  The city of the shipping address.
• country: string
  The country of the shipping address.
• county: string
  The county of the shipping address.
• firstName: string
  The first name of the shipping address.
• isDefaultAddress: boolean
  Indicates if its the default shipping address
• lastName: string
  The last name of the shipping address.
• phoneNumber: string
  The phone Number of the shipping address.
• postalCode: string
  The postal Code of the shipping address.
• state: string
  The state of the shipping address.

{
    "description":"shipping address of the profile.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"The last name of the shipping address.",
            "type":"string"
        },
        "firstName":{
            "description":"The first name of the shipping address.",
            "type":"string"
        },
        "country":{
            "description":"The country of the shipping address.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"The phone Number of the shipping address.",
            "type":"string"
        },
        "address2":{
            "description":"The address2 of the shipping address.",
            "type":"string"
        },
        "city":{
            "description":"The city of the shipping address.",
            "type":"string"
        },
        "address1":{
            "description":"The address1 of the shipping address.",
            "type":"string"
        },
        "postalCode":{
            "description":"The postal Code of the shipping address.",
            "type":"string"
        },
        "county":{
            "description":"The county of the shipping address.",
            "type":"string"
        },
        "isDefaultAddress":{
            "description":"Indicates if its the default shipping address",
            "type":"boolean"
        },
        "state":{
            "description":"The state of the shipping address.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top