Jump to

• Request
• Response

getProfileAddress

get

/ccapp/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: string
  The address Id associated to profile.
• id: string
  The customer profile id.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getProfileAddress_response

Type: object

Show Source

• address(optional): object address
  The address object of the profile
• addressType(optional): string
  The nickname for the address.

{
    "properties":{
        "address":{
            "description":"The address object of the profile",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"The last name of the user for whom the address is created. This field can be null also",
                    "type":"string"
                },
                "country":{
                    "description":"The country of the address",
                    "type":"string"
                },
                "types":{
                    "description":"The types tagged to the address",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "displayName":{
                                "description":"The name of the address type",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"repository Id of the address type",
                                "type":"string"
                            },
                            "id":{
                                "description":"repository Id of the address type",
                                "type":"string"
                            }
                        }
                    }
                },
                "address2":{
                    "description":"Address line 2 for the address",
                    "type":"string"
                },
                "city":{
                    "description":"city for the address",
                    "type":"string"
                },
                "address1":{
                    "description":"address line 1 for the address",
                    "type":"string"
                },
                "postalCode":{
                    "description":"postalCode for the address",
                    "type":"string"
                },
                "companyName":{
                    "description":"companyName for the address. It is not mandatory for the profile addresses.",
                    "type":"string"
                },
                "county":{
                    "description":"county for the address",
                    "type":"string"
                },
                "dynamicProperty":{
                    "description":"The value of the dynamic Property",
                    "type":"object"
                },
                "firstName":{
                    "description":"The first name of the user for whom the address is created. This field can be null also",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number of the address",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Unique Id for the address",
                    "type":"string"
                },
                "state":{
                    "description":"state for the address",
                    "type":"string"
                }
            }
        },
        "addressType":{
            "description":"The nickname for the address.",
            "type":"string"
        }
    }
}

Nested Schema : address

Type: object

The address object of the profile

Show Source

• address1(optional): string
  address line 1 for the address
• address2(optional): string
  Address line 2 for the address
• city(optional): string
  city for the address
• companyName(optional): string
  companyName for the address. It is not mandatory for the profile addresses.
• country(optional): string
  The country of the address
• county(optional): string
  county for the address
• dynamicProperty(optional): object dynamicProperty
  The value of the dynamic Property
• firstName(optional): string
  The first name of the user for whom the address is created. This field can be null also
• lastName(optional): string
  The last name of the user for whom the address is created. This field can be null also
• phoneNumber(optional): string
  Phone number of the address
• postalCode(optional): string
  postalCode for the address
• repositoryId(optional): string
  Unique Id for the address
• state(optional): string
  state for the address
• types(optional): array types
  The types tagged to the address

{
    "description":"The address object of the profile",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"The last name of the user for whom the address is created. This field can be null also",
            "type":"string"
        },
        "country":{
            "description":"The country of the address",
            "type":"string"
        },
        "types":{
            "description":"The types tagged to the address",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"The name of the address type",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"repository Id of the address type",
                        "type":"string"
                    },
                    "id":{
                        "description":"repository Id of the address type",
                        "type":"string"
                    }
                }
            }
        },
        "address2":{
            "description":"Address line 2 for the address",
            "type":"string"
        },
        "city":{
            "description":"city for the address",
            "type":"string"
        },
        "address1":{
            "description":"address line 1 for the address",
            "type":"string"
        },
        "postalCode":{
            "description":"postalCode for the address",
            "type":"string"
        },
        "companyName":{
            "description":"companyName for the address. It is not mandatory for the profile addresses.",
            "type":"string"
        },
        "county":{
            "description":"county for the address",
            "type":"string"
        },
        "dynamicProperty":{
            "description":"The value of the dynamic Property",
            "type":"object"
        },
        "firstName":{
            "description":"The first name of the user for whom the address is created. This field can be null also",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number of the address",
            "type":"string"
        },
        "repositoryId":{
            "description":"Unique Id for the address",
            "type":"string"
        },
        "state":{
            "description":"state for the address",
            "type":"string"
        }
    }
}

Nested Schema : dynamicProperty

Type: object

The value of the dynamic Property

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":{
            "displayName":{
                "description":"The name of the address type",
                "type":"string"
            },
            "repositoryId":{
                "description":"repository Id of the address type",
                "type":"string"
            },
            "id":{
                "description":"repository Id of the address type",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string
  The name of the address type
• id(optional): string
  repository Id of the address type
• repositoryId(optional): string
  repository Id of the address type

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

Example Response (application/json)

{
    "address":{
        "lastName":"Anderson",
        "country":"US",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10002"
            }
        ],
        "address3":"",
        "address2":"",
        "city":"Buffalo",
        "address1":"1234, International Avenue",
        "postalCode":"32305",
        "companyName":"Oracle",
        "firstName":"kim",
        "phoneNumber":"813-123-1234",
        "repositoryId":"ss-40010",
        "state":"FL"
    },
    "addressType":"Home",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/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| |------------------|------------------| |22031|Internal error during get profile| |22002|No profile found with profile id| |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

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top