出荷伝票
プロパティ
| プロパティ | 説明 |
|---|---|
| id | [読取専用] ID 出荷伝票をユニークに識別するための数値です。主に、APIでのアクセスに使用します。出荷コードとは異なります。 |
| code | 出荷コード |
| document_status | 伝票ステータス |
| allocation_status | 引当ステータス |
| delivery_status | 配送ステータス |
| shipper_name1 | 荷送人名(1) |
| shipper_name2 | 荷送人名(2) |
| shipper_name_kana1 | 荷送人名かな(1) |
| shipper_name_kana2 | 荷送人名かな(2) |
| shipper_country | 荷送人 国 - デフォルトは JP |
| shipper_post_code | 荷送人 郵便番号 |
| shipper_prefecture | 荷送人 都道府県 |
| shipper_address1 | 荷送人 住所1 |
| shipper_address2 | 荷送人 住所2 |
| shipper_address3 | 荷送人 住所3 |
| shipper_phone | 荷送人 電話番号 |
| recipient_name1 | お届け先名(1) |
| recipient_name2 | お届け先名(2) |
| recipient_name_kana1 | お届け先名かな(1) |
| recipient_name_kana2 | お届け先名かな(2) |
| recipient_country | お届け先 国 - デフォルトは JP |
| recipient_post_code | お届け先 郵便番号 |
| recipient_prefecture | お届け先 都道府県 |
| recipient_address1 | お届け先 住所1 |
| recipient_address2 | お届け先 住所2 |
| recipient_address3 | お届け先 住所3 |
| recipient_phone | お届け先 電話番号 |
| codTotal | 代金引換合計金額 - デフォルトは 0 |
| delivery_method | 配送方法 |
| delivery_package_quantity | 梱包数 - デフォルトは 1 |
| delivery_temperature_control | 配送温度 - デフォルトは Normal |
| scheduled_shipping_date | 出荷予定日 - Y-m-d形式 (例 : 2018-01-01) |
| delivery_preferred_date | お届け希望日 - Y-m-d形式 (例 : 2018-01-01) |
| delivery_preferred_time_zone | お届け希望時間帯 |
| delivery_tracking_numbers | [配列] 配送追跡番号の一覧 |
| picking_notes | 出荷指示書 特記事項 |
| way_bill_notes | 送り状 特記事項 |
| gift | ギフトかどうか - ギフトの場合は 1 |
| wrapping | ラッピング |
| attr1 | フリー項目1 |
| attr2 | フリー項目2 |
| attr3 | フリー項目3 |
| noshi | 熨斗 |
| total_quantity | 合計数量 |
| total_weight | 合計重量 |
| total_size_coefficient | 合計サイズ係数 |
| lines | 明細行 - linesのプロパティを参照 |
| shipped_actual_stocks | [読取専用] 出荷済みの物理在庫 - shipped_actual_stocksのプロパティを参照 |
| warehouse | 出荷元倉庫 - 倉庫ID |
| store | 店舗 - 店舗ID |
| sales_order | 受注伝票 - sales_orderのプロパティを参照 ※同梱された出荷伝票の場合、同梱先となった受注伝票がセットされます。出荷された全ての受注伝票を取得するには、 linesエンティティのoriginを参照します。 |
line
| プロパティ | 説明 |
|---|---|
| id | [読取専用] ID 受注伝票明細行をユニークに識別するための数値です。主に、APIでのアクセスに使用します。 |
| code | 明細行コード |
| status | [読取専用] 明細ステータス |
| article_code | [必須] 商品コード |
| article_name | [必須] 商品名 |
| article_option | 明細行備考欄 |
| price | 価格 - デフォルトは 0 |
| quantity | 数量 |
| tax_indicator | 税区分 - デフォルトは Included |
| tax_rate | 税率 - デフォルトは 8 |
| subtotal | [読取専用] 小計 |
| article | [読取専用] 商品マスタ - articleのプロパティを参照 |
| origin | [読取専用] 受注伝票 - originのプロパティを参照 |
origin
| プロパティ | 説明 |
|---|---|
| id | [読取専用] ID 受注伝票をユニークに識別するための数値です。主に、APIでのアクセスに使用します。受注コードとは異なります。 |
| code | 受注コード |
shipped_actual_stocks
伝票ステータスが出荷済みで、かつ出荷期限日、またはロット番号が含まれる在庫が引き当てられた場合に利用できます。
| プロパティ | 説明 |
|---|---|
| article_code | [必須] 商品コード |
| deadline | 出荷期限日 - Y-m-d形式 (例 : 2018-01-01) |
| lot_number | ロット番号 |
sales_order
| プロパティ | 説明 |
|---|---|
| id | ID 受注伝票をユニークに識別するための数値です。主に、APIでのアクセスに使用します。受注コードとは異なります。 |
| code | 受注コード |
| parent_code | 親受注コード |
エンドポイント
出荷伝票の一覧を取得
リクエスト
GET /api/v1/merchant/#{merchant_id}/outbound_deliveries
| パラメーター | 説明 |
|---|---|
| limit | 取得する結果の数 - デフォルトは 20 最大値は 100 |
| page | ページ - デフォルトは 1 |
| id | ID |
| object_code | 出荷管理番号 |
| document_status | 伝票ステータス - 複数指定する場合はカンマ区切り |
| delivery_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 |
| store | 店舗 - 店舗ID |