You can use the Oracle Commerce Cloud Service Admin API to add custom properties to the organization
item type. When you add a custom property to the organization
item type, the property is added to all accounts, including any new accounts created afterward and any accounts that already exist.
The following example illustrates using the updateItemType
endpoint to add a custom property:
PUT /ccadmin/v1/itemTypes/organization HTTP/1.1
Authorization: Bearer <access_token>
{
"id": "organization",
"specifications": [
{
"id": "customerTier",
"label": "Customer tier",
"type": "shortText",
"uiEditorType": "shortText",
"internalOnly": false,
"required": false
}
]
}
The response includes the custom property you added:
... { "writable": true, "localizable": false, "label": "Customer tier", "type": "shortText", "id": "customerTier", "uiEditorType": "shortText", "textSearchable": false, "multiSelect": null, "dimension": false, "internalOnly": false, "default": null, "editableAttributes": [ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "length": 254, "required": false, "searchable": false }, ...
You can create a new account and set the values of custom properties (as well as the predefined properties) using the createOrganization
endpoint. To set a custom property on an existing account, use the updateOrganization
endpoint. For example:
PUT /ccadmin/v1/organizations/100001 HTTP/1.1
Authorization: Bearer <access_token>
{
"customerTier": "silver"
}