Oracle Commerce Cloud October 2017

updateProfile

put

/ccagent/v1/profiles/{id}

Update Profile. Updates customer name, email address, phone number, shipping address and email marketing flag status of the profile depending on the profile ID. Dynamic Properties of profile can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue"). Takes additonal header parameter x-ccsite corresponding to which site specific properties should be updated. If x-ccsite value is not provided, it indicates default site.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The customer profile id.

Header Parameters

x-ccsite: Type: string

the site id corresponding to which site specific properties should be updated

Body Parameter

Root Schema : updateProfile_request

Example


{
    "dynamicPropertyMaritalStatus":"Married",
    "lastName":"Anderson",
    "firstName":"Kim",
    "receiveEmail":"yes",
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977",
    "shippingAddresses":[
        {
            "lastName":"Anderson",
            "country":"United States",
            "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"
        }
    ]
}

Properties

daytimeTelephoneNumber: Type: string

The phone Number of the profile.
email: Type: string

The email address of the profile.
firstName: Type: string

The first name of the profile.
lastName: Type: string

The last name of the profile.
login: Type: string

Login id to be used.
receiveEmail: Type: string

Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.
shippingAddresses: Type: object shippingAddresses

shipping address of the profile.

Nested Schema : shippingAddresses

Type: object

shipping address of the profile.

Properties

address1: Type: string

The address1 of the shipping address.
address2: Type: string

The address2 of the shipping address.
city: Type: string

The city of the shipping address.
country: Type: string

The country of the shipping address.
county: Type: string

The county of the shipping address.
firstName: Type: string

The first name of the shipping address.
lastName: Type: string

The last name of the shipping address.
phoneNumber: Type: string

The phone Number of the shipping address.
postalCode: Type: string

The postal Code of the shipping address.
state: Type: string

The state of the shipping address.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateProfile_response

Properties

contactBillingAddress: Type: object contactBillingAddress

Required: true

The default billing address for B2B contact.
contactShippingAddress: Type: object contactShippingAddress

The default shipping address for B2B contact
daytimeTelephoneNumber: Type: string

The phone Number of the profile.
dynamicProperties: Type: array dynamicProperties

Read-only list of dynamic properties associated with profile along with meta-data.
email: Type: string

The email address of the profile.
firstName: Type: string

The first name of the profile.
id: Type: string

The id of the profile to retrieve.
lastName: Type: string

The last name of the profile.
profileType: Type: string

The type of the user. Possible values are b2b_user and b2c_user.
receiveEmail: Type: string

Indicates whether the customer should receive marketing emails on the current site.
secondaryAddresses: Type: object secondaryAddresses

Required: true

Secondary addresses for B2B contact.
shippingAddress: Type: object shippingAddress

Default shipping address of the profile
shippingAddresses: Type: array shippingAddresses

The shipping addresses associated with the customer profile

Nested Schema : contactBillingAddress

Type: object

The default billing address for B2B contact.

Properties

address1: Type: string

Address line 1 for this billing address.
address2: Type: string

Address line 2 for this billing address.
address3: Type: string

Address line 3 for this billing address.
city: Type: string

City for this billing address.
companyName: Type: string

Company name for this billing address.
country: Type: string

Country for this billing address.
county: Type: string

County for this billing address.
email: Type: string

Email for this billing address.
faxNumber: Type: string

Fax number for this billing address.
firstName: Type: string

First name for this billing address.
jobTitle: Type: string

Job title for this billing address.
lastName: Type: string

Last name for this billing address.
middleName: Type: string

Middle name for this billing address.
phoneNumber: Type: string

Phone number for this billing address.
postalCode: Type: string

Postal code for this billing address.
prefix: Type: string

Prefix for this billing address.
state: Type: string

State for this billing address.
suffix: Type: string

Suffix for this billing address.

Nested Schema : contactShippingAddress

Type: object

The default shipping address for B2B contact

Properties

address1: Type: string

The address line 1 in the shipping address.
address2: Type: string

The address line 2 in the shipping address.
city: Type: string

The city in the shipping address record.
country: Type: string

The country in the shipping address record.
county: Type: string

The county in the shipping address.
firstName: Type: string

The first name in the shipping address.
lastName: Type: string

The last name in the shipping address.
phoneNumber: Type: string

The phone number in the shipping address.
postalCode: Type: string

The postal code in the shipping address.
repositoryId: Type: string

The repository id of the shipping address record.
state: Type: string

The state in the shipping address.

Nested Schema : dynamicProperties

Type: array

Read-only list of dynamic properties associated with profile along with meta-data.

Items

Type: object items

Nested Schema : secondaryAddresses

Type: object

Secondary addresses for B2B contact.

Properties

address1: Type: string

Address line 1 for this address.
address2: Type: string

Address line 2 for this address.
address3: Type: string

Address line 3 for this address.
city: Type: string

City for this address.
companyName: Type: string

Company name for this address.
country: Type: string

Country for this address.
county: Type: string

County for this address.
email: Type: string

Email for this address.
faxNumber: Type: string

Fax number for this address.
firstName: Type: string

First name for this address.
jobTitle: Type: string

Job title for this address.
lastName: Type: string

Last name for this address.
middleName: Type: string

Middle name for this address.
phoneNumber: Type: string

Phone number for this address.
postalCode: Type: string

Postal code for this address.
prefix: Type: string

Prefix for this address.
state: Type: string

State for this address.
suffix: Type: string

Suffix for this address.

Nested Schema : shippingAddress

Type: object

Default shipping address of the profile

Properties

address1: Type: string

The address1 of the shipping address.
address2: Type: string

The address2 of the shipping address.
city: Type: string

The city of the shipping address.
country: Type: string

The country of the shipping address.
county: Type: string

The county of the shipping address.
firstName: Type: string

The first name of the shipping address.
lastName: Type: string

The last name of the shipping address.
phoneNumber: Type: string

The phone Number of the shipping address.
postalCode: Type: string

The postal Code of the shipping address.
repositoryId: Type: string

The id of the shipping address.
state: Type: string

The state of the shipping address.

Nested Schema : shippingAddresses

Type: array

The shipping addresses associated with the customer profile

Items

Type: object items

Nested Schema : items

Type: object

Properties

id: Type: string

The ID of the dynamic property.
type: Type: string

The type of the dynamic property. Supported types are boolean, date, float, string, timestamp, enumerated, big string.
value: Type: string

The value of the dynamic property.

Nested Schema : items

Type: object

Properties

address1: Type: string

The address line 1 in the shipping address.
address2: Type: string

The address line 2 in the shipping address.
city: Type: string

The city in the shipping address record.
companyName: Type: string

The company name of the person in the shipping address
country: Type: string

The country in the shipping address record.
county: Type: string

The county in the shipping address.
faxNumber: Type: string

The fax number in the shipping address
firstName: Type: string

The first name in the shipping address.
isDefaultAddress: Type: boolean

Indicates if its the default shipping address
jobTitle: Type: string

The job title of the person in the shipping address
lastName: Type: string

The last name in the shipping address.
middleName: Type: string

The middle name in the shipping address.
phoneNumber: Type: string

The phone number in the shipping address.
postalCode: Type: string

The postal code in the shipping address.
repositoryId: Type: string

The repository id of the shipping address record.
selectedCountry: Type: string

The selected country in the shipping address
selectedState: Type: string

The selected state in the shipping address
state: Type: string

The state in the shipping address.
state_ISOCode: Type: string

The state ISO code in the shipping address
suffix: Type: string

The suffix of the person in the shipping address.

Example application/json


{
    "lastName":"Anderson",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyMaritalStatus",
            "label":"Marital Status",
            "type":"string",
            "value":"Married"
        }
    ],
    "contactBillingAddress":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "country":"US",
        "phoneNumber":"212-555-2150",
        "address2":null,
        "city":"Buffalo",
        "address1":"451 Brooks Ave",
        "postalCode":"14201",
        "county":null,
        "repositoryId":"se-990031",
        "state":"NY"
    },
    "receiveEmail":"yes",
    "secondaryAddresses":{
        "Work":{
            "lastName":"Anderson",
            "firstName":"Kim",
            "country":"US",
            "phoneNumber":"212-555-2150",
            "address2":null,
            "city":"Buffalo",
            "address1":"451 Brooks Ave",
            "postalCode":"14201",
            "county":null,
            "repositoryId":"se-970031",
            "state":"NY"
        },
        "Mom' s house":{
            "lastName":"Anderson",
            "firstName":"Dolores",
            "country":"US",
            "phoneNumber":"212-555-4321",
            "address2":null,
            "city":"Dewitt",
            "address1":"41 Wexford Rd ",
            "postalCode":"13214",
            "county":null,
            "repositoryId":"se-140010",
            "state":"NY"
        },
        "Home":{
            "lastName":"dd",
            "firstName":"sdf",
            "country":"US",
            "phoneNumber":"1231231231",
            "address2":"f",
            "city":"f",
            "address1":"dd",
            "postalCode":"36123",
            "county":null,
            "repositoryId":"se-980031",
            "state":"AL"
        }
    },
    "contactShippingAddress":{
        "lastName":"dd",
        "firstName":"sdf",
        "country":"US",
        "phoneNumber":"1231231231",
        "address2":"f",
        "city":"f",
        "address1":"dd",
        "postalCode":"36123",
        "county":null,
        "repositoryId":"se-980031",
        "state":"AL"
    },
    "firstName":"Kim",
    "profileType":"b2b_user",
    "repositoryId":"120117",
    "shippingAddress":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "country":"US",
        "phoneNumber":"212-555-1977",
        "address2":"",
        "city":"Montgomery",
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "county":null,
        "repositoryId":"142021",
        "state":"NY"
    },
    "id":"120117",
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977",
    "shippingAddresses":[
        {
            "lastName":"Anderson",
            "country":"United States",
            "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"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |200012|please provide valid input| |23010|City not specified in shipping address| |23011|Address line 1 not specified in shipping address| |22000|The profile id passes is null or empty.| |23012|No last name specified in shipping address| |22001|Internal error while getting the profile.| |23013|No first name specified in shipping address| |22002|No profile found with the given id.| |23015|Phone number not specified in shipping address| |23005|Invalid phone number in shipping address| |23007|No country specified in shipping address| |23008|Postal code not specified in shipping address|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "dynamicPropertyMaritalStatus": "Married",
  "lastName": "Anderson",
  "firstName": "Kim",
  "receiveEmail": "yes",
  "email": "kim@example.com",
  "daytimeTelephoneNumber": "212-555-1977",
  "shippingAddresses": [
    {
      "lastName": "Anderson",
      "country": "United States",
      "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"
    }
  ]
}

Sample Response Payload returned by endpoint:

{
  "lastName": "Anderson",
  "dynamicProperties": [{
    "id": "dynamicPropertyMaritalStatus",
    "label": "Marital Status",
    "type": "string",
    "value": "Married"
  }],
  "contactBillingAddress": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "country": "US",
    "phoneNumber": "212-555-2150",
    "address2": null,
    "city": "Buffalo",
    "address1": "451 Brooks Ave",
    "postalCode": "14201",
    "county": null,
    "repositoryId": "se-990031",
    "state": "NY"
  },
  "receiveEmail": "yes",
  "secondaryAddresses": {
    "Work": {
      "lastName": "Anderson",
      "firstName": "Kim",
      "country": "US",
      "phoneNumber": "212-555-2150",
      "address2": null,
      "city": "Buffalo",
      "address1": "451 Brooks Ave",
      "postalCode": "14201",
      "county": null,
      "repositoryId": "se-970031",
      "state": "NY"
    },
    "Mom' s house": {
      "lastName": "Anderson",
      "firstName": "Dolores",
      "country": "US",
      "phoneNumber": "212-555-4321",
      "address2": null,
      "city": "Dewitt",
      "address1": "41 Wexford Rd ",
      "postalCode": "13214",
      "county": null,
      "repositoryId": "se-140010",
      "state": "NY"
    },
    "Home": {
      "lastName": "dd",
      "firstName": "sdf",
      "country": "US",
      "phoneNumber": "1231231231",
      "address2": "f",
      "city": "f",
      "address1": "dd",
      "postalCode": "36123",
      "county": null,
      "repositoryId": "se-980031",
      "state": "AL"
    }
  },
  "contactShippingAddress": {
    "lastName": "dd",
    "firstName": "sdf",
    "country": "US",
    "phoneNumber": "1231231231",
    "address2": "f",
    "city": "f",
    "address1": "dd",
    "postalCode": "36123",
    "county": null,
    "repositoryId": "se-980031",
    "state": "AL"
  },
  "firstName": "Kim",
  "profileType": "b2b_user",
  "repositoryId": "120117",
  "shippingAddress": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "country": "US",
    "phoneNumber": "212-555-1977",
    "address2": "",
    "city": "Montgomery",
    "address1": "21 Cedar Ave",
    "postalCode": "13202",
    "county": null,
    "repositoryId": "142021",
    "state": "NY"
  },
  "id": "120117",
  "email": "kim@example.com",
  "daytimeTelephoneNumber": "212-555-1977",
  "shippingAddresses": [
    {
      "lastName": "Anderson",
      "country": "United States",
      "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"
    }
  ]
}