addAddress

post

/ccstore/v1/organizationAddresses

Add Address. This endpoint is used to add addresses 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
Header Parameters
Body ()
Root Schema : addAddress_request
Type: object
Show Source
Example:
{
    "address":{
        "isDefaultBillingAddress":true,
        "country":"US",
        "types":[
            {
                "id":"at200001"
            }
        ],
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "isDefaultShippingAddress":true,
        "state":"AL"
    },
    "addressType":"Office Address"
}
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : addAddress_response
Type: object
Show Source
Nested Schema : address
Type: object
Address Object for the Organization.
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "address":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10002"
            }
        ],
        "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"
        }
    ]
}

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| |------------------|------------------| |100183|If input given in null/empty| |100030|Postal Code is required| |100031|Country is required| |100053|If the organization invalid default billing address value| |100032|No Stage Region is found| |100054|If the organization invalid default shipping address value| |100076|Invalid Secondary Addresses| |23015|Phone Number is required| |23005|Phone Number is invalid| |100189|Duplicate Addresses Type are giving in input| |100026|Company Name is required| |100027|Address 1 is required| |100028|City is required| |100029|State is required| |100000|If input passed is invalid| |100001|If there was no organization found with the given id.| |180106|One or more address type ID is invalid| |100204|Missing ID for address type| |
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top