1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Organizations

update site based Organization properties

post

/ccadmin/v1/organizations/{id}/updateSiteOrganizationProperties

This operation is used to create/update site based organization proeprties in Oracle Commerce Cloud for a customer.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the Organization for which site based properties has to be updated.
Body Parameter
Root Schema : updateSiteOrganizationProperties_request
Nested Schema : siteOrganizationProperties
Type: array
Site Organizaiton properties
Nested Schema : items
Type: object
Nested Schema : properties
Type: object
site based properties information
Nested Schema : site
Type: object
site information
Nested Schema : contract
Type: object
Contract Info
Nested Schema : contract_terms
Type: object
Terms & Conditions for contract

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateSiteOrganizationProperties_response
Nested Schema : siteOrganizationProperties
Type: array
Site Organizaiton properties
Nested Schema : items
Type: object
Nested Schema : properties
Type: object
site based properties information
Nested Schema : site
Type: object
site information
Nested Schema : contract
Type: object
Contract Info
Nested Schema : contract_terms
Type: object
Terms & Conditions for contract
Example application/json

{
    "siteOrganizationProperties":[
        {
            "site":{
                "productionURL":null,
                "name":"Site 2",
                "id":"site2",
                "enabled":false
            },
            "properties":{
                "approvalRequired":false,
                "contract":{
                    "catalogId":"cloudCatalog",
                    "priceListGroupId":"defaultPriceGroup",
                    "displayName":"Us Motor Works Contract",
                    "repositoryId":100001,
                    "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"
                    },
                    "externalContractReference":"UMWCUS001"
                },
                "delegateApprovalManagement":false,
                "useExternalApprovalWebhook":false,
                "orderPriceLimit":null
            }
        }
    ]
}
Default Response
The error response. 100064 : If the catalog id is invalid 100073 : If the catalog id is required 100074 :If the pricelist group id is required 100075 : If external reference number is invalid 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 100086 : Merchant admin is not allowed to do approval management with delegate approval management set to true. 100105 : Error while fetching site account properties 100108 : Invalid organization id for fetching site account properties 100109 : The site id entered is a non b2b site 100110 : Invalid values for site based organization properties 100111 : Internal error occurred while updating site based organization properties
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:

{"siteOrganizationProperties": [
  {
    "site": {"id": "site1"},
    "properties": {
      "op": "remove",
      "contract": null
    }
  },
  {
    "site": {"id": "site2"},
    "properties": {
      "approvalRequired": false,
      "contract": {
        "catalogId": "cloudCatalog",
        "priceListGroupId": "defaultPriceGroup",
        "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"},
        "externalContractReference": "UMWCUS001"
      },
      "delegateApprovalManagement": false,
      "useExternalApprovalWebhook": false,
      "orderPriceLimit": null
    }
  }
]}

Sample Response Payload returned by endpoint:

{"siteOrganizationProperties": [{
  "site": {
    "productionURL": null,
    "name": "Site 2",
    "id": "site2",
    "enabled": false
  },
  "properties": {
    "approvalRequired": false,
    "contract": {
      "catalogId": "cloudCatalog",
      "priceListGroupId": "defaultPriceGroup",
      "displayName": "Us Motor Works Contract",
      "repositoryId": 100001,
      "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"},
      "externalContractReference": "UMWCUS001"
    },
    "delegateApprovalManagement": false,
    "useExternalApprovalWebhook": false,
    "orderPriceLimit": null
  }
}]}