OCAPI カスタムプロパティ 23.1

Open Commerce API では、入力ドキュメントでビジネスオブジェクトのカスタムプロパティを設定でき、出力ドキュメントでカスタムプロパティを読み取れます。ビジネスオブジェクトがカスタムプロパティをサポートしているかどうかは、該当するドキュメントの説明を参照してください。ドキュメンテーションのドキュメントに(supports custom properties) (カスタムプロパティをサポート) の見出しが記載されている場合は、ドキュメントでカスタムプロパティの設定または読み取りを行えます。カスタムプロパティは常に接頭辞 c_ でマークされているため、独自の名前空間をもちます。

次の例は、一部の OCAPI のカスタムプロパティを含むドキュメントのレスポンスを示します:

1REQUEST: GET /dw/shop/v23_1/products/creative-zen-v HTTP/1.1
2Host: example.com
3Accept: application/json
4
5RESPONSE: HTTP/1.1 200 OK
6Content-Type:  application/json; charset=UTF-8
7Cache-Control:  max-age=900,must-revalidate
8{
9   ...
10   "c_mediaFormat" : [ "0010", "0020", "0030", "0040" ],
11   "c_memorySize" : "1GB",
12   "c_tabDescription" : "The ZEN V player was designed for people like you those who walk a step or two ahead of the pack."
13}

OCAPI のカスタムプロパティの入力および出力では、次の値タイプがサポートされています。

• Text (テキスト)
• String (文字列)
• Enum of Strings (文字列の列挙)
• Set of Strings (文字列のセット)
• Integer (整数)
• Enum of Integers (整数の列挙)
• Set of Integers (整数のセット)
• Double (倍精度)
• Set of Doubles (倍精度のセット)
• Boolean (ブール値)
• EMail (E メール)
• Password (パスワード)
• Date (日付)
• 日付+時刻