1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. Store Extension
  5. Admin
  6. Organizations

update site based Organization properties

post

/ccapp/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
Path Parameters
Body ()
Root Schema : updateSiteOrganizationProperties_request
Type: object
Show Source
Example:
{
    "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
            }
        }
    ]
}
Nested Schema : siteOrganizationProperties
Type: array
Site Organizaiton properties
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
site based properties information
Show Source
  • Approval flag is required for the organization, by default it is set to false
  • contract
    Contract Info
  • This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
  • A OP code parameter used to remove inheritance for a property, the supported value is 'remove'. If this op code is given and properties field has a some property like contract or orderPriceLimit then it will remove inheritance for that property (if exists), it will set NULL if no inheritance is found.
  • Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
  • Flag to enable/disable Order Approval check from External Webhook
Nested Schema : site
Type: object
site information
Show Source
Nested Schema : contract
Type: object
Contract Info
Show Source
Nested Schema : contract_terms
Type: object
Terms & Conditions for contract
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateSiteOrganizationProperties_response
Type: object
Show Source
Nested Schema : siteOrganizationProperties
Type: array
Site Organizaiton properties
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
site based properties information
Show Source
Nested Schema : site
Type: object
site information
Show Source
Nested Schema : contract
Type: object
Contract Info
Show Source
Nested Schema : contract_terms
Type: object
Terms & Conditions for contract
Show Source
Example Response (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
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