addAddress

post

/ccagent/v1/organizationAddresses

Add Address. This endpoint is used to add addresses 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
Header Parameters
Body ()
Root Schema : addAddress_request
Type: object
Show Source
Example:
{
    "address":{
        "isDefaultBillingAddress":true,
        "country":"US",
        "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 : dynamicProperty
Type: object
The value of the dynamic Property
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 created for the Organization.
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Example Response (application/json)
{
    "address":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "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":"/ccagentui/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 or nickname given is null/empty| |100030|Postal Code is required| |100031|Country is required| |100053|If the organization invalid default billing address value| |100032|No State Region is found| |100054|If the organization invalid default shipping address value| |100076|Invalid Secondary Addresses| |82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors| |23015|Phone Number is required| |23005|Phone Number is invalid| |80018|If an invalid country is provided| |100067|If an invalid state is provided| |100189|Duplicate Addresses Type are giving in input| |100026|Company Name is required| |89103|If no shopperProfileId is passed in the AgentContext header| |100027|Address 1 is required| |89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive| |100028|City is required| |89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account| |100029|State is required| |100192|One of the dynamic properties is not writable by the Agent user|
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