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

updateOrganization

put

/ccstore/v1/organizations/{id}

Update Organization. This operation is used to update properties like approval required, order price limit and dynamic properties ("dynamicPropertyName": "dynamicPropertyValue") for an organization.Optionally takes the X-CCOrganization header to specify current Organization id of logged in user.

Request

Supported Media Types
Path Parameters
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",
    "description":null,
    "secondaryAddresses":[
        {
            "address":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "types":[
                    {
                        "displayName":"Shipping",
                        "repositoryId":"ss-10001",
                        "id":"ss-10001"
                    },
                    {
                        "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":"150002",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "externalOrganizationId":"EXT_ORG_1",
    "type":"none",
    "derivedBillingAddress":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Shipping",
                "repositoryId":"ss-10001",
                "id":"ss-10001"
            },
            {
                "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":"150002",
        "state":"AL"
    },
    "customerType":"Standard",
    "derivedShippingMethods":[
        {
            "displayName":"Shipping Method Name",
            "repositoryId":"shippingMethodId1",
            "id":"shippingMethodId1"
        }
    ],
    "organizationLogoURL":"http://localhost:9080/file/general/update-hero-image1.jpg",
    "members":[
        {
            "repositoryId":"110000"
        }
    ],
    "paymentMethods":[
        "card",
        "cash"
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/organizations"
        }
    ],
    "id":"200003",
    "dunsNumber":"123456789",
    "relativeRoles":[
        {
            "function":"admin"
        },
        {
            "function":"buyer"
        }
    ],
    "shippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "derivedUseAllPaymentMethodsFromSite":false,
    "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":{
            "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":{
            "repositoryId":"defaultPriceGroup"
        },
        "creationDate":"2016-04-01T09:34:50.000Z",
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "active":true,
    "vatReferenceNumber":"Vat123123",
    "orderPriceLimit":1000,
    "dynamicProperty":"dynamicProperty value",
    "derivedShippingAddress":{
        "country":"US",
        "types":[
            {
                "displayName":"Shipping",
                "repositoryId":"ss-10001",
                "id":"ss-10001"
            },
            {
                "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":"150002"
    },
    "useAllShippingMethodsFromSite":false,
    "derivedUseAllShippingMethodsFromSite":false,
    "approvalRequired":true,
    "useAllPaymentMethodsFromSite":false,
    "derivedPaymentMethods":[
        "card",
        "cash"
    ],
    "repositoryId":"200003",
    "name":"Oracle",
    "shippingAddress":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Shipping",
                "repositoryId":"ss-10001",
                "id":"ss-10001"
            },
            {
                "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":"150002",
        "state":"AL"
    },
    "useExternalApprovalWebhook":false,
    "billingAddress":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "displayName":"Shipping",
                "repositoryId":"ss-10001",
                "id":"ss-10001"
            },
            {
                "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":"150002",
        "state":"AL"
    },
    "uniqueId":"TestIDNumber"
}

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| |------------------|------------------| |100081|If order price limit is not passed or passed empty or null| |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.| |100083|You must create at least one active approver for the account before you can enable the approval required option| |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.| |100086|Merchant admin is not allowed to do approval management with delegate approval management set to true.| |100021|If approval required value is invalid| |100080|If order price limit is Invalid | |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