addProfileAddress

post

/ccappagent/v1/profiles/{id}/addresses

Add profile address for a shopper. Any B2C user can add profile address. The B2B user needs to have profileAddressManager role in the current organization.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : addProfileAddress_request
Type: object
Show Source
Example:
{
    "address":{
        "country":"US",
        "lastName":"Anderson",
        "address3":"abc",
        "city":"Syracuse",
        "address2":"xyz",
        "prefix":null,
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "jobTitle":"dsfdsf",
        "companyName":null,
        "county":null,
        "suffix":null,
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "faxNumber":null,
        "middleName":null,
        "state":"NY"
    },
    "addressType":"Address12"
}
Nested Schema : address
Type: object
The address object of the profile
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : addProfileAddress_response
Type: object
Show Source
Nested Schema : address
Type: object
The address object of the profile
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "address":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10001"
            }
        ],
        "phoneNumber":"907-385-4412",
        "address2":"",
        "city":"Anchorage",
        "address1":"639 Main St",
        "postalCode":"99501",
        "companyName":"National Discount Auto Parts",
        "repositoryId":"210026",
        "state":"AZ"
    },
    "addressType":"Addr3ess313333312-Profile"
}

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| |------------------|------------------| |22031|Internal error during get profile| |22032|Error occurred due to invalid data| |22033|User is not logged in.| |22000|The profile id passes is null or empty.| |22001|Internal error while getting the profile.| |22002|No profile found with the given id.| |23005|Invalid phone number is specified| |23007|No country is specified| |23008|Postal code is not specified| |23010|City is not specified| |23011|Address line 1 not specified| |100077|One of the dynamic properties is not writable by the Agent user| ||Invalid address type ID {0}| |180106|One or more address type ID is invalid| |
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top