OCAPI flash 23.1

flash はドキュメントのプロパティで、ドキュメントに関する特別な情報が含まれています。

こういった情報は以下のいずれかである可能性があります:

• 入手できない商品が買い物カゴに含まれていることを示すメッセージ。
• 価格が設定されていない商品が買い物カゴに含まれていることを示すメッセージ。
• その他。

現在 Basket ドキュメントでのみ使用されています。flash が存在する場合は、買い物カゴをまだ送信できない理由があります。Basket リソースの例を参照してください。

Scripting API では、メソッド addFlash、removeFlash、または getFlashes() を使用して、flash をドキュメントから読み取り、追加、削除できます。flash はドキュメントの構造内のいずれかのオブジェクトに追加できます。たとえば、買い物カゴの請求先住所に flash を追加するには、パス $.post_code を、買い物カゴの商品品目の 1 つに追加するには、パス $.adjusted_price をそれぞれ使用します。クライアントにレスポンスを送信する前に、こういった flash はドキュメントに集計されて、パスは適切に調整されます (この例では、$.billing_address.post_code および $.product_items[0].adjusted_price)。

flash の追加、リスト、削除の使用例:

1exports.validateBasket = function(basketResponse) {
2     basketResponse.addFlash({
3       type: "MyType",
4       message: "My message",
5       path: "my_path",
6       details: {
7           "k1": "v1",
8           "k2": "v2"
9       }
10    });
11    var flashToRemove;
12    for each(f in basketResponse.flashes) {
13      if (f.type == "SomeOtherType") {
14        flashToRemove = f;
15      }
16    }
17    if (flashToRemove != null) {
18       basketResponse.removeFlash(flashToRemove);
19    }
20}