REST API for Oracle Commerce Cloud December 2017

getAddresses

get

/ccagent/v1/organizationAddresses

Get Addresses. This operation is used to get all the address of a Organization/Account 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.

Request

Supported Media Types

application/json

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 : getAddresses_response

Properties

active: Type: boolean

Active status of an Organization. Should be true or false. By default the value is set to true
billingAddress: Type: object billingAddress

Additional Properties Allowed:

The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
description: Type: string

Description for Organization
id: Type: string

Id of the Organization
name: Type: string

The name for Organization
repositoryId: Type: string

Repository Id of the Organization
secondaryAddresses: Type: array secondaryAddresses

Additional Properties Allowed:

List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.

Nested Schema : billingAddress

Type: object

The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.

Properties

address1: Type: string

the address1 of the address
address2: Type: string

the address2 of the address
city: Type: string

the city of the address
companyName: Type: string

the company name of the address
country: Type: string

the country of the address
phoneNumber: Type: string

the phone Number of the address
postalCode: Type: string

the postal Code of the address
repositoryId: Type: string

Repository Id of the address
state: Type: string

the state of the address

Nested Schema : secondaryAddresses

Type: array

List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

The default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.

Properties

address1: Type: string

the address1 of the address
address2: Type: string

the address2 of the address
city: Type: string

the city of the address
companyName: Type: string

the company name shipping address
country: Type: string

the country of the address
phoneNumber: Type: string

the phone Number of the company address
postalCode: Type: string

the postal Code of the address
repositoryId: Type: string

Repository Id of the address
state: Type: string

the state of the address

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


{
    "repositoryId":"or-100001",
    "name":"National Discount Auto Parts",
    "active":true,
    "description":null,
    "shippingAddress":{
        "country":"US",
        "phoneNumber":"907-385-4412",
        "address2":null,
        "city":"Anchorage",
        "address1":"639 Main St",
        "companyName":"National Discount Auto Parts",
        "postalCode":"99501",
        "repositoryId":"160062",
        "state":"AZ"
    },
    "secondaryAddresses":[
        {
            "address":{
                "country":"US",
                "phoneNumber":"907-385-4412",
                "address2":null,
                "city":"Anchorage",
                "address1":"639 Main St",
                "companyName":"National Discount Auto Parts",
                "postalCode":"99501",
                "repositoryId":"160062",
                "state":"AZ"
            },
            "addressType":"Arizona Office Address"
        },
        {
            "address":{
                "country":"US",
                "phoneNumber":"631-748-6479",
                "address2":"Suffolk",
                "city":"Bohemia",
                "address1":"70 Euclid Ave #722",
                "companyName":"National Discount Auto Parts",
                "postalCode":"11716",
                "repositoryId":"ci-110024",
                "state":"NY"
            },
            "addressType":"NewYork Office Address"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"/ccagentui/v1/organizationAddresses"
        }
    ],
    "billingAddress":{
        "country":"US",
        "phoneNumber":"907-385-4412",
        "address2":null,
        "city":"Anchorage",
        "address1":"639 Main St",
        "companyName":"National Discount Auto Parts",
        "postalCode":"99501",
        "repositoryId":"160062",
        "state":"AZ"
    },
    "id":"or-100001"
}

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| |------------------|------------------| |22010|If no organziation is found| |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:

{
  "repositoryId": "or-100001",
  "name": "National Discount Auto Parts",
  "active": true,
  "description": null,
  "shippingAddress": {
    "country": "US",
    "phoneNumber": "907-385-4412",
    "address2": null,
    "city": "Anchorage",
    "address1": "639 Main St",
    "companyName": "National Discount Auto Parts",
    "postalCode": "99501",
    "repositoryId": "160062",
    "state": "AZ"
  },
  "secondaryAddresses": [
    {
      "address": {
        "country": "US",
        "phoneNumber": "907-385-4412",
        "address2": null,
        "city": "Anchorage",
        "address1": "639 Main St",
        "companyName": "National Discount Auto Parts",
        "postalCode": "99501",
        "repositoryId": "160062",
        "state": "AZ"
      },
      "addressType": "Arizona Office Address"
    },
    {
      "address": {
        "country": "US",
        "phoneNumber": "631-748-6479",
        "address2": "Suffolk",
        "city": "Bohemia",
        "address1": "70 Euclid Ave #722",
        "companyName": "National Discount Auto Parts",
        "postalCode": "11716",
        "repositoryId": "ci-110024",
        "state": "NY"
      },
      "addressType": "NewYork Office Address"
    }
  ],
  "links": [{
    "rel": "self",
    "href": "/ccagentui/v1/organizationAddresses"
  }],
  "billingAddress": {
    "country": "US",
    "phoneNumber": "907-385-4412",
    "address2": null,
    "city": "Anchorage",
    "address1": "639 Main St",
    "companyName": "National Discount Auto Parts",
    "postalCode": "99501",
    "repositoryId": "160062",
    "state": "AZ"
  },
  "id": "or-100001"
}