Shopping Progress Notifications
WEBHOOK: POSThttps://<YOUR_WEBHOOK_URI> event_type: event.shopping_progress
Courier Pick & Pack には Shopping Progress Webhook の通知があります。これらの新しい Webhook は、配達パートナーが買い物をしているときに商品に対して何らかのアクションを起こすたびに送信されます。それぞれの商品に複数のイベントが設定される可能性があります。たとえば配達パートナーが商品を交換し、注文者がその代替品に満足できない場合、配達パートナーがフォローアップの対応(新しい代替品を指定する、あるいは商品を完全に削除するなど)を行うと、タイプが event.shopping_progress
の新しい Webhook イベントが送信されます。
¶ Webhook のサンプル
ステータスや状況によってフィールドは異なります。正確なフィールド定義のため、ご自身で「フィールドの定義」を参照し、確認してください。
{
"created": "53927476-05-31T05:00:54.505Z",
"data": {
"manifest_item": {
"name": "Bud Light 12x 12oz Cans",
"price": 1578,
"quantity": 1,
"fulfilled_quantity": null,
"sku": "098083535562"
},
"replacement_item": {
"name": "Sierra Nevada Pale Ale 6x 12oz Cans",
"price": 1130,
"quantity": 1,
"sku": "083783535419"
}
},
"delivery_id": "16a7622c-7acb-4641-8acb-2862fdb11452",
"id": "evt_ss69d6NfTwSWPJas2uCJxA",
"item_status": "suggested",
"kind": "event.shopping_progress"
}
¶ フィールドの定義
フィールド | 説明 |
---|---|
created |
イベントがいつ生成されたかを示すタイムスタンプ。 |
delivery_id |
イベントが適用される配達の識別子。 |
data |
Webhook の詳細。詳細については「データオブジェクトの定義」を参照してください。 |
id |
このイベントインスタンスの一意の識別子。 |
kind |
イベントの種類の詳細(event.courier_update)。 |
live_mode |
イベントがライブの配達とテスト配達のどちらに適用されるかを示すフラグ。 |
developer_id |
上記の customer_id がマッピングされる開発者の一意の識別子。 |
route_id |
ルートの一意の識別子。この値を使用して、1 人の配達パートナーが複数の配達をピックアップするケースを特定できます。 |
item_status |
商品のステータス(確保済み、削除済み、交換済み、提案済み)。 |
¶ データオブジェクトの定義
データオブジェクトには、Webhook に関するより詳しい情報が格納されます。
フィールド | 説明 |
---|---|
manifest_item |
CreateDelivery で当初リクエストされた商品。 |
manifest_item.name |
商品の名前。 |
manifest_item.quantity |
リクエストされた商品の数量。 |
manifest_item.fulfilled_quantity |
ピッキングした実際の数量。 |
manifest_item.sku |
販売業者のシステムで商品に設定された外部 ID。 |
manifest_item.price |
料金(セント単位、通貨単位の 100 分の 1)。例:10.99 ドル => 1099。 |
manifest_item.weight |
重量(グラム)。 |
manifest_item.fulfilled_weight |
グラム単位でピッキングした実際の重量。 |
manifest_item.replacement_item |
元の商品が見つからなかった場合の代替品。 |
manifest_item.replacement_item.name |
商品の名前。 |
manifest_item.replacement_item.quantity |
代替品の数量。 |
manifest_item.replacement_item.sku |
販売業者のシステムで商品に設定された外部 ID。 |
manifest_item.replacement_item.price |
料金(セント単位、通貨単位の 100 分の 1)。例:10.99 ドル => 1099。 |
manifest_item.replacement_item.weight |
重量(グラム)。 |