入荷予定伝票

プロパティ

プロパティ 説明
id [読取専用] ID
入荷予定伝票をユニークに識別するための数値です。主に、APIでのアクセスに使用します。入荷予定コードとは異なります。
code 入荷予定コード
inbound_delivery_category 入荷予定カテゴリ
status 入荷予定ステータス
supplier_name 仕入先名
supplier_name_kana 仕入先名かな
supplier_country 仕入先 国 - デフォルトは JP
supplier_post_code 仕入先 郵便番号
supplier_prefecture 仕入先 都道府県
supplier_address1 仕入先 住所1
supplier_address2 仕入先 住所2
supplier_address3 仕入先 住所3
supplier_phone 仕入先 電話番号
supplier_fax 仕入先 FAX番号
supplier_email 仕入先 メールアドレス
recipient_name お届け先名
recipient_name_kana お届け先名かな
recipient_country お届け先 国 - デフォルトは JP
recipient_post_code お届け先 郵便番号
recipient_prefecture お届け先 都道府県
recipient_address1 お届け先 住所1
recipient_address2 お届け先 住所2
recipient_address3 お届け先 住所3
recipient_phone お届け先 電話番号
recipient_fax お届け先 FAX番号
subtotal [読取専用] 商品合計金額(小計)
tax_processing_method 税の計算順序 - デフォルトは マーチャントの設定
tax_rounding_method 税の丸め - デフォルトは マーチャントの設定
document_tax_rate 伝票の税率 - デフォルトは 0
tax_total [読取専用] 税の合計
total [読取専用] 合計金額
delivery_preferred_date お届け希望日 - Y-m-d形式 (例 : 2018-01-01)
delivery_preferred_time_zone お届け希望時間帯
purchase_order_notes 発注書 特記事項
scheduled_delivery_date 納入予定日
delivery_career_name 納入配送会社
delivery_tracking_numbers [配列] 配送追跡番号の一覧
receiving_notes 入荷予定表 特記事項
remarks_on_received 入荷時の備考
attr1 フリー項目1
attr2 フリー項目2
attr3 フリー項目3
ordered_at 注文日時 - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59) - デフォルトは現在時刻
finished_at [読取専用] 完了日時 - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
created_at [読取専用] 登録日時 - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
updated_at [読取専用] 更新日時 - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
lines 明細行 - linesのプロパティを参照
supplier 仕入先 - supplierのプロパティを参照
warehouse 倉庫 - warehouseのプロパティを参照

lines

プロパティ 説明
id [読取専用] ID
入荷予定伝票明細行をユニークに識別するための数値です。主に、APIでのアクセスに使用します。
code 明細行コード
article_code [必須] 商品コード
supplier_article_code メーカー品番
article_name [必須] 商品名
article_option 明細行備考欄
deadline 出荷期限日 - Y-m-d形式 (例 : 2018-01-01)
lot_number ロット番号
price 価格 - デフォルトは 0
quantity 数量
received_quantity 検品済み数量
tax_indicator 税区分 - デフォルトは Included
tax_rate 税率 - デフォルトは 8
subtotal [読取専用] 小計
article [読取専用] 商品マスタ - articleのプロパティを参照

supplier

プロパティ 説明
id ID
仕入先をユニークに識別するための数値です。主に、APIでのアクセスに使用します。仕入先コードとは異なります。
code 仕入先コード
name 仕入先名

エンドポイント

入荷予定伝票の一覧を取得

リクエスト

GET /api/v1/merchant/#{merchant_id}/inbound_deliveries

パラメーター 説明
limit 取得する結果の数 - デフォルトは 20 最大値は 100
page ページ - デフォルトは 1
status 入荷予定ステータス - 複数指定する場合はカンマ区切り
ordered_at_from 作成日時(From) - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
ordered_at_to 作成日時(To) - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
finished_at_from 完了日時(From) - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
finished_at_to 完了日時(To) - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
updated_at_from 更新日時(From) - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
updated_at_to 更新日時(To) - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
warehouse 倉庫 - 倉庫ID

入荷予定伝票を登録

リクエスト

POST /api/v1/merchant/#{merchant_id}/inbound_deliveries/new

{
  "inbound_delivery": {
    "code":"test-20200901-1",
    "supplier_name":"東西商事",
    "lines": [
      {
          "article_code":"article-1",
          "article_name":"商品(1)",
        "price":1000,
        "quantity":1
      }
    ],
    "warehouse": 1
  }
}

レスポンス

HTTP/1.1 201 Created

{
  "id": "1234",
  "code": "test-20200901-1",
  "status": "WaitingForReceipt",
  "supplier_name": "東西商事",
  "recipient_name": "自社倉庫",
  "subtotal": 1000,
  "created_at": "2020-09-01 00:00:00",
  "updated_at": "2020-09-01 00:00:00",
  "lines":[
    {
      "id": 8837,
      "status": "WaitingForAllocation",
      "article_code": "article-1",
      "article_name": "商品(1)"
    }
  ],
  "warehouse":{
    "id": 1,
    "name": "自社倉庫"
  }
}

入荷予定情報をキャンセル

リクエスト

POST /api/v1/merchant/#{merchant_id}/inbound_deliveries/#{id}/reversal

パラメーター 説明
clears_code 同じ入荷予定コードで新規入荷予定の作成を許可 - デフォルトは false
{
  "clears_code": false
}

レスポンス

HTTP/1.1 200

{
  "id": "1234",
  "code": "test-20200901-1",
  "status": "Cancel",
  "supplier_name": "東西商事",
  "recipient_name": "自社倉庫",
  "subtotal": 1000,
  "created_at": "2020-09-01 00:00:00",
  "updated_at": "2020-09-01 00:00:00",
  "lines":[
    {
      "id": 8837,
      "status": "Cancel",
      "article_code": "article-1",
      "article_name": "商品(1)"
    }
  ],
  "warehouse":{
    "id": 1,
    "name": "自社倉庫"
  }
}