入荷情報連携 (Webhook)
入荷情報連携 Webhook を用いると、nimaru に登録された出荷データを基幹システムでリアルタイムに受信できます。
入荷連携の有効化
各種登録から入荷連携を選択します。
備考
現在のところ、nimaru では GUI による入荷連携の設定機能を用意しておりません。 入荷連携をご利用される場合は、お手数ですが直接お問い合わせください。
入荷連携のリクエスト URL を設定すると、ユーザーにより出荷が作成された際、設定された URL に HTTP POST リクエストが送信されます。 リクエストボディには JSON が指定され、以下のような値をとります。
注意
unstable_ から始まるフィールドには、今後破壊的変更が加わる可能性があります。
| フィールド名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| id | uuid | 〇 | 出荷 ID (UUID v4) |
| date | string | 〇 | 出荷日 (ISO8601 拡張形式) |
| seller | string | 〇 | 出荷者 |
| convertedSeller | string | 〇 | 出荷者 (変換済) |
| unstable_oneDayCode | string | 〇 | 送り状発行用コード |
| items | ShipmentItem[] | 〇 | 出荷内容 |
ShipmentItem オブジェクト
| フィールド名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| id | uuid | 〇 | 出荷明細 ID (UUID v4) |
| index | int | 〇 | 行番号 |
| product | string | 〇 | 商品 |
| convertedProduct | string | 商品 (変換済) | |
| quality | string | 等級 | |
| convertedQuality | string | 等級 (変換済) | |
| size | string | 階級 | |
| convertedSize | string | 階級 (変換済) | |
| packaging | string | 荷姿 | |
| convertedPackaging | string | 荷姿 (変換済) | |
| origin | string | 産地 | |
| convertedOrigin | string | 産地 (変換済) | |
| unitWeight | int | count1 つあたりの重量 (g) | |
| displayUnitWeight | string | 量目 | |
| unitQuantity | int | 入数 | |
| count | string | 〇 | 数量 |