REST API for Oracle Commerce Cloud December 2017

listProfileAddresses

get

/ccstore/v1/profiles/current/addresses

Get Profile Addresses specific to the customer profile.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listProfileAddresses_response

Properties

items: Type: array items

Additional Properties Allowed:

Addresses related properties
limit: Type: integer

The batch size of the records to be fetched together.
offset: Type: integer

The start index of the list of records to be fetched
sort: Type: string

Sorting format

Nested Schema : items

Type: array

Addresses related properties

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

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


{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":8,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/profiles/bb-110023/addresses?limit=8&offset=0"
        }
    ],
    "items":[
        {
            "address":{
                "firstName":null,
                "lastName":null,
                "country":"US",
                "phoneNumber":null,
                "address2":null,
                "city":"sdf",
                "address1":"sdfs",
                "postalCode":"35005",
                "companyName":null,
                "repositoryId":"140065",
                "county":null,
                "state":"AL"
            },
            "addressType":"test2##0"
        },
        {
            "address":{
                "firstName":null,
                "lastName":null,
                "country":"US",
                "phoneNumber":null,
                "address2":"dsfsd",
                "city":"sdf",
                "address1":"dsss",
                "postalCode":"35005",
                "companyName":null,
                "repositoryId":"140059",
                "county":null,
                "state":"AL"
            },
            "addressType":"This ##0"
        }
    ]
}

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.|

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:

{
  "total": 2,
  "totalResults": 2,
  "offset": 0,
  "limit": 8,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/profiles/bb-110023/addresses?limit=8&offset=0"
  }],
  "items": [
    {
      "address": {
        "firstName": null,
        "lastName": null,
        "country": "US",
        "phoneNumber": null,
        "address2": null,
        "city": "sdf",
        "address1": "sdfs",
        "postalCode": "35005",
        "companyName": null,
        "repositoryId": "140065",
        "county": null,
        "state": "AL"
      },
      "addressType": "test2##0"
    },
    {
      "address": {
        "firstName": null,
        "lastName": null,
        "country": "US",
        "phoneNumber": null,
        "address2": "dsfsd",
        "city": "sdf",
        "address1": "dsss",
        "postalCode": "35005",
        "companyName": null,
        "repositoryId": "140059",
        "county": null,
        "state": "AL"
      },
      "addressType": "This ##0"
    }
  ]
}