Jump to

• Request
• Response

get Address for an Organization

get

/ccapp/v1/organizations/{id}/secondaryAddresses/{addressId}

Get Organization Address. This endpoint is used to get secondary address of an Organization in Oracle Commerce Cloud.

Request

Supported Media Types

• application/json

Path Parameters

• addressId(required): string
  The address id of the requested address for an Organization.
• id(required): string
  The ID of the requested Organization.

Header Parameters

• X-CCAsset-Language: string
  The asset language of the request. E.g., en,de,fr_CA.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getOrganizationAddress_response

Type: object

Show Source

• address: object address
  Updated address for the Organization.
• addressType: string
  Address type represents nick name of account if present else repository ID of address item.

{
    "properties":{
        "address":{
            "description":"Updated address for the Organization.",
            "type":"object",
            "properties":{
                "country":{
                    "description":"The country of the address.",
                    "type":"string"
                },
                "externalAddressId":{
                    "description":"External address id",
                    "type":"string"
                },
                "types":{
                    "description":"The types tagged to the address",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "displayName":{
                                "description":"The name of the address type",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"repository Id of the address type",
                                "type":"string"
                            },
                            "id":{
                                "description":"repository Id of the address type",
                                "type":"string"
                            }
                        }
                    }
                },
                "phoneNumber":{
                    "description":"Phone Number of the address.",
                    "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"
                },
                "state":{
                    "description":"The State of the address.",
                    "type":"string"
                }
            }
        },
        "addressType":{
            "description":"Address type represents nick name of account if present else repository ID of address item.",
            "type":"string"
        }
    }
}

Nested Schema : address

Type: object

Updated address for the Organization.

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.
• externalAddressId: string
  External address id
• phoneNumber: string
  Phone Number of the address.
• postalCode: string
  Postal Code of the address.
• state: string
  The State of the address.
• types: array types
  The types tagged to the address

{
    "description":"Updated address for the Organization.",
    "type":"object",
    "properties":{
        "country":{
            "description":"The country of the address.",
            "type":"string"
        },
        "externalAddressId":{
            "description":"External address id",
            "type":"string"
        },
        "types":{
            "description":"The types tagged to the address",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"The name of the address type",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"repository Id of the address type",
                        "type":"string"
                    },
                    "id":{
                        "description":"repository Id of the address type",
                        "type":"string"
                    }
                }
            }
        },
        "phoneNumber":{
            "description":"Phone Number of the address.",
            "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"
        },
        "state":{
            "description":"The State of the address.",
            "type":"string"
        }
    }
}

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":{
            "displayName":{
                "description":"The name of the address type",
                "type":"string"
            },
            "repositoryId":{
                "description":"repository Id of the address type",
                "type":"string"
            },
            "id":{
                "description":"repository Id of the address type",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

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

Example Response (application/json)

{
    "address":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10002"
            }
        ],
        "phoneNumber":"973-974-1234",
        "address3":"Street 3",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "companyName":"National Discount Auto Parts",
        "postalCode":"36130",
        "repositoryId":"280004",
        "state":"AL"
    },
    "addressType":"Montgomery Office Address",
    "links":[
        {
            "rel":"self",
            "href":"/ccadminui/v1/organizations/or-100001/secondaryAddresses/280004"
        }
    ]
}

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 : No Address is found with the given id| |100000|If input passed is invalid| |100001|If there was no organization found with the given id| |

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