Jump to

• Request
• Response

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(required): string
  The ID of the address that has to be updated.

Header Parameters

• X-CCAgentContext(required): string
  The Agent Context is a JSON object with shopperProfileId as a property.
• X-CCAsset-Language: string
  The asset language of the request. E.g., en,de,fr_CA.
• X-CCOrganization: string
  the organization Id

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAddress_response

Type: object

Show Source

• address1: string
  The address1 of the secondary address
• address2: string
  The address2 of the secondary address
• address3: string
  The address3 of the secondary address
• city: string
  The city of the secondary address
• companyName: string
  Company name of the secondary address
• country: string
  The country of the address
• county: string
  The county of the secondary address
• dynamicProperty: object dynamicProperty
  The value of the dynamic Property
• externalAddressId: string
  External address id
• phoneNumber: string
  Phone Number of the address
• postalCode: string
  Postal Code of the address
• repositoryId: string
  repository Id of the address
• state: string
  The State of the address
• types: array types
  The types tagged to the address

{
    "properties":{
        "country":{
            "description":"The country of the address",
            "type":"string"
        },
        "types":{
            "description":"The types tagged to the address",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "addressType":{
                        "description":"The name of the address type",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"repository Id of the address type",
                        "type":"string"
                    }
                }
            }
        },
        "address3":{
            "description":"The address3 of the secondary address",
            "type":"string"
        },
        "address2":{
            "description":"The address2 of the secondary address",
            "type":"string"
        },
        "city":{
            "description":"The city of the secondary address",
            "type":"string"
        },
        "address1":{
            "description":"The address1 of the secondary address",
            "type":"string"
        },
        "companyName":{
            "description":"Company name of the secondary address",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal Code of the address",
            "type":"string"
        },
        "county":{
            "description":"The county of the secondary address",
            "type":"string"
        },
        "dynamicProperty":{
            "description":"The value of the dynamic Property",
            "type":"object"
        },
        "externalAddressId":{
            "description":"External address id",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone Number of the address",
            "type":"string"
        },
        "repositoryId":{
            "description":"repository Id of the address",
            "type":"string"
        },
        "state":{
            "description":"The State of the address",
            "type":"string"
        }
    }
}

Nested Schema : dynamicProperty

Type: object

The value of the dynamic Property

Nested Schema : types

Type: array

The types tagged to the address

Show Source

• Array of: object items

{
    "description":"The types tagged to the address",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "addressType":{
                "description":"The name of the address type",
                "type":"string"
            },
            "repositoryId":{
                "description":"repository Id of the address type",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• addressType: string
  The name of the address type
• repositoryId: string
  repository Id of the address type

{
    "type":"object",
    "properties":{
        "addressType":{
            "description":"The name of the address type",
            "type":"string"
        },
        "repositoryId":{
            "description":"repository Id of the address type",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "country":"US",
    "externalAddressId":"EXT_ADDR_1",
    "types":[
        "Shipping"
    ],
    "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

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top