カスタムプロパティ
SCAPI では、入力文書のビジネスオブジェクトのカスタムプロパティを設定したり、出力文書のカスタムプロパティを読み込んだりすることができます。ビジネスオブジェクトがカスタムプロパティをサポートするかどうかは、以下の表のとおりです。
カスタムプロパティは常に接頭辞 c_ でマークされているため、独自の名前空間をもちます。
次の例は、いくつかのカスタムプロパティを含むドキュメントレスポンスを示しています。
SCAPI では、カスタムプロパティの入力と出力で次の値タイプがサポートされています。
- Text (テキスト)
- String (文字列)
- Enum of Strings (文字列の列挙)
- Set of Strings (文字列のセット)
- Integer (整数)
- Enum of Integers (整数の列挙)
- Set of Integers (整数のセット)
- Double (倍精度)
- Set of Doubles (倍精度のセット)
- Boolean (ブール値)
- EMail (E メール)
- Password (パスワード)
- Date (日付)
- Date+Time (日付+時刻)
HTML と Image の値タイプは出力としてのみサポートされていますが、SCAPI のカスタムプロパティの入力値タイプとしてはサポートされていません。
以下の表は、OCAPI SHOP API と DATA API でカスタムプロパティをサポートするドキュメントタイプの一覧です。参照されるドキュメントタイプを使用した OCAPI modify... フックは、
c_ 接頭辞を使用してカスタムプロパティを追加できます。詳細については、フックによるカスタマイズを参照してください。
以下の Shopper API ドキュメントでは、カスタムプロパティがサポートされています。
| ドキュメントタイプ | 参照 |
|---|---|
| Basket v1 (買い物カゴ v1) | Basket v1 |
| Basket v2 (買い物カゴ v2) | Basket v2 |
| BasketPaymentInstrumentRequest (買い物カゴの支払手段のリクエスト) | BasketPaymentInstrumentRequest |
| BonusDiscountLineItem (ボーナス割引品目) | BonusDiscountLineItem |
| Category (カテゴリ) | Category |
| CouponItem (クーポン品目) | CouponItem |
| CustomObject (カスタムオブジェクト) | customObject |
| Customer (顧客) | Customer |
| CustomerAddress (顧客住所) | CustomerAddress |
| CustomerInfo (顧客情報) | CustomerInfo |
| CustomerPaymentInstrument (顧客の支払手段) | CustomerPaymentInstrument |
| CustomerPaymentInstrumentRequest (顧客の支払手段のリクエスト) | CustomerPaymentInstrumentRequest |
| CustomerProductList (顧客の商品リスト) | CustomerProductList |
| CustomerProductListItem (顧客商品リスト品目) | CustomerProductListItem |
| CustomerProductListItemPurchase (顧客商品リスト品目の購入) | CustomerProductListItemPurchase |
| GiftCertificate (ギフト券) | GiftCertificate |
| GiftCertificateItem (ギフト券品目) | GiftCertificateItem |
| OptionItem (オプション品目) | OptionItem |
| Order (注文) | Order |
| OrderAddress (注文の住所) | OrderAddress |
| OrderPaymentInstrument (注文の支払手段) | OrderPaymentInstrument |
| OrderPaymentInstrumentRequest (注文の支払手段のリクエスト) | OrderPaymentInstrumentRequest |
| PathRecord (パスレコード) | PathRecord |
| PaymentCardSpec (支払カードの仕様) | PaymentCardSpec |
| PaymentMethod (支払方法) | PaymentMethod |
| PriceAdjustment (価格調整) | PriceAdjustment |
| PriceAdjustmentRequest (価格調整リクエスト) | PriceAdjustmentRequest |
| Product (商品) | Product |
| ProductItem (商品品目) | ProductItem |
| ProductListItem (商品リスト品目) | CustomerProductListItem |
| ProductListItemReference (商品リスト品目の参照) | ProductListItemReference |
| ProductListLink (商品リストへのリンク) | ProductListLink |
| ProductSearchHit (商品検索ヒット) | ProductSearchHit |
| Promotion (プロモーション) | Promotion |
| PublicProductList (公開商品リスト) | PublicProductList |
| PublicProductListItem (公開商品リスト品目) | PublicProductListItem |
| PublicProductListLink (公開商品リストへのリンク) | ProductListLink |
| Recommendation (推奨項目) | recommendation |
| Shipment (配送) | Shipment |
| ShippingItem (配送品目) | shipping_item |
| ShippingMethod (配送方法) | ShippingMethod |
| ShippingPromotion (配送プロモーション) | ShippingPromotion |
| Store (店舗) | Store |
| SuggestedCategory (提案されたカテゴリ) | SuggestedCategory |
| SuggestedPhrase (提案されたフレーズ) | SuggestedPhrase |
| SuggestedProduct (提案された商品) | SuggestedProduct |
| Suggestion (提案) | Suggestion |