Commerce Webstore Cart Items

カートへの参照アクセス権を持つバイヤーは、カートで品目を追加、更新、および削除できます。

カートへの品目の追加ではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがアクセスできます。

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

リソース

cartStateOrId の値は次のとおりです。

• cartId — カートの ID。
• active — 有効なカート。
• current — クローズまたは削除待機中でないカート。バージョン 50.0 以降で利用できます。

使用可能なバージョン

49.0

HTTP のメソッド

GET、POST

GET の要求パラメーター

名前	型	説明	必須か省略可能	使用可能なバージョン
currencyIsoCode	String	カートの通貨 ISO コード。	省略可能	57.0
effective​AccountId	String	要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。指定されていない場合、デフォルト値はコンテキストから決定されます。	省略可能	49.0
includeCoupons	Boolean	クーポンを含めるか (True)、否か (False) を示します。	省略可能	59.0
includePromotions	Boolean	プロモーションを含めるか (True)、否か (False) を示します。	省略可能	59.0
page	String	情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答の一部として返されます。値を指定しないと、最初のページが返されます。	省略可能	49.0
pageNumber	Integer	要求されたページ番号を指定します。	省略可能	60.0
pageSize	Integer	ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。値を指定しない場合、デフォルトサイズは 25 です。	省略可能	49.0
productFields	String []	商品項目が 5 個のカンマ区切りリスト。結果に含まれるのは、アクセス権のある項目のみです。商品項目によっては (productName や sku など)、productFields パラメーターに指定されていなくても返されるものがあります。	省略可能	49.0
sort	String	カート内の品目の順序を並べ替えます。値は次のとおりです。 CreatedDateAsc — 作成日の古い順に並べ替えます。 CreatedDateDesc — 作成日の新しい順に並べ替えます。 NameAsc — 名前がアルファベットの昇順 (A ～ Z) で並べ替えられます。 NameDesc — 名前がアルファベットの降順 (Z ～ A) で並べ替えられます。 SalesPriceAsc — 交渉済み価格が低い順に並べ替えられます。 SalesPriceDesc — 交渉済み価格が高い順に並べ替えられます。 指定されていない場合、デフォルトは CreatedDateDesc です。	省略可能	49.0

GET のレスポンスボディ

Cart Item Collection

非同期のカート処理中、有効になっている場合、GET 応答ヘッダーには Location と Retry-After が含まれます。カートの処理中、GET 要求は 202 状況を返し、古い、null、または 0 の価格設定データが含まれる場合があります。カートの処理が完了すると、要求は最新の価格設定データを含む 200 状況を返します。

POST のリクエストボディ

ルート XML タグ

<cartItem>

カートに品目を追加する JSON の例

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
cartDelivery​GroupId	String	カートの配送グループの ID。	省略可能	59.0
productId	String	商品の ID。	カートに品目を追加する場合は必須 (POST) カートの品目を更新する場合はサポート対象外 (PATCH)	49.0
productSelling​ModelId	String	将来の使用のために予約されています。	省略可能	59.0
quantity	String	カート品目の数量。BigDecimal に変換可能な値を使用します。	必須	49.0
subscriptionTerm	Integer	将来の使用のために予約されています。	省略可能	59.0
type	String	カート内の品目の種別。値は Product です。	カートに品目を追加する場合は必須 (POST) カートの品目を更新する場合はサポート対象外 (PATCH)	49.0

POST の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
currencyIsoCode	String	カートの通貨 ISO コード。	省略可能	57.0
effective​AccountId	String	要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。指定されていない場合、デフォルト値はコンテキストから決定されます。	省略可能	49.0
productFields	String []	商品項目が 5 個のカンマ区切りリスト。結果に含まれるのは、アクセス権のある項目のみです。	省略可能	49.0

POST のレスポンスボディ

Cart Item