Oracle Commerce Cloud October 2017

getAddress

get

/ccstore/v1/organizationAddresses/{id}

Get Address. This endpoint is used to get address by its id of a Organization/Account in Oracle Commerce Cloud.Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the address that has to be updated.

Header Parameters

X-CCOrganization: Type: string

Current organization context of the logged in user

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getAddress_response

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


{
    "address":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    },
    "addressType":"Office Address",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/organizationAddresses"
        }
    ],
    "___etag___":"eyJoYXNoIjoicnNmZW5BSWVrUS8yVm00L1NsME1LNWlwekNWTHQ1Zy91d293N051L3Zlcz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL29yZ2FuaXphdGlvbnMvMjEwMDAwMyIsInVzZXIiOiJBbWJlciBBZG1pbiIsInZlcnNpb24iOjF9"
}

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| |------------------|------------------| |100185|Invalid Address Id| |100187|No address is found with the id in logged in user's organization| |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

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

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": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "180003",
    "state": "AL"
  },
  "addressType": "Office Address",
  "links": [{
    "rel": "self",
    "href": "http://localhost:8080/ccstore/v1/organizationAddresses"
  }],
  "___etag___": "eyJoYXNoIjoicnNmZW5BSWVrUS8yVm00L1NsME1LNWlwekNWTHQ1Zy91d293N051L3Zlcz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL29yZ2FuaXphdGlvbnMvMjEwMDAwMyIsInVzZXIiOiJBbWJlciBBZG1pbiIsInZlcnNpb24iOjF9"
}