REST API for Oracle Commerce Cloud December 2017

getAddress

get

/ccagent/v1/organizationAddresses/{id}

Get Address. This endpoint is used to get address by its id of a Organization/Account in Oracle Commerce Cloud. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization.

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-CCAgentContext: Type: string

Required: true

The Agent Context is a JSON object with shopperProfileId as a property.
X-CCAsset-Language: Type: string

The asset language of the request. E.g., en,de,fr_CA.
X-CCOrganization: Type: string

the organization Id

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getAddress_response

Properties

address: Type: object address

Additional Properties Allowed:

Address Object 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 Object 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


{
    "country":"US",
    "phoneNumber":"973-974-1234",
    "address2":"Street 2",
    "city":"Montgomery",
    "address1":"600 Dexter Avenue",
    "companyName":"National Discount Auto Parts",
    "postalCode":"36130",
    "repositoryId":"280004",
    "links":[
        {
            "rel":"self",
            "href":"/ccagentui/v1/organizationAddresses/280004"
        }
    ],
    "state":"AL"
}

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 for the account associated to the profileId passed in the AgentContext header| |82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors| |89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive|

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:

{
  "country": "US",
  "phoneNumber": "973-974-1234",
  "address2": "Street 2",
  "city": "Montgomery",
  "address1": "600 Dexter Avenue",
  "companyName": "National Discount Auto Parts",
  "postalCode": "36130",
  "repositoryId": "280004",
  "links": [{
    "rel": "self",
    "href": "/ccagentui/v1/organizationAddresses/280004"
  }],
  "state": "AL"
}