1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Organizations

updateOrganization

put

/ccadmin/v1/organizations/{id}

Update Organization. This operation is used to update an Organization in Oracle Commerce Cloud for a customer.As few properties are site specific they will be mapped to the default site, however if 'x-ccsite' header is sent then site specific properties will be mapped to the site sent in header.

Request

Supported Media Types
Path Parameters
Query Parameters
  • As an alternative to the fields parameter, which explicitly specifies the properties to include, you can use the exclude parameter to include all properties except the ones specified. For example, to return all of the properties of organization except paymentMethods.
  • Expand query parameter is used to return only ID. Possible values for this expand query parameter is 'none'
  • You can use the fields parameter to restrict the set of properties returned to only those you explicitly specify. The properties are specified as a comma-separated list. For example, id and name properties of organization.
  • Rather than using fields or exclude to explicitly list properties in the URL of a REST call, you can create persistent filters that store the set of properties to include or exclude. You can then specify a filter by name in the URL using the filterKey query parameter. Use Response Filters Admin API to create new persistent filters and use them.
Body ()
Root Schema : updateOrganization_request
Type: object
Show Source
Example:
{
    "taxReferenceNumber":"REFNUM123",
    "authorizationCode":"NO_AUTH_CODE",
    "organizationLogo":"/general/update-hero-image1.jpg",
    "delegateApprovalManagement":false,
    "secondaryAddresses":[
        {
            "address":{
                "isDefaultBillingAddress":true,
                "country":"US",
                "types":[
                    {
                        "id":"ss-10002"
                    }
                ],
                "phoneNumber":"973-974-1234",
                "address3":"Street 3",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "isDefaultShippingAddress":true,
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "externalOrganizationId":"externalOrg1",
    "parentOrganization":{
        "id":"100001"
    },
    "type":"none",
    "customerType":"Standard",
    "members":[
        "110000"
    ],
    "paymentMethods":[
        "card",
        "cash"
    ],
    "dunsNumber":"123456789",
    "shippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "op":"addContacts",
    "dynamicProperty1":"dynamicProperty1 value",
    "contract":{
        "catalogId":"cloudCatalog",
        "priceListGroupId":"defaultPriceGroup",
        "endDate":"2017-10-10T11:44:26.000Z",
        "displayName":"Us Motor Works Contract",
        "description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
        "contract_terms":{
            "terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract"
        },
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "active":true,
    "vatReferenceNumber":"Vat123123",
    "taxExemptionCode":"TAXUQ12345",
    "orderPriceLimit":null,
    "allowPunchoutShopping":true,
    "useAllShippingMethodsFromSite":false,
    "approvalRequired":false,
    "useAllPaymentMethodsFromSite":false,
    "name":"Oracle",
    "shippingAddress":null,
    "useExternalApprovalWebhook":false,
    "billingAddress":null,
    "uniqueId":"TestIDNumber"
}
Nested Schema : billingAddress
Type: object
Default Billing Address
Show Source
Nested Schema : contract
Type: object
Contract Info
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : members
Type: array
List of contact ids associated with an Organization
Show Source
Nested Schema : paymentMethods
Type: array
Payment methods associated for organization.
Show Source
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'.
Show Source
Nested Schema : shippingAddress
Type: object
Default Shipping Address
Show Source
Nested Schema : shippingMethods
Type: array
Shipping methods associated for organization.
Show Source
Nested Schema : contract_terms
Type: object
Terms & Conditions for contract
Show Source
Nested Schema : items
Type: object
Show Source
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
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 : updateOrganization_response
Type: object
Show Source
Nested Schema : ancestorOrganizations
Type: array
List of ancestors for the Organization
Show Source
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.
Show Source
Nested Schema : contract
Type: object
Contract
Show Source
Nested Schema : derivedBillingAddress
Type: object
The derived default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute or if aprent has default billing address.
Show Source
Nested Schema : derivedContract
Type: object
Derived Contract
Show Source
Nested Schema : derivedPaymentMethods
Type: array
Derived payment methods associated for organization.
Show Source
Nested Schema : derivedShippingAddress
Type: object
The dervied default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.
Show Source
Nested Schema : derivedShippingMethods
Type: array
Derived shipping methods associated for organization.
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : members
Type: array
List of contact ids associated with an Organization
Show Source
Nested Schema : parentOrganization
Type: object
Parent organization Info.
Show Source
Nested Schema : paymentMethods
Type: array
Payment methods associated for organization.
Show Source
Nested Schema : relativeRoles
Type: array
List of organization roles.
Show Source
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 'billingAddres'.
Show Source
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.
Show Source
Nested Schema : shippingMethods
Type: array
Shipping methods associated for organization.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "taxReferenceNumber":"REFNUM123",
    "organizationLogo":"/general/update-hero-image1.jpg",
    "delegateApprovalManagement":false,
    "secondaryAddresses":[
        {
            "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",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"150002",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "source":null,
    "externalOrganizationId":"externalOrgId1",
    "parentOrganization":{
        "name":"Oracle Sample",
        "repositoryId":"100001",
        "active":true,
        "id":"100001",
        "externalOrganizationId":"EXT_ORG_1"
    },
    "type":"none",
    "customerType":"Standard",
    "derivedShippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "derivedBillingAddressType":"Office Address",
    "members":[
        {
            "repositoryId":"110000"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/organizations"
        }
    ],
    "id":"200003",
    "dunsNumber":"123456789",
    "relativeRoles":[
        {
            "function":"admin",
            "repositoryId":"200004"
        },
        {
            "function":"buyer",
            "repositoryId":"200005"
        },
        {
            "function":"approver",
            "repositoryId":"200006"
        },
        {
            "function":"accountAddressManager",
            "repositoryId":"200007"
        },
        {
            "function":"profileAddressManager",
            "repositoryId":"200008"
        }
    ],
    "dynamicProperty1":"dynamicProperty1 value",
    "derivedTaxReferenceNumber":"REFNUM123",
    "derivedUseAllPaymentMethodsFromSite":false,
    "derivedAuthorizationCode":"sadsaxxaASX34567==",
    "contract":{
        "terms":{
            "terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
            "repositoryId":"100002"
        },
        "endDate":"2017-10-10T11:44:26.000Z",
        "catalog":{
            "displayName":"Cloud Catalog",
            "repositoryId":"cloudCatalog"
        },
        "displayName":"Us Motor Works Contract",
        "repositoryId":"100003",
        "description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
        "priceListGroup":{
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup"
        },
        "creationDate":"2016-04-01T09:34:50.000Z",
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "derivedCustomerType":"Standard",
    "active":true,
    "vatReferenceNumber":"Vat123123",
    "taxExemptionCode":"TAXUQ12345",
    "derivedType":"none",
    "allowPunchoutShopping":true,
    "useAllShippingMethodsFromSite":false,
    "approvalRequired":false,
    "derivedTaxExemptionCode":"TAXUQ12345",
    "derivedVatReferenceNumber":"Vat123123",
    "derivedAllowPunchoutShopping":true,
    "name":"Oracle",
    "ancestorOrganizations":[
        {
            "name":"Oracle Sample",
            "repositoryId":"100001",
            "active":true,
            "id":"100001",
            "externalOrganizationId":"EXT_ORG_1"
        }
    ],
    "uniqueId":"TestIDNumber",
    "authorizationCode":"sadsaxxaASX34567==",
    "description":null,
    "derivedBillingAddress":{
        "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",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "derivedUniqueId":"TestIDNumber",
    "organizationLogoURL":"http://localhost:9080/file/general/update-hero-image1.jpg",
    "derivedContract":{
        "terms":{
            "terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
            "repositoryId":"100002"
        },
        "endDate":"2017-10-10T11:44:26.000Z",
        "catalog":{
            "displayName":"Cloud Catalog",
            "repositoryId":"cloudCatalog"
        },
        "displayName":"Us Motor Works Contract",
        "repositoryId":"100003",
        "description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
        "priceListGroup":{
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup"
        },
        "creationDate":"2016-04-01T09:34:50.000Z",
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "paymentMethods":[
        "card",
        "cash"
    ],
    "derivedShippingAddressType":"Office Address",
    "shippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "derivedDunsNumber":123456789,
    "derivedOrganizationLogo":"/general/hero-image1.jpg",
    "orderPriceLimit":null,
    "derivedShippingAddress":{
        "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",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "derivedUseAllShippingMethodsFromSite":false,
    "useAllPaymentMethodsFromSite":false,
    "derivedPaymentMethods":[
        "card",
        "cash"
    ],
    "repositoryId":"200003",
    "shippingAddress":{
        "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",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "useExternalApprovalWebhook":false,
    "billingAddress":{
        "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",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "derivedDescription":null
}

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| |------------------|------------------| |100082|The current account does not have the delegate approval management option enabled. Requiring order approvals or making changes to purchase limits cannot be done.| |100093|If there was any internal error while getting the organization.| |100083|You must create at least one active approver for the account before you can enable the approval required option| |100073|If the catalog id is required| |100084|You cannot remove this contact from the account. The account has no other active Approvers. Approvals are still enabled and/or there are orders pending approval.| |100074|If the pricelist group id is required| |20187|If the pricelist group id is invalid| |100064|If the catalog id is invalid| |100075|If external reference number is invalid| |100086|Merchant admin is not allowed to do approval management with delegate approval management set to true.| |100011|If the Organization Id passed is Invalid | |100022|If invalid input is passed| |22002|If invalid profile/member id is given| |100012|If the Organization name is empty or null| |100013|If the Organization's parent is being updated to itself or one of its child.| |100024|If trying to update root organization| |100014|If the organization name passed is duplicate| |100018|If there was any internal error while updating the Organization| |100104|If the taxExemption code passed is invalid| |100120|If the useAllPaymentMethodsFromSite property value is invalid.| |100118|If the paymentMethods passed in the input is invalid.| |100121|If the useAllShippingMethodsFromSite property value is invalid.| |100119|If the shippingMethods passed in the input is invalid.| |100131|If we try to update authorization code property with value other than null or NO_AUTH_CODE.| |100204|Missing ID for address type| |180106|One or more address type ID is invalid| |
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