REST API for Oracle Commerce Cloud December 2017

listAddresses

get

/ccadmin/v1/addresses

List Addresses. This operation is used to get the list of addresses of an organization.

Request

Supported Media Types

application/json

Query Parameters

include: Type: string

Query string to get all/inherited secondaryAddresses. "all"/"inheritedOnly" are the only allowed values. If include is not specified, seondaryAddresses of that organization is returned.
limit: Type: string

This is the field to determine number of records to be fetched per REST call.
offset: Type: string

This field determines the offset/starting index from which data to be fetched.
orgId: Type: string

Required: true

Organization Id whose addresses has to be fetched

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listAddresses_response

Properties

items: Type: array items

Additional Properties Allowed:

List of all the addresses associated with an organization and it's ancestor organizations.
limit: Type: string

Number of records to be fetched.
offset: Type: string

The offset provided.
total: Type: string

Total number of records present in database matching the searched string.
totalResults: Type: string

Total number of records present in database matching the searched string.

Nested Schema : items

Type: array

List of all the addresses associated with an organization and it's ancestor organizations.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

address: Type: object address

Additional Properties Allowed:

Address created for the Organization.
addressType: Type: string

Address type represents nick name of account if present else repository ID of address item.

Nested Schema : address

Type: object

Address created for the Organization.

Properties

address1: Type: string

The address1 of the secondary address
address2: Type: string

The address2 of the secondary address
city: Type: string

The city of the secondary address
companyName: Type: string

Company name of the secondary address
country: Type: string

The country of the address
phoneNumber: Type: string

Phone Number of the address
postalCode: Type: string

Postal Code of the address
repositoryId: Type: string

repository Id of the address
state: Type: string

The State of the address

Example application/json


{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/addresses?orgId=10001"
        }
    ],
    "items":[
        {
            "address":{
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"190001",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ]
}

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| |------------------|------------------| |100191|Invalid query param.| |100000|If input passed is invalid| |100001|If there was no organization found with the given id|

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": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 1,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadmin/v1/addresses?orgId=10001"
  }],
  "items": [{
    "address": {
      "country": "US",
      "phoneNumber": "973-974-1234",
      "address2": "Street 2",
      "city": "Montgomery",
      "address1": "600 Dexter Avenue",
      "postalCode": "36130",
      "companyName": "Oracle",
      "repositoryId": "190001",
      "state": "AL"
    },
    "addressType": "Office Address"
  }]
}