REST API for Oracle Commerce Cloud December 2017

getProfileAddress

get

/ccagent/v1/profiles/{id}/addresses/{addressId}

Get Profile Address specific to the customer profile based on the address Id

Request

Supported Media Types

application/json

Path Parameters

addressId: Type: string

Required: true

The address Id associated to profile.
id: Type: string

Required: true

The customer profile id.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getProfileAddress_response

Properties

address: Type: object address

Additional Properties Allowed:

The address object of the profile
addressType: Type: string

The nickname for the address.

Nested Schema : address

Type: object

The address object of the profile

Properties

address1: Type: string

address line 1 for the address
address2: Type: string

Address line 2 for the address
city: Type: string

city for the address
companyName: Type: string

companyName for the address. It is not mandatory for the profile addresses.
country: Type: string

The country of the address
county: Type: string

county for the address
firstName: Type: string

The first name of the user for whom the address is created. This field can be null also
lastName: Type: string

The last name of the user for whom the address is created. This field can be null also
phoneNumber: Type: string

Phone number of the address
postalCode: Type: string

postalCode for the address
repositoryId: Type: string

Unique Id for the address
state: Type: string

state for the address

Example application/json


{
    "address":{
        "firstName":"tr",
        "lastName":"et",
        "country":"US",
        "phoneNumber":"631-748-6479",
        "address2":"et",
        "city":"te",
        "address1":"et",
        "postalCode":"35005",
        "repositoryId":"130023",
        "state":"AL"
    },
    "addressType":"tertr",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/profiles/se-570031/addresses/130023"
        }
    ]
}

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| |------------------|------------------| |22030|User is not logged in| |22031|Internal error during get profile| |22032|Error occured due to invalid data| |22002|No profile found with profile id| |89103|The current user does not have administrator privileges and is not associated to an account| |100190|Error occurred while attempting to fetch addresses from the repository.| |22038|Invalid Address ID : address is not associated with user profile.|

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

Additional Properties Allowed:

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

Additional Properties Allowed:

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 Response Payload returned by endpoint:

{
  "address": {
    "firstName": "tr",
    "lastName": "et",
    "country": "US",
    "phoneNumber": "631-748-6479",
    "address2": "et",
    "city": "te",
    "address1": "et",
    "postalCode": "35005",
    "repositoryId": "130023",
    "state": "AL"
  },
  "addressType": "tertr",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/profiles/se-570031/addresses/130023"
  }]
}