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(optional): string
  The date of birth of the profile user.
• daytimeTelephoneNumber(optional): string
  The phone Number of the profile.
• email(optional): string
  The email address of the profile.
• firstName(optional): string
  The first name of the profile.
• GDPRProfileP13nConsentGranted(optional): boolean
  If user has given consent for his/her profile information to be used for personalization purposes.
• gender(optional): string
  The gender of the profile user.
• lastName(optional): string
  The last name of the profile.
• newConfirmPassword(optional): string
  Confirmation of the new password. This should match the new password value.
• newPassword(optional): string
  The new password.
• oldPassword(optional): string
  The current password.
• receiveEmail(optional): string
  This is email marketing flag. can be yes or no.
• shippingAddress(optional): object shippingAddress
  Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
• shippingAddresses(optional): array shippingAddresses
  List of shipping addresses associated with profile.

{
    "properties":{
        "lastName":{
            "description":"The last name of the profile.",
            "type":"string"
        },
        "GDPRProfileP13nConsentGranted":{
            "description":"If user has given consent for his/her profile information to be used for personalization purposes.",
            "type":"boolean"
        },
        "gender":{
            "description":"The gender of the profile user.",
            "type":"string"
        },
        "oldPassword":{
            "description":"The current password.",
            "type":"string"
        },
        "receiveEmail":{
            "description":"This is email marketing flag. can be yes or no.",
            "type":"string"
        },
        "newPassword":{
            "description":"The new password.",
            "type":"string"
        },
        "dateOfBirth":{
            "description":"The date of birth of the profile user.",
            "type":"string"
        },
        "newConfirmPassword":{
            "description":"Confirmation of the new password. This should match the new password value.",
            "type":"string"
        },
        "firstName":{
            "description":"The first name of the profile.",
            "type":"string"
        },
        "shippingAddress":{
            "description":"Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"The last name of the shipping address.",
                    "type":"string"
                },
                "country":{
                    "description":"The country code of the shipping address.",
                    "type":"string"
                },
                "types":{
                    "description":"The types tagged to the address",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"repository Id of the address type",
                                "type":"string"
                            }
                        }
                    }
                },
                "address3":{
                    "description":"The address line 3 of the shipping address.",
                    "type":"string"
                },
                "address2":{
                    "description":"The address line 2 of the shipping address.",
                    "type":"string"
                },
                "address1":{
                    "description":"The address line 1 of the shipping address.",
                    "type":"string"
                },
                "prefix":{
                    "description":"The prefix of the shipping address.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"The postal Code of the shipping address.",
                    "type":"string"
                },
                "companyName":{
                    "description":"The company name of the shipping address.",
                    "type":"string"
                },
                "county":{
                    "description":"The county of the shipping address.",
                    "type":"string"
                },
                "selectedCountry":{
                    "description":"The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.",
                    "type":"string"
                },
                "firstName":{
                    "description":"The first name of the shipping address.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"The phone Number of the shipping address.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The repository ID of the shipping address.",
                    "type":"string"
                },
                "alias":{
                    "description":"The alias of the shipping address.",
                    "type":"string"
                },
                "state":{
                    "description":"The state code of the shipping address.",
                    "type":"string"
                },
                "selectedState":{
                    "description":"The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.",
                    "type":"string"
                },
                "state_ISOCode":{
                    "description":"The state ISO alpha-4 code of the shipping address.",
                    "type":"string"
                }
            },
            "required":[
                "lastName",
                "country",
                "address1",
                "postalCode",
                "firstName",
                "state"
            ]
        },
        "email":{
            "description":"The email address of the profile.",
            "type":"string"
        },
        "daytimeTelephoneNumber":{
            "description":"The phone Number of the profile.",
            "type":"string"
        },
        "shippingAddresses":{
            "description":"List of shipping addresses associated with profile.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "lastName":{
                        "description":"The last name of the shipping address.",
                        "type":"string"
                    },
                    "country":{
                        "description":"The country of the shipping address.",
                        "type":"string"
                    },
                    "types":{
                        "description":"The types tagged to the address",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"repository Id of the address type",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "address3":{
                        "description":"The address line 3 of the shipping address.",
                        "type":"string"
                    },
                    "address2":{
                        "description":"The address line 2 of the shipping address.",
                        "type":"string"
                    },
                    "city":{
                        "description":"The city of the shipping address.",
                        "type":"string"
                    },
                    "address1":{
                        "description":"The address line 1 of the shipping address.",
                        "type":"string"
                    },
                    "prefix":{
                        "description":"The prefix of the shipping address.",
                        "type":"string"
                    },
                    "postalCode":{
                        "description":"The postal Code of the shipping address.",
                        "type":"string"
                    },
                    "companyName":{
                        "description":"The company name of the shipping address.",
                        "type":"string"
                    },
                    "county":{
                        "description":"The county code of the shipping address.",
                        "type":"string"
                    },
                    "isDefaultAddress":{
                        "description":"Whether to store this address in the default shipping address slot.",
                        "type":"boolean"
                    },
                    "selectedCountry":{
                        "description":"The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.",
                        "type":"string"
                    },
                    "firstName":{
                        "description":"The first name of the shipping address.",
                        "type":"string"
                    },
                    "phoneNumber":{
                        "description":"The phone Number of the shipping address.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repository ID of the shipping address.",
                        "type":"string"
                    },
                    "alias":{
                        "description":"The alias of the shipping address.",
                        "type":"string"
                    },
                    "state":{
                        "description":"The state code of the shipping address.",
                        "type":"string"
                    },
                    "selectedState":{
                        "description":"The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.",
                        "type":"string"
                    },
                    "state_ISOCode":{
                        "description":"The state ISO alpha-4 code of the shipping address.",
                        "type":"string"
                    }
                },
                "required":[
                    "lastName",
                    "country",
                    "city",
                    "address1",
                    "postalCode",
                    "firstName",
                    "state"
                ]
            }
        }
    },
    "example":{
        "firstName":"Jack",
        "lastName":"Black",
        "GDPRProfileP13nConsentGranted":false,
        "gender":"male",
        "receiveEmail":"yes",
        "dateOfBirth":"null",
        "locale":"en",
        "email":"[e-mail]",
        "shippingAddresses":[
            {
                "lastName":"Black",
                "country":"United States",
                "types":[
                    {
                        "id":"ss-100002"
                    }
                ],
                "address3":"",
                "address2":"",
                "city":"Wake Forest",
                "prefix":"",
                "address1":"405 Example Street",
                "defaultCountryCode":"US",
                "postalCode":"27587",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":true,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"Jack",
                "phoneNumber":"555123456",
                "alias":"Address",
                "faxNumber":"",
                "middleName":"",
                "state":"North Carolina",
                "selectedState":"NC",
                "state_ISOCode":"US-NC"
            },
            {
                "lastName":"Hill",
                "country":"United States",
                "types":[
                    {
                        "id":"ss-100002"
                    }
                ],
                "address3":"",
                "address2":"",
                "city":"Wake Forest",
                "prefix":"",
                "address1":"415 Example Road",
                "defaultCountryCode":"US",
                "postalCode":"27587",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":false,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"Jill",
                "phoneNumber":"55512345",
                "alias":"Address##0",
                "faxNumber":"",
                "middleName":"",
                "state":"North Carolina",
                "selectedState":"NC",
                "state_ISOCode":"US-NC"
            }
        ]
    }
}

Example:

{
    "firstName":"Jack",
    "lastName":"Black",
    "GDPRProfileP13nConsentGranted":false,
    "gender":"male",
    "receiveEmail":"yes",
    "dateOfBirth":"null",
    "locale":"en",
    "email":"[e-mail]",
    "shippingAddresses":[
        {
            "lastName":"Black",
            "country":"United States",
            "types":[
                {
                    "id":"ss-100002"
                }
            ],
            "address3":"",
            "address2":"",
            "city":"Wake Forest",
            "prefix":"",
            "address1":"405 Example Street",
            "defaultCountryCode":"US",
            "postalCode":"27587",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":true,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Jack",
            "phoneNumber":"555123456",
            "alias":"Address",
            "faxNumber":"",
            "middleName":"",
            "state":"North Carolina",
            "selectedState":"NC",
            "state_ISOCode":"US-NC"
        },
        {
            "lastName":"Hill",
            "country":"United States",
            "types":[
                {
                    "id":"ss-100002"
                }
            ],
            "address3":"",
            "address2":"",
            "city":"Wake Forest",
            "prefix":"",
            "address1":"415 Example Road",
            "defaultCountryCode":"US",
            "postalCode":"27587",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":false,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Jill",
            "phoneNumber":"55512345",
            "alias":"Address##0",
            "faxNumber":"",
            "middleName":"",
            "state":"North Carolina",
            "selectedState":"NC",
            "state_ISOCode":"US-NC"
        }
    ]
}

Nested Schema : shippingAddress

Type: object

Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).

Show Source

• address1: string
  The address line 1 of the shipping address.
• address2(optional): string
  The address line 2 of the shipping address.
• address3(optional): string
  The address line 3 of the shipping address.
• alias(optional): string
  The alias of the shipping address.
• companyName(optional): string
  The company name of the shipping address.
• country: string
  The country code of the shipping address.
• county(optional): string
  The county of the shipping address.
• firstName: string
  The first name of the shipping address.
• lastName: string
  The last name of the shipping address.
• phoneNumber(optional): string
  The phone Number of the shipping address.
• postalCode: string
  The postal Code of the shipping address.
• prefix(optional): string
  The prefix of the shipping address.
• repositoryId(optional): string
  The repository ID of the shipping address.
• selectedCountry(optional): string
  The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.
• selectedState(optional): string
  The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.
• state: string
  The state code of the shipping address.
• state_ISOCode(optional): string
  The state ISO alpha-4 code of the shipping address.
• types(optional): array types
  The types tagged to the address

{
    "description":"Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"The last name of the shipping address.",
            "type":"string"
        },
        "country":{
            "description":"The country code of the shipping address.",
            "type":"string"
        },
        "types":{
            "description":"The types tagged to the address",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"repository Id of the address type",
                        "type":"string"
                    }
                }
            }
        },
        "address3":{
            "description":"The address line 3 of the shipping address.",
            "type":"string"
        },
        "address2":{
            "description":"The address line 2 of the shipping address.",
            "type":"string"
        },
        "address1":{
            "description":"The address line 1 of the shipping address.",
            "type":"string"
        },
        "prefix":{
            "description":"The prefix of the shipping address.",
            "type":"string"
        },
        "postalCode":{
            "description":"The postal Code of the shipping address.",
            "type":"string"
        },
        "companyName":{
            "description":"The company name of the shipping address.",
            "type":"string"
        },
        "county":{
            "description":"The county of the shipping address.",
            "type":"string"
        },
        "selectedCountry":{
            "description":"The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.",
            "type":"string"
        },
        "firstName":{
            "description":"The first name of the shipping address.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"The phone Number of the shipping address.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository ID of the shipping address.",
            "type":"string"
        },
        "alias":{
            "description":"The alias of the shipping address.",
            "type":"string"
        },
        "state":{
            "description":"The state code of the shipping address.",
            "type":"string"
        },
        "selectedState":{
            "description":"The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.",
            "type":"string"
        },
        "state_ISOCode":{
            "description":"The state ISO alpha-4 code of the shipping address.",
            "type":"string"
        }
    },
    "required":[
        "lastName",
        "country",
        "address1",
        "postalCode",
        "firstName",
        "state"
    ]
}

Nested Schema : shippingAddresses

Type: array

List of shipping addresses associated with profile.

Show Source

• Array of: object items

{
    "description":"List of shipping addresses associated with profile.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "lastName":{
                "description":"The last name of the shipping address.",
                "type":"string"
            },
            "country":{
                "description":"The country of the shipping address.",
                "type":"string"
            },
            "types":{
                "description":"The types tagged to the address",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"repository Id of the address type",
                            "type":"string"
                        }
                    }
                }
            },
            "address3":{
                "description":"The address line 3 of the shipping address.",
                "type":"string"
            },
            "address2":{
                "description":"The address line 2 of the shipping address.",
                "type":"string"
            },
            "city":{
                "description":"The city of the shipping address.",
                "type":"string"
            },
            "address1":{
                "description":"The address line 1 of the shipping address.",
                "type":"string"
            },
            "prefix":{
                "description":"The prefix of the shipping address.",
                "type":"string"
            },
            "postalCode":{
                "description":"The postal Code of the shipping address.",
                "type":"string"
            },
            "companyName":{
                "description":"The company name of the shipping address.",
                "type":"string"
            },
            "county":{
                "description":"The county code of the shipping address.",
                "type":"string"
            },
            "isDefaultAddress":{
                "description":"Whether to store this address in the default shipping address slot.",
                "type":"boolean"
            },
            "selectedCountry":{
                "description":"The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.",
                "type":"string"
            },
            "firstName":{
                "description":"The first name of the shipping address.",
                "type":"string"
            },
            "phoneNumber":{
                "description":"The phone Number of the shipping address.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The repository ID of the shipping address.",
                "type":"string"
            },
            "alias":{
                "description":"The alias of the shipping address.",
                "type":"string"
            },
            "state":{
                "description":"The state code of the shipping address.",
                "type":"string"
            },
            "selectedState":{
                "description":"The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.",
                "type":"string"
            },
            "state_ISOCode":{
                "description":"The state ISO alpha-4 code of the shipping address.",
                "type":"string"
            }
        },
        "required":[
            "lastName",
            "country",
            "city",
            "address1",
            "postalCode",
            "firstName",
            "state"
        ]
    }
}

Nested Schema : types

Type: array

The types tagged to the address

Show Source

• Array of: object items

{
    "description":"The types tagged to the address",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"repository Id of the address type",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  repository Id of the address type

{
    "type":"object",
    "properties":{
        "id":{
            "description":"repository Id of the address type",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address1: string
  The address line 1 of the shipping address.
• address2(optional): string
  The address line 2 of the shipping address.
• address3(optional): string
  The address line 3 of the shipping address.
• alias(optional): string
  The alias of the shipping address.
• city: string
  The city of the shipping address.
• companyName(optional): string
  The company name of the shipping address.
• country: string
  The country of the shipping address.
• county(optional): string
  The county code of the shipping address.
• firstName: string
  The first name of the shipping address.
• isDefaultAddress(optional): boolean
  Whether to store this address in the default shipping address slot.
• lastName: string
  The last name of the shipping address.
• phoneNumber(optional): string
  The phone Number of the shipping address.
• postalCode: string
  The postal Code of the shipping address.
• prefix(optional): string
  The prefix of the shipping address.
• repositoryId(optional): string
  The repository ID of the shipping address.
• selectedCountry(optional): string
  The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.
• selectedState(optional): string
  The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.
• state: string
  The state code of the shipping address.
• state_ISOCode(optional): string
  The state ISO alpha-4 code of the shipping address.
• types(optional): array types
  The types tagged to the address

{
    "type":"object",
    "properties":{
        "lastName":{
            "description":"The last name of the shipping address.",
            "type":"string"
        },
        "country":{
            "description":"The country of the shipping address.",
            "type":"string"
        },
        "types":{
            "description":"The types tagged to the address",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"repository Id of the address type",
                        "type":"string"
                    }
                }
            }
        },
        "address3":{
            "description":"The address line 3 of the shipping address.",
            "type":"string"
        },
        "address2":{
            "description":"The address line 2 of the shipping address.",
            "type":"string"
        },
        "city":{
            "description":"The city of the shipping address.",
            "type":"string"
        },
        "address1":{
            "description":"The address line 1 of the shipping address.",
            "type":"string"
        },
        "prefix":{
            "description":"The prefix of the shipping address.",
            "type":"string"
        },
        "postalCode":{
            "description":"The postal Code of the shipping address.",
            "type":"string"
        },
        "companyName":{
            "description":"The company name of the shipping address.",
            "type":"string"
        },
        "county":{
            "description":"The county code of the shipping address.",
            "type":"string"
        },
        "isDefaultAddress":{
            "description":"Whether to store this address in the default shipping address slot.",
            "type":"boolean"
        },
        "selectedCountry":{
            "description":"The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.",
            "type":"string"
        },
        "firstName":{
            "description":"The first name of the shipping address.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"The phone Number of the shipping address.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository ID of the shipping address.",
            "type":"string"
        },
        "alias":{
            "description":"The alias of the shipping address.",
            "type":"string"
        },
        "state":{
            "description":"The state code of the shipping address.",
            "type":"string"
        },
        "selectedState":{
            "description":"The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.",
            "type":"string"
        },
        "state_ISOCode":{
            "description":"The state ISO alpha-4 code of the shipping address.",
            "type":"string"
        }
    },
    "required":[
        "lastName",
        "country",
        "city",
        "address1",
        "postalCode",
        "firstName",
        "state"
    ]
}

Nested Schema : types

Type: array

The types tagged to the address

Show Source

• Array of: object items

{
    "description":"The types tagged to the address",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"repository Id of the address type",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  repository Id of the address type

{
    "type":"object",
    "properties":{
        "id":{
            "description":"repository Id of the address type",
            "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