Jump to

• Request
• Response

updateShopperType

put

/ccadmin/v1/shopperTypes/{id}

Update Shopper Type. Update an existing shopper type based on ID.You can add new properties or update existing properties. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  ID of shopper type.

Query Parameters

• allowNonUnderscoreNames: boolean
  If true, allow the creation of custom property names that do not contain an underscore('_').

Header Parameters

• X-CCAsset-Language(required): string
  The asset language of the request

Body ()

Root Schema : updateShopperType_request

Type: object

Show Source

• properties(required): array properties
  List of user-defined properties for shopper type.
• propertiesOrder: array propertiesOrder
  List of properties in ascending order

{
    "properties":{
        "propertiesOrder":{
            "description":"List of properties in ascending order",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "properties":{
            "description":"List of user-defined properties for shopper type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "readRole":{
                        "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
                        "type":"string"
                    },
                    "readSecurityLevel":{
                        "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
                        "type":"string"
                    },
                    "readAccessRight":{
                        "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
                        "type":"string"
                    },
                    "securityMaskingValue":{
                        "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
                        "type":"string"
                    },
                    "shopperReadable":{
                        "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
                        "type":"string"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of property.Required only while creating and not updating properties.",
                        "type":"string"
                    },
                    "writeSecurityLevel":{
                        "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
                        "type":"string"
                    },
                    "writeAccessRight":{
                        "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    },
                    "uiEditorType":{
                        "description":"The UI editor type.Required only while creating and not updating properties.",
                        "type":"string"
                    },
                    "internalOnly":{
                        "description":"Whether property is internal.",
                        "type":"boolean"
                    },
                    "default":{
                        "description":"Default property value of shopper type.",
                        "type":"string"
                    },
                    "textSearchable":{
                        "description":"Whether text is searchable or not.",
                        "type":"boolean"
                    },
                    "writeRole":{
                        "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
                        "type":"string"
                    },
                    "shopperWritable":{
                        "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
                        "type":"string"
                    },
                    "dimension":{
                        "description":"Dimension of property.",
                        "type":"string"
                    },
                    "multiSelect":{
                        "description":"whether multi-select search facet or not",
                        "type":"boolean"
                    }
                },
                "required":[
                    "uiEditorType",
                    "label",
                    "type"
                ]
            }
        }
    },
    "required":[
        "properties"
    ],
    "example":{
        "propertiesOrder":[
            "login",
            "password",
            "email",
            "autoLogin",
            "generatedPassword",
            "lastEmailed",
            "emailStatus",
            "receiveEmail",
            "lastPasswordGenerate",
            "lastActivity",
            "lastPasswordUpdate",
            "registrationDate",
            "derivedApprovalRequired",
            "firstName",
            "middleName",
            "derivedOrderPriceLimit",
            "lastName",
            "gender",
            "daytimeTelephoneNumber",
            "member",
            "userType",
            "locale",
            "securityStatus",
            "description",
            "realmId",
            "defaultCarrier",
            "abandonedOrderCount",
            "allowPartialShipment",
            "currentLocation",
            "accessTokenSigningKey",
            "expressCheckout"
        ],
        "properties":{
            "newProperty":{
                "internalOnly":false,
                "default":"null",
                "localizable":false,
                "id":"newProperty",
                "label":"New Property",
                "type":"shortText",
                "required":true,
                "order":2
            },
            "newDateProperty":{
                "internalOnly":false,
                "default":null,
                "localizable":false,
                "id":"newDateProperty",
                "label":"New Date Property",
                "type":"date",
                "required":false,
                "order":1
            }
        }
    }
}

Example:

{
    "propertiesOrder":[
        "login",
        "password",
        "email",
        "autoLogin",
        "generatedPassword",
        "lastEmailed",
        "emailStatus",
        "receiveEmail",
        "lastPasswordGenerate",
        "lastActivity",
        "lastPasswordUpdate",
        "registrationDate",
        "derivedApprovalRequired",
        "firstName",
        "middleName",
        "derivedOrderPriceLimit",
        "lastName",
        "gender",
        "daytimeTelephoneNumber",
        "member",
        "userType",
        "locale",
        "securityStatus",
        "description",
        "realmId",
        "defaultCarrier",
        "abandonedOrderCount",
        "allowPartialShipment",
        "currentLocation",
        "accessTokenSigningKey",
        "expressCheckout"
    ],
    "properties":{
        "newProperty":{
            "internalOnly":false,
            "default":"null",
            "localizable":false,
            "id":"newProperty",
            "label":"New Property",
            "type":"shortText",
            "required":true,
            "order":2
        },
        "newDateProperty":{
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "id":"newDateProperty",
            "label":"New Date Property",
            "type":"date",
            "required":false,
            "order":1
        }
    }
}

Nested Schema : properties

Type: array

List of user-defined properties for shopper type.

Show Source

• Array of: object items

{
    "description":"List of user-defined properties for shopper type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "readRole":{
                "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
                "type":"string"
            },
            "readSecurityLevel":{
                "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
                "type":"string"
            },
            "readAccessRight":{
                "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
                "type":"string"
            },
            "securityMaskingValue":{
                "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
                "type":"string"
            },
            "shopperReadable":{
                "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
                "type":"string"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "type":{
                "description":"Data type of property.Required only while creating and not updating properties.",
                "type":"string"
            },
            "writeSecurityLevel":{
                "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
                "type":"string"
            },
            "writeAccessRight":{
                "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            },
            "uiEditorType":{
                "description":"The UI editor type.Required only while creating and not updating properties.",
                "type":"string"
            },
            "internalOnly":{
                "description":"Whether property is internal.",
                "type":"boolean"
            },
            "default":{
                "description":"Default property value of shopper type.",
                "type":"string"
            },
            "textSearchable":{
                "description":"Whether text is searchable or not.",
                "type":"boolean"
            },
            "writeRole":{
                "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
                "type":"string"
            },
            "shopperWritable":{
                "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
                "type":"string"
            },
            "dimension":{
                "description":"Dimension of property.",
                "type":"string"
            },
            "multiSelect":{
                "description":"whether multi-select search facet or not",
                "type":"boolean"
            }
        },
        "required":[
            "uiEditorType",
            "label",
            "type"
        ]
    }
}

Nested Schema : propertiesOrder

Type: array

List of properties in ascending order

Show Source

• Array of: string

{
    "description":"List of properties in ascending order",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• default: string
  Default property value of shopper type.
• dimension: string
  Dimension of property.
• internalOnly: boolean
  Whether property is internal.
• label(required): string
  Label for new item type.
• multiSelect: boolean
  whether multi-select search facet or not
• readAccessRight: string
  Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)
• readRole: string
  Can be set to a single role id, in which case a user must have that role in order to read the property.
• readSecurityLevel: string
  Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute. Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error. Deny security is only available on custom properties.
• required: boolean
  Whether it is required or not.
• securityMaskingValue: string
  A value to return if the read fails the security check and the readSecurityLevel is ignore.
• shopperReadable: string
  If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.
• shopperWritable: string
  If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile.
• textSearchable: boolean
  Whether text is searchable or not.
• type(required): string
  Data type of property.Required only while creating and not updating properties.
• uiEditorType(required): string
  The UI editor type.Required only while creating and not updating properties.
• writeAccessRight: string
  Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)
• writeRole: string
  Can be set to a single role id, in which case a user must have that role in order to write the property.
• writeSecurityLevel: string
  Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that writes will fail silently. Deny means that attempts to write the property will result in an error.

{
    "type":"object",
    "properties":{
        "readRole":{
            "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
            "type":"string"
        },
        "readSecurityLevel":{
            "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
            "type":"string"
        },
        "readAccessRight":{
            "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
            "type":"string"
        },
        "securityMaskingValue":{
            "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
            "type":"string"
        },
        "shopperReadable":{
            "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
            "type":"string"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "type":{
            "description":"Data type of property.Required only while creating and not updating properties.",
            "type":"string"
        },
        "writeSecurityLevel":{
            "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
            "type":"string"
        },
        "writeAccessRight":{
            "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        },
        "uiEditorType":{
            "description":"The UI editor type.Required only while creating and not updating properties.",
            "type":"string"
        },
        "internalOnly":{
            "description":"Whether property is internal.",
            "type":"boolean"
        },
        "default":{
            "description":"Default property value of shopper type.",
            "type":"string"
        },
        "textSearchable":{
            "description":"Whether text is searchable or not.",
            "type":"boolean"
        },
        "writeRole":{
            "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
            "type":"string"
        },
        "shopperWritable":{
            "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
            "type":"string"
        },
        "dimension":{
            "description":"Dimension of property.",
            "type":"string"
        },
        "multiSelect":{
            "description":"whether multi-select search facet or not",
            "type":"boolean"
        }
    },
    "required":[
        "uiEditorType",
        "label",
        "type"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateShopperType_response

Type: object

Show Source

• displayName: string
  Display name of item type.
• id: string
  ID of shopper type.
• properties: array properties
  List of user-defined properties for shopper type.
• propertiesOrder: array propertiesOrder
  List of properties in ascending order

{
    "properties":{
        "propertiesOrder":{
            "description":"List of properties in ascending order",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "description":"Display name of item type.",
            "type":"string"
        },
        "id":{
            "description":"ID of shopper type.",
            "type":"string"
        },
        "properties":{
            "description":"List of user-defined properties for shopper type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "readRole":{
                        "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
                        "type":"string"
                    },
                    "readSecurityLevel":{
                        "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
                        "type":"string"
                    },
                    "readAccessRight":{
                        "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
                        "type":"string"
                    },
                    "securityMaskingValue":{
                        "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
                        "type":"string"
                    },
                    "shopperReadable":{
                        "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
                        "type":"string"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of property.",
                        "type":"string"
                    },
                    "writeSecurityLevel":{
                        "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
                        "type":"string"
                    },
                    "writeAccessRight":{
                        "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
                        "type":"string"
                    },
                    "searchable":{
                        "description":"Whether searchable or not.",
                        "type":"boolean"
                    },
                    "uiEditorType":{
                        "description":"The UI editor type ",
                        "type":"string"
                    },
                    "internalOnly":{
                        "description":"Whether property is internal.",
                        "type":"boolean"
                    },
                    "default":{
                        "description":"Default property value of shopper type.",
                        "type":"string"
                    },
                    "textSearchable":{
                        "description":"Whether text is searchable or not.",
                        "type":"boolean"
                    },
                    "writeRole":{
                        "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
                        "type":"string"
                    },
                    "shopperWritable":{
                        "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
                        "type":"string"
                    },
                    "dimension":{
                        "description":"Dimension of property.",
                        "type":"string"
                    },
                    "editableAttributes":{
                        "description":"List of editable attributes",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "internalOnly":{
                                    "description":"Whether properties are internal.",
                                    "type":"boolean"
                                },
                                "default":{
                                    "description":"Default editable attribute.",
                                    "type":"string"
                                },
                                "textSearchable":{
                                    "description":"Whether property is searchable or not.",
                                    "type":"boolean"
                                },
                                "label":{
                                    "description":"Label for the item type.",
                                    "type":"string"
                                },
                                "dimension":{
                                    "description":"Dimensions of item type.",
                                    "type":"string"
                                },
                                "required":{
                                    "description":"Whether it is required or not.",
                                    "type":"boolean"
                                },
                                "searchable":{
                                    "description":"Whether item searchable or not.",
                                    "type":"boolean"
                                }
                            }
                        }
                    },
                    "multiSelect":{
                        "description":"whether multi-select search facet or not",
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : properties

Type: array

List of user-defined properties for shopper type.

Show Source

• Array of: object items

{
    "description":"List of user-defined properties for shopper type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "readRole":{
                "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
                "type":"string"
            },
            "readSecurityLevel":{
                "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
                "type":"string"
            },
            "readAccessRight":{
                "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
                "type":"string"
            },
            "securityMaskingValue":{
                "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
                "type":"string"
            },
            "shopperReadable":{
                "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
                "type":"string"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "type":{
                "description":"Data type of property.",
                "type":"string"
            },
            "writeSecurityLevel":{
                "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
                "type":"string"
            },
            "writeAccessRight":{
                "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
                "type":"string"
            },
            "searchable":{
                "description":"Whether searchable or not.",
                "type":"boolean"
            },
            "uiEditorType":{
                "description":"The UI editor type ",
                "type":"string"
            },
            "internalOnly":{
                "description":"Whether property is internal.",
                "type":"boolean"
            },
            "default":{
                "description":"Default property value of shopper type.",
                "type":"string"
            },
            "textSearchable":{
                "description":"Whether text is searchable or not.",
                "type":"boolean"
            },
            "writeRole":{
                "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
                "type":"string"
            },
            "shopperWritable":{
                "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
                "type":"string"
            },
            "dimension":{
                "description":"Dimension of property.",
                "type":"string"
            },
            "editableAttributes":{
                "description":"List of editable attributes",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "internalOnly":{
                            "description":"Whether properties are internal.",
                            "type":"boolean"
                        },
                        "default":{
                            "description":"Default editable attribute.",
                            "type":"string"
                        },
                        "textSearchable":{
                            "description":"Whether property is searchable or not.",
                            "type":"boolean"
                        },
                        "label":{
                            "description":"Label for the item type.",
                            "type":"string"
                        },
                        "dimension":{
                            "description":"Dimensions of item type.",
                            "type":"string"
                        },
                        "required":{
                            "description":"Whether it is required or not.",
                            "type":"boolean"
                        },
                        "searchable":{
                            "description":"Whether item searchable or not.",
                            "type":"boolean"
                        }
                    }
                }
            },
            "multiSelect":{
                "description":"whether multi-select search facet or not",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : propertiesOrder

Type: array

List of properties in ascending order

Show Source

• Array of: string

{
    "description":"List of properties in ascending order",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• default: string
  Default property value of shopper type.
• dimension: string
  Dimension of property.
• editableAttributes: array editableAttributes
  List of editable attributes
• internalOnly: boolean
  Whether property is internal.
• label: string
  Label for new item type.
• multiSelect: boolean
  whether multi-select search facet or not
• readAccessRight: string
  Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)
• readRole: string
  Can be set to a single role id, in which case a user must have that role in order to read the property.
• readSecurityLevel: string
  Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute. Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error. Deny security is only available on custom properties.
• searchable: boolean
  Whether searchable or not.
• securityMaskingValue: string
  A value to return if the read fails the security check and the readSecurityLevel is ignore.
• shopperReadable: string
  If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.
• shopperWritable: string
  If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile.
• textSearchable: boolean
  Whether text is searchable or not.
• type: string
  Data type of property.
• uiEditorType: string
  The UI editor type
• writeAccessRight: string
  Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)
• writeRole: string
  Can be set to a single role id, in which case a user must have that role in order to write the property.
• writeSecurityLevel: string
  Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that writes will fail silently. Deny means that attempts to write the property will result in an error.

{
    "type":"object",
    "properties":{
        "readRole":{
            "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
            "type":"string"
        },
        "readSecurityLevel":{
            "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
            "type":"string"
        },
        "readAccessRight":{
            "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
            "type":"string"
        },
        "securityMaskingValue":{
            "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
            "type":"string"
        },
        "shopperReadable":{
            "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
            "type":"string"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "type":{
            "description":"Data type of property.",
            "type":"string"
        },
        "writeSecurityLevel":{
            "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
            "type":"string"
        },
        "writeAccessRight":{
            "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
            "type":"string"
        },
        "searchable":{
            "description":"Whether searchable or not.",
            "type":"boolean"
        },
        "uiEditorType":{
            "description":"The UI editor type ",
            "type":"string"
        },
        "internalOnly":{
            "description":"Whether property is internal.",
            "type":"boolean"
        },
        "default":{
            "description":"Default property value of shopper type.",
            "type":"string"
        },
        "textSearchable":{
            "description":"Whether text is searchable or not.",
            "type":"boolean"
        },
        "writeRole":{
            "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
            "type":"string"
        },
        "shopperWritable":{
            "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
            "type":"string"
        },
        "dimension":{
            "description":"Dimension of property.",
            "type":"string"
        },
        "editableAttributes":{
            "description":"List of editable attributes",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "internalOnly":{
                        "description":"Whether properties are internal.",
                        "type":"boolean"
                    },
                    "default":{
                        "description":"Default editable attribute.",
                        "type":"string"
                    },
                    "textSearchable":{
                        "description":"Whether property is searchable or not.",
                        "type":"boolean"
                    },
                    "label":{
                        "description":"Label for the item type.",
                        "type":"string"
                    },
                    "dimension":{
                        "description":"Dimensions of item type.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    },
                    "searchable":{
                        "description":"Whether item searchable or not.",
                        "type":"boolean"
                    }
                }
            }
        },
        "multiSelect":{
            "description":"whether multi-select search facet or not",
            "type":"boolean"
        }
    }
}

Nested Schema : editableAttributes

Type: array

List of editable attributes

Show Source

• Array of: object items

{
    "description":"List of editable attributes",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "internalOnly":{
                "description":"Whether properties are internal.",
                "type":"boolean"
            },
            "default":{
                "description":"Default editable attribute.",
                "type":"string"
            },
            "textSearchable":{
                "description":"Whether property is searchable or not.",
                "type":"boolean"
            },
            "label":{
                "description":"Label for the item type.",
                "type":"string"
            },
            "dimension":{
                "description":"Dimensions of item type.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            },
            "searchable":{
                "description":"Whether item searchable or not.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• default: string
  Default editable attribute.
• dimension: string
  Dimensions of item type.
• internalOnly: boolean
  Whether properties are internal.
• label: string
  Label for the item type.
• required: boolean
  Whether it is required or not.
• searchable: boolean
  Whether item searchable or not.
• textSearchable: boolean
  Whether property is searchable or not.

{
    "type":"object",
    "properties":{
        "internalOnly":{
            "description":"Whether properties are internal.",
            "type":"boolean"
        },
        "default":{
            "description":"Default editable attribute.",
            "type":"string"
        },
        "textSearchable":{
            "description":"Whether property is searchable or not.",
            "type":"boolean"
        },
        "label":{
            "description":"Label for the item type.",
            "type":"string"
        },
        "dimension":{
            "description":"Dimensions of item type.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        },
        "searchable":{
            "description":"Whether item searchable or not.",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

{
    "propertiesOrder":[
        "login",
        "password",
        "email",
        "autoLogin",
        "generatedPassword",
        "lastEmailed",
        "emailStatus",
        "receiveEmail",
        "lastPasswordGenerate",
        "lastActivity",
        "lastPasswordUpdate",
        "registrationDate",
        "derivedApprovalRequired",
        "firstName",
        "middleName",
        "derivedOrderPriceLimit",
        "lastName",
        "gender",
        "daytimeTelephoneNumber",
        "member",
        "userType",
        "locale",
        "securityStatus",
        "description",
        "realmId",
        "defaultCarrier",
        "abandonedOrderCount",
        "allowPartialShipment",
        "currentLocation",
        "accessTokenSigningKey",
        "expressCheckout"
    ],
    "displayName":"User",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/shopperTypes/user?properties=%5Bobject%20Object%5D"
        }
    ],
    "id":"user",
    "properties":{
        "lastName":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Last name",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "accessTokenSigningKey":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"accessTokenSigningKey",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "gender":{
            "internalOnly":null,
            "default":"female",
            "length":32,
            "textSearchable":false,
            "localizable":false,
            "label":"Gender",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "generatedPassword":{
            "internalOnly":null,
            "default":false,
            "length":1,
            "textSearchable":false,
            "localizable":false,
            "label":"Generated password",
            "type":"checkbox",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "allowPartialShipment":{
            "internalOnly":null,
            "default":false,
            "length":1,
            "textSearchable":false,
            "localizable":false,
            "label":"Allow partial shipment",
            "type":"checkbox",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "defaultCarrier":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Default carrier",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "description":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Description",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "locale":{
            "internalOnly":null,
            "default":null,
            "length":32,
            "textSearchable":false,
            "localizable":false,
            "label":"Locale",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "login":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Login name",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "searchable"
            ],
            "required":true,
            "searchable":false,
            "multiSelect":null
        },
        "securityStatus":{
            "internalOnly":null,
            "default":0,
            "length":10,
            "textSearchable":false,
            "localizable":false,
            "label":"Security status",
            "type":"number",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "autoLogin":{
            "internalOnly":null,
            "default":false,
            "length":1,
            "textSearchable":false,
            "localizable":false,
            "label":"Auto login",
            "type":"checkbox",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "password":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Password",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "searchable"
            ],
            "required":true,
            "searchable":false,
            "multiSelect":null
        },
        "registrationDate":{
            "internalOnly":null,
            "default":"2015-08-04T03:42:42.876Z",
            "length":26,
            "textSearchable":false,
            "localizable":false,
            "label":"Registration date",
            "type":"date",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "member":{
            "internalOnly":null,
            "default":false,
            "length":1,
            "textSearchable":false,
            "localizable":false,
            "label":"Member",
            "type":"checkbox",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "lastPasswordGenerate":{
            "internalOnly":null,
            "default":null,
            "length":26,
            "textSearchable":false,
            "localizable":false,
            "label":"lastPasswordGenerate",
            "type":"date",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "email":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Email address",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "daytimeTelephoneNumber":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Daytime telephone number",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "realmId":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Profile Realm",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "derivedOrderPriceLimit":{
            "internalOnly":null,
            "default":null,
            "length":22,
            "textSearchable":false,
            "localizable":false,
            "label":"Order limit",
            "type":"number",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "receiveEmail":{
            "internalOnly":null,
            "default":"yes",
            "length":32,
            "textSearchable":false,
            "localizable":false,
            "label":"Receive email",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "lastEmailed":{
            "internalOnly":null,
            "default":null,
            "length":26,
            "textSearchable":false,
            "localizable":false,
            "label":"lastEmailed",
            "type":"date",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "currentLocation":{
            "internalOnly":null,
            "default":"unknown",
            "length":0,
            "textSearchable":false,
            "localizable":false,
            "label":"Current location",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "abandonedOrderCount":{
            "internalOnly":null,
            "default":null,
            "length":10,
            "textSearchable":false,
            "localizable":false,
            "label":"Number of abandoned orders",
            "type":"number",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "firstName":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"First name",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "emailStatus":{
            "internalOnly":null,
            "default":"unknown",
            "length":32,
            "textSearchable":false,
            "localizable":false,
            "label":"Email status",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "derivedApprovalRequired":{
            "internalOnly":null,
            "default":false,
            "length":1,
            "textSearchable":false,
            "localizable":false,
            "label":"Approval required",
            "type":"checkbox",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "expressCheckout":{
            "internalOnly":null,
            "default":false,
            "length":1,
            "textSearchable":false,
            "localizable":false,
            "label":"Express checkout",
            "type":"checkbox",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "lastPasswordUpdate":{
            "internalOnly":null,
            "default":"2015-08-04T03:42:42.962Z",
            "length":26,
            "textSearchable":false,
            "localizable":false,
            "label":"Last password update",
            "type":"date",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "lastActivity":{
            "internalOnly":null,
            "default":null,
            "length":26,
            "textSearchable":false,
            "localizable":false,
            "label":"Last activity",
            "type":"date",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "middleName":{
            "internalOnly":null,
            "default":null,
            "length":254,
            "textSearchable":false,
            "localizable":false,
            "label":"Middle name",
            "type":"shortText",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":null
        },
        "userType":{
            "internalOnly":null,
            "default":null,
            "length":10,
            "textSearchable":false,
            "localizable":false,
            "label":"User type",
            "type":"number",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "required":false,
            "searchable":false,
            "multiSelect":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| |------------------|------------------| |75002|No properties specified| |75001|Not supported type|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top