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
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the Organization to be updated.
Body Parameter
Root Schema : updateOrganization_request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateOrganization_response
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.
Nested Schema : contract
Type: object
Contract
Nested Schema : derivedBillingAddress
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.
Nested Schema : derivedPaymentMethods
Type: array
Derived payment methods associated for organization.
Nested Schema : derivedShippingAddress
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.
Nested Schema : derivedShippingMethods
Type: array
Derived shipping methods associated for organization.
Nested Schema : members
Type: array
List of contact ids associated with an Organization
Nested Schema : paymentMethods
Type: array
Payment methods associated for organization.
Nested Schema : relativeRoles
Type: array
List of organization roles.
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'.
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.
Nested Schema : shippingMethods
Type: array
Shipping methods associated for organization.
Nested Schema : catalog
Type: object
Catalog associated with contract
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Nested Schema : terms
Type: object
Terms and Conditions
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : address
Type: object
Address created for the Organization.
Nested Schema : items
Type: object
Example application/json

{
    "taxReferenceNumber":"REFNUM123",
    "organizationLogo":"/general/update-hero-image1.jpg",
    "delegateApprovalManagement":false,
    "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"
        }
    ],
    "parentOrganization":{
        "name":"Oracle Sample",
        "repositoryId":"100001",
        "active":true,
        "id":"100001"
    },
    "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,
    "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",
    "useAllShippingMethodsFromSite":false,
    "approvalRequired":false,
    "derivedTaxExemptionCode":"TAXUQ12345",
    "derivedVatReferenceNumber":"Vat123123",
    "name":"Oracle",
    "ancestorOrganizations":[
        {
            "name":"Oracle Sample",
            "repositoryId":"100001",
            "active":true,
            "id":"100001"
        }
    ],
    "uniqueId":"TestIDNumber",
    "description":null,
    "derivedBillingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "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",
        "phoneNumber":"973-974-1234",
        "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",
        "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",
        "phoneNumber":"973-974-1234",
        "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.
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

{
  "taxReferenceNumber": "REFNUM123",
  "organizationLogo": "/general/update-hero-image1.jpg",
  "delegateApprovalManagement": false,
  "secondaryAddresses": [{
    "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"
  }],
  "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,
  "useAllShippingMethodsFromSite": false,
  "approvalRequired": false,
  "useAllPaymentMethodsFromSite": false,
  "name": "Oracle",
  "shippingAddress": null,
  "useExternalApprovalWebhook": false,
  "billingAddress": null,
  "uniqueId": "TestIDNumber"
}

Sample Response Payload returned by endpoint:

{
  "taxReferenceNumber": "REFNUM123",
  "organizationLogo": "/general/update-hero-image1.jpg",
  "delegateApprovalManagement": false,
  "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"
  }],
  "parentOrganization": {
    "name": "Oracle Sample",
    "repositoryId": "100001",
    "active": true,
    "id": "100001"
  },
  "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,
  "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",
  "useAllShippingMethodsFromSite": false,
  "approvalRequired": false,
  "derivedTaxExemptionCode": "TAXUQ12345",
  "derivedVatReferenceNumber": "Vat123123",
  "name": "Oracle",
  "ancestorOrganizations": [{
    "name": "Oracle Sample",
    "repositoryId": "100001",
    "active": true,
    "id": "100001"
  }],
  "uniqueId": "TestIDNumber",
  "description": null,
  "derivedBillingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "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",
    "phoneNumber": "973-974-1234",
    "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",
    "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",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "150002",
    "state": "AL"
  },
  "derivedDescription": null
}