Commerce Webstore Wishlist

1 つのストアが複数のマーケットに分割されている場合、この API は、URL に付加されている言語パラメーターを調べて、買い物客のロケーションを判別し、該当する値を返します。

リソース

1/commerce/webstores/webstoreId/wishlists/wishlistId

使用可能なバージョン

49.0

HTTP のメソッド

GET、PATCH、DELETE

PATCH はバージョン 50.0 以降でサポートされます。

GET の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
effective​AccountId	String	要求が行われた取引先の ID。指定しない場合、デフォルトで、コンテキストユーザーの accountID になります。	省略可能	49.0
pageSize	Integer	ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。値を指定しない場合、デフォルトサイズは 25 です。	省略可能	51.0
product​Fields	String	カスタム商品項目のカンマ区切りリスト。項目では、大文字と小文字は区別されません。たとえば、ProductCode と productcode は同じ結果を返します。	省略可能	51.0
sortItemsBy	String	ウィッシュリスト品目の並べ替え順。値は次のとおりです。 CreatedDateAsc — 作成日の古い順に並べ替えます。 CreatedDateDesc — 作成日の新しい順に並べ替えます。 デフォルトの並べ替え順は、CreatedDateDesc です。	省略可能	51.0

GET のレスポンスボディ

Wishlist

PATCH のリクエストボディ

ルート XML タグ

<wishlistUpdateInput>

JSON の例

1{
2"name":"My List"
3}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
name	String	ウィッシュリスト名を更新します。	必須	50.0

PATCH の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
effective​AccountId	String	要求が行われた取引先の ID。指定しない場合、デフォルトで、コンテキストユーザーの accountID になります。	省略可能	50.0

PATCH のレスポンスボディ

Wishlist Summary

DELETE の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
effective​AccountId	String	要求が行われた取引先の ID。指定しない場合、デフォルトで、コンテキストユーザーの accountID になります。	省略可能	51.0

DELETE のレスポンスボディ

204: Successful Delete