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
- application/json
Path Parameters
-
id: string
The ID of the Organization to be updated.
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",
"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|
|
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