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: string
The ID of the Organization to be updated.
Query Parameters
-
exclude(optional): string
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(optional): string
Expand query parameter is used to return only ID. Possible values for this expand query parameter is 'none'
-
fields(optional): string
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.
-
filterKey(optional): string
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.
Root Schema : updateOrganization_request
Type:
Show Source
object
-
approvalRequired(optional):
boolean
Approval flag is required for the organization, by default it is set to false
-
orderPriceLimit(optional):
number
Order Price Limit Value for an organization
Example:
{
"dynamicProperty":"dynamicProperty value",
"approvalRequired":true,
"orderPriceLimit":1000
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateOrganization_response
Type:
Show Source
object
-
active(optional):
boolean
Active status of an Organization. Should be true or false. By default the value is set to true
-
approvalRequired(optional):
boolean
Approval flag is required for the organization, by default it is set to false
-
billingAddress(optional):
object billingAddress
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.
-
contract(optional):
object contract
Contract
-
customerType(optional):
string
Customer Type for Organization
-
delegateApprovalManagement(optional):
boolean
This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
-
derivedBillingAddress(optional):
object derivedBillingAddress
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.
-
derivedPaymentMethods(optional):
array derivedPaymentMethods
Derived payment methods associated for organization.
-
derivedShippingAddress(optional):
object derivedShippingAddress
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.
-
derivedShippingMethods(optional):
array derivedShippingMethods
Derived shipping methods associated for organization.
-
derivedUseAllPaymentMethodsFromSite(optional):
boolean
Derived flag to use all the payment methods available for site.
-
derivedUseAllShippingMethodsFromSite(optional):
string
Derived flag to use all the shipping methods available for site.
-
description(optional):
string
Description for Organization
-
dunsNumber(optional):
string
DUNS Number for Organization
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Id of the Organization
-
members(optional):
array members
List of contact ids associated with an Organization
-
name(optional):
string
The name for Organization
-
orderPriceLimit(optional):
number
Order Price Limit Value for an organization
-
organizationLogo(optional):
string
File path of organization logo.
-
organizationLogoURL(optional):
string
Full URL of organization logo.
-
paymentMethods(optional):
array paymentMethods
Payment methods associated for organization.
-
relativeRoles(optional):
array relativeRoles
List of organization roles.
-
repositoryId(optional):
string
Repository Id of the Organization
-
secondaryAddresses(optional):
array secondaryAddresses
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'.
-
shippingAddress(optional):
object shippingAddress
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.
-
shippingMethods(optional):
array shippingMethods
Shipping methods associated for organization.
-
taxReferenceNumber(optional):
string
Tax Reference number for Organization
-
type(optional):
string
Type for Organization
-
uniqueId(optional):
string
Unique Id of the Organization
-
useAllShippingMethodsFromSite(optional):
string
Flag to use all the shipping methods available for site.
-
useExternalApprovalWebhook(optional):
boolean
Flag to enable/disable Order Approval check from External Webhook
-
vatReferenceNumber(optional):
string
Vat reference number for the organization
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
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of the address
-
country(optional):
string
the country of the secondary address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the secondary address
-
types(optional):
array types
The types tagged to the address
Nested Schema : contract
Type:
object
Contract
Show Source
-
catalog(optional):
object catalog
Catalog associated with contract
-
creationDate(optional):
string
Contract creation date time stamp
-
description(optional):
string
Description for contract
-
displayName(optional):
string
Display name for contract
-
endDate(optional):
string
Contract end date time stamp
-
externalContractReference(optional):
string
External contract reference
-
priceListGroup(optional):
object priceListGroup
Price ListGroup associated with contract
-
repositoryId(optional):
string
Repository Id of the contract
-
startDate(optional):
string
Contract start date time stamp
-
terms(optional):
object terms
Terms and Conditions
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.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of the address
-
country(optional):
string
the country of the secondary address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the secondary address
-
types(optional):
array types
The types tagged to the address
Nested Schema : derivedPaymentMethods
Type:
array
Derived payment methods associated for organization.
Show Source
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.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of shipping address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the company address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : derivedShippingMethods
Type:
array
Derived shipping 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 '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
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of shipping address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the company address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : shippingMethods
Type:
array
Shipping methods associated for organization.
Show Source
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
repositoryId(optional):
string
Repository Id of the catalog
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
repositoryId(optional):
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId(optional):
string
Repository Id of terms and conditions
-
terms(optional):
string
Terms and Conditions
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
Repository Id of the shipping method.
-
id(optional):
string
Repository Id of the shipping method.
-
repositoryId(optional):
string
Repository Id of the shipping method.
Nested Schema : items
Type:
Show Source
object
-
address(optional):
object address
Address created for the Organization.
-
addressType(optional):
string
Address type represents nick name of account if present else repository ID of address item.
Nested Schema : address
Type:
object
Address created for the Organization.
Show Source
-
address1(optional):
string
The address1 of the secondary address
-
address2(optional):
string
The address2 of the secondary address
-
city(optional):
string
The city of the secondary address
-
companyName(optional):
string
Company name of the secondary address
-
country(optional):
string
The country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
Phone Number of the address
-
postalCode(optional):
string
Postal Code of the address
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
The State of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
Repository Id of the shipping method.
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|
|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code