Connect REST API 開発者ガイド
jCommerce Webstore Wishlists
- リソース
-
1/commerce/webstores/webstoreId/wishlists - 使用可能なバージョン
- 49.0
- Chatter が必要かどうか
- いいえ
- HTTP のメソッド
- GET、POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン effectiveAccountId String 要求が行われた取引先の ID。 指定しない場合、デフォルトで、コンテキストユーザの accountID になります。 省略可能 49.0 includeDisplayedList Boolean 表示済みリストを含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。 省略可能 49.0 pageSize Integer ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。値を指定しない場合、デフォルトサイズは 25 です。 省略可能 51.0 productFields String カスタム商品項目のカンマ区切りリスト。項目では、大文字と小文字は区別されません。たとえば、ProductCode と productcode は同じ結果を返します。 includeDisplayedList が指定されていないか false である場合、productFields は無視されます。
省略可能 51.0 sortItemsBy String ウィッシュリスト品目の並び替え順。値は次のとおりです。 - CreatedDateAsc — 作成日の古い順に並び替えます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
デフォルトの並び替え順は、CreatedDateDesc です。
includeDisplayedList が指定されていないか false である場合、sortItemsBy は無視されます。
省略可能 51.0 wishlistId String ウィッシュリストの ID。指定されていない場合、すべてのウィッシュリストサマリーが返されます。 省略可能 49.0 - GET のレスポンスボディ
- Wishlist Summaries
- POST のリクエストボディ
-
- ルート XML タグ
- <wishlistInput>
- JSON の例
-
1{ 2"name":"My List", 3"products": [ 4 { 5 "productId": "01tRM000000Osl0YAC" 6 }, 7 { 8 "productId": "01tRM000000Oi92YAC" 9 }, 10 { 11 "productId": "01tRM000000NJCeYAO" 12 }] 13} - プロパティ
-
名前 型 説明 必須か省略可能 使用可能なバージョン name String ウィッシュリストの名前。 必須 49.0 products Wishlist Item Input[] ウィッシュリストに追加する商品のリスト。 省略可能 49.0
- POST の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン effectiveAccountId String 要求が行われた取引先の ID。 指定しない場合、デフォルトで、コンテキストユーザの accountID になります。 省略可能 49.0 - POST のレスポンスボディ
- Wishlist