Custom Properties

SCAPI allows you to set custom properties of business objects in input documents and to read custom properties in output documents. Whether a business object supports custom properties can be found in the following tables. Custom properties are always marked with the prefix c_ and have therefore their own namespace.

The following example shows a document response including some custom properties:

SCAPI supports the following value types for input and output of custom properties:

• Text
• String
• Enum of Strings
• Set of Strings
• Integer
• Enum of Integers
• Set of Integers
• Double
• Set of Doubles
• Boolean
• EMail
• Password
• Date
• Date+Time

The following tables list the document types that support custom properties in OCAPI SHOP and DATA APIs. OCAPI modify... hooks that used the referenced document types can add custom properties using the c_ prefix. See Customization With Hooks for more information.

The following Shopper API documents support custom properties.