updateOrganization

put

/ccagent/v1/organizations/{id}

Update Organization. This operation is used to update properties like approval required and order price limit for an organization. Dynamic Properties of organization can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue"). 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
Path Parameters
Header 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",
                "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"
        }
    ],
    "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 : 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 : 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 : 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 : 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 : items
Type: object
Show Source
Example Response (application/json)
{
    "taxReferenceNumber":"REFNUM123",
    "authorizationCode":"sadsaxxaASX34567==",
    "organizationLogo":"/general/update-hero-image1.jpg",
    "description":null,
    "secondaryAddresses":[
        {
            "address":{
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"150002",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "type":"none",
    "customerType":"Standard",
    "organizationLogoURL":"/file/general/update-hero-image1.jpg",
    "members":[
        {
            "repositoryId":"110000"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"/ccadmin/v1/organizations"
        }
    ],
    "id":"200003",
    "dunsNumber":"123456789",
    "relativeRoles":[
        {
            "function":"admin"
        },
        {
            "function":"buyer"
        }
    ],
    "dynamicProperty1":"dynamicProperty1 value",
    "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":{
            "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,
    "allowPunchoutShopping":true,
    "approvalRequired":true,
    "derivedAllowPunchoutShopping":true,
    "repositoryId":"200003",
    "name":"Oracle",
    "punchoutUserId":"100012",
    "shippingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "billingAddress":{
        "country":"US",
        "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|If delegated admin trying to do approval management without the delegaete approval flag set to true| |100083|If there are no approvers present and approval falg is updated to true| |100084|If the last approver is being removed and either the approval flag is set to true or there is atleast one order in pending approval state| |100021|If approval required value is invalid| |89103|If the shopperProfile passed in the AgentContext header or the associated account is inactive| |100080|If order price limit is Invalid| |100000|If input passed is invalid| |100001|If there was no organization found with the given id| |13036|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