GET /api/v1/orders.php

概要
受注データのリストを取得（取得件数が指定されていない場合は50件）

リクエストパラメータ

パラメータ名 有効な値 説明
serial_order_id 受注ＩＤ 受注ＩＤを検索
order_date_from 受注日時開始 YYYY-MM-DD hh:mm:ss 指定した日時以後の受注を検索
order_date_to 受注日時終了 YYYY-MM-DD hh:mm:ss 指定した日時までの受注を検索
limit 取得件数 指定なしの場合50。最大50。
offset 取得開始位置 指定した数値+1件目のデータを返す
fields 取得項目 serial_order_idを指定すると、受注IDのリストのみ取得されます。指定しない場合は、全項目が取得されます。

レスポンス

   {
      "success":"ok"
     ,"error_cd":"N-0001"
     ,"error_message":""
     ,"orders":[{                               // 受注情報
          "serial_order_id":"107186"            
          "groups":[{}]                         // 同梱情報
          "details":[{}]                        // 明細
          "shippings":[{}]                      // お届け先
      }]
   }

受注情報

項目名 項目内容 説明
serial_order_id 受注ＩＤ
order_customer_id 顧客ID 注文者の顧客ID
order_message 注文備考
order_name01 注文者お名前（姓）
order_name02 注文者お名前（名）
order_kana01 注文者お名前カナ（姓）
order_kana02 注文者お名前カナ（名）
order_company_name 注文者会社名
order_email 注文者メールアドレス
order_email_type 注文者メールアドレス種類 1:PC、2:ｽﾏｰﾄﾌｫﾝ、3:ｶﾞﾗｹｰ
order_tel 注文者電話番号 -なし
order_fax 注文者FAX番号 -なし
order_country 注文者国 日本
order_zip 注文者郵便番号 999-9999
order_pref 注文者都道府県
order_addr01 注文者住所１
order_addr02 注文者住所２
order_sex 注文者性別ID
order_sex_name 注文者性別名 ※マスタ設定より出力されます
order_birth 注文者生年月日
order_job 注文者職業ID
order_job 注文者職業名 ※マスタ設定より出力されます
subtotal 商品代金合計（税込）
discount 調整額 +、-あり
※楽楽B2B、かつ、顧客ランク機能ありの場合、調整額－ランク割引－リピート割引
discount_memo 調整額内容
discount1 ランク割引 ※楽楽B2B、かつ、顧客ランク機能ありの場合
discount2 リピート割引 ※楽楽B2B、かつ、リピート割引機能ありの場合
total 合計 商品代金合計（税込）＋調整額＋送料（税込）＋手数料（税込）
deliv_fee 送料（税込）
charge 手数料（税込）
coupon_code クーポンコード
coupon_name クーポン名
coupon_name クーポン割引額
coupon_name ポイント利用
payment_total 請求額 合計－クーポン割引額－ポイント利用
payment_total 税額 商品代金合計の税額
add_point 加算ポイント
payment_amount_total 入金額合計
deliv_fee_cost 配送コスト
ec_type ECタイプ 1:楽天、2:Yahoo、3:EC-CUBE、4:ポンパレ、5:Amazon、6:DeNA、7:ショップサーブ、8:FutrueShop、9:たまごリピート（未対応）、10:MakeShop、11:ラインモール（未使用）、12:Qoo10、13:カラーミー、14:ヤフオク(未対応)、15:スマイルツールズ、16:楽楽リピート、17:AmazonFBA、18:EC Challenge
ec_type_name ECタイプ名称
ec_order_id 受注番号
ec_order_id 受注番号枝番
ec_shop_id 店舗ID 楽楽B2Bでは、1000固定
ec_shop_name 店舗名
order_root 注文ルート 1:ネット注文、2:電話注文、3:ＦＡＸ注文
order_root_name 注文ルート名
order_cnt 注文回数
order_status 受注ステータス
order_status_name 受注ステータス名 ※マスタ設定より出力されます
order_cancel_reason キャンセル理由ID
order_cancel_reason_name キャンセル理由名 ※マスタ設定より出力されます
order_status2 受注分類ID
order_status2_name 受注分類名 ※マスタ設定より出力されます
payment_id 支払方法ID
payment_method 支払方法名
payment_status 支払ステータス 0：未処理、1:OK、2:NG
deliv_id 配送方法ID
deliv_method 配送方法名
reserve_type 注文種類 0:通常、3:定期、4:予約、5:頒布会、9:資料請求
reserve_type_name 注文種類名
reserve_type_name 申込番号
plg_raku2_order_date 受注日時
plg_raku2_payment_limit_date 支払期日
payment_date 入金日
hasso_date 出荷予定日
commit_date 出荷日
customer_charge_deliv 出荷担当者
customer_charge カスタマー担当者
note_attention 伝達事項
note ひとことメモ
gift_flag ギフトフラグ
noshi_text のし種類
noshi_name のし名入れ
device_type_id 端末種別 1:ガラケー、2:スマートフォン、3:タブレット、10:PC、90：不明
device_type_name 端末種別名
mark1 マーク１ 0:なし、1:あり
mark2 マーク２ 0:なし、1:あり
mark3 マーク３ 0:なし、1:あり
order_print_type 出力帳票（受注伝票出力フラグ） 0：なし、1:あり
letter_print_type 出力帳票（お手紙出力フラグ） 0：なし、1:あり
nouhin_print_type 出力帳票（納品書出力フラグ） 0：なし、1:あり
ryoshu_print_type 出力帳票（領収書出力フラグ） 0：なし、1:あり、2:あり（兼納品書）
ryoshu_print_name 出力帳票（領収書宛名）
ryoshu_print_biko 出力帳票（領収書備考）
ryoshu_print_type 出力帳票（請求書出力フラグ） 0：なし、1:あり
seikyu_print_biko 出力帳票（請求書備考）
ems_print_type 出力帳票（EMS出力フラグ） 0：なし、1:あり
invoice_print_type 送り状出力フラグ 0：なし、1:あり
order_print_type 帳票出力日時（受注伝票）
letter_print_type 帳票出力日時（お手紙）
nouhin_print_type 帳票出力日時（納品書）
ryoshu_print_type 帳票出力日時（領収書）
ryoshu_print_type 帳票出力日時（請求書）
ems_print_type 帳票出力日時（EMS）
invoice_print_type 送り状出力日時
atobarai_totihiki_csv_date 後払い取引登録出力日時
atobarai_shipping_csv_date 後払い出荷登録出力日時
cart_syuka_update_date モール連携出荷登録日時
cart_commit_update_date モール連携処理済み日時
thanks_mail_flag サンクスメール送信フラグ 0:未送信,1;送信済み
shipping_mail_flag 発送完了メール送信フラグ 0:未送信,1;送信済み
payment_mail_flag 入金確認メール送信フラグ 0:未送信,1;送信済み
follow_mail_flag フォローメール送信フラグ 0:未送信,1;送信済み
other1_mail_flag その他メール送信フラグ 0:未送信,1;送信済み
other2_mail_flag その他メール送信フラグ 0:未送信,1;送信済み
letter_id お手紙ID
letter_name お手紙名 ※マスタ設定より出力されます
letter_message お手紙差込メッセージ
nouhin_print_messge 納品書差込メッセージ
thanks_mail_message サンクスメール差込メッセージ
shipping_mail_message 発送完了メール差込メッセージ
payment_mail_message 入金確認メール差込メッセージ
follow_mail_message フォロー確認メール差込メッセージ
other1_mail_message その他１確認メール差込メッセージ
group_order_id 同梱ID
group_order_type 0:同梱なし、1:同梱親、2:同梱子
split_ec_order_id 分割元受注ID
split_payment_flg 分割後請求先フラグ 1:請求先
rids_sub_id 楽天ID決済申込番号 ※楽天ID決済利用時
rids_cart_id 楽天ID決済カートID ※楽天ID決済利用時
rids_order_id 楽天ID決済注文番号 ※楽天ID決済利用時
rids_control_id 楽天ID決済-注文管理番号 ※楽天ID決済利用時
rids_payment_status 楽天ID決済-決済ステータス ※楽天ID決済利用時
rids_amount 楽天ID決済-決済金額 ※楽天ID決済利用時
rids_use_point 楽天ID決済-使用スーパーポイント ※楽天ID決済利用時
rids_request_id 楽天ID決済-リクエストID ※楽天ID決済利用時
rids_processing 楽天ID決済-処理依頼中フラグ ※楽天ID決済利用時
rids_error_code 楽天ID決済-注文エラーコード ※楽天ID決済利用時
amzn_seller_billing_id Amazon決済出品者支払契約ID ※Amazonログイン＆ペイメント決済利用時
amzn_auth_reference_id オーソリリファレンスID ※Amazonログイン＆ペイメント決済利用時
amzn_order_reference_id オーダーリファレンスID ※Amazonログイン＆ペイメント決済利用時
amzn_order_status オーダーステータス ※Amazonログイン＆ペイメント決済利用時
amzn_auth_id オーソリID ※Amazonログイン＆ペイメント決済利用時
amzn_auth_status オーソリステータス ※Amazonログイン＆ペイメント決済利用時
amzn_capture_id キャプチャーID ※Amazonログイン＆ペイメント決済利用時
amzn_capture_status キャプチャーステータス ※Amazonログイン＆ペイメント決済利用時
amzn_refund_id 返金処理ID ※Amazonログイン＆ペイメント決済利用時
amzn_refund_status 返金処理ステータス ※Amazonログイン＆ペイメント決済利用時
plg_raku2_amzn_amount 決済額 ※Amazonログイン＆ペイメント決済利用時
plg_raku2_amzn_error エラー内容 ※Amazonログイン＆ペイメント決済利用時

同梱情報

項目名 項目内容 説明
group_order_id 同梱ＩＤ
group_subtotal 同梱後商品代金合計（税込）
group_discount 同梱後調整額
group_deliv_fee 同梱後送料
group_charge 同梱後手数料
group_use_point 同梱後利用ポイント
group_coupon_total 同梱後クーポン割引額
group_payment_total 同梱後請求額
group_tax 同梱後税額
group_payment_amount_total 同梱後入金額
group_deliv_fee_cost 同梱後配送コスト

お届け先情報

項目名 項目内容 説明
serial_shipping_id お届け先ＩＤ
shipping_name01 お届け先お名前（姓）
shipping_name02 お届け先お名前（名）
shipping_kana01 お届け先お名前カナ（姓）
shipping_kana02 お届け先お名前カナ（名）
shipping_company_name お届け先会社名
shipping_tel お届け先電話番号 -なし
shipping_fax お届け先FAX番号 -なし
shipping_country お届け先国 日本
shipping_zip お届け先郵便番号 999-9999
shipping_pref お届け先都道府県
shipping_addr01 お届け先住所１
shipping_addr02 お届け先住所２
hasso_denpyo_code お届け先伝票番号
hasso_eigyo_flg 営業所止めフラグ 1:営業所
hasso_eigyo_code 営業所コード
hasso_chaku_flg 着払いフラグ 1:着払い
hasso_memo 送り状記事欄
hasso_koguchi 個口
shipping_keisho_name お届け先敬称
shipping_date お届け日
shipping_time お届け時間帯
plg_raku2_hasso_deliv_kbn 配送方法(便種)
plg_raku2_hasso_deliv_kbn 配送方法(便種)
hasso_deliv_kbn 配送方法名(便種) ※マスタ設定より出力されます
hasso_trans_id 配送業者ID
hasso_trans_name 配送業者名 ※マスタ設定より出力されます

商品明細情報

項目名 項目内容 説明
serial_order_detail_id 商品明細ＩＤ
order_detail_kbn 明細種別名 通常商品、ラッピング1、ラッピング2、サンプル、プレゼント、チラシ
order_product_code 注文時商品番号
product_code 変換後商品番号
product_class_id 注文時商品規格ID
product_name 商品名
product_option_name 項目・選択肢
product_noshi_select のし種類（明細単位）
product_noshi_name のし名（明細単位）
product_tax_kbn 税フラグ 0:別、1:込
product_postage_kbn 送料 0:別、1:込
product_daibiki_kbn 手数料 0:別、1:込
product_price_notax 単価（税別）
product_price 単価 税フラグに関連した価格
product_tax 税額
product_tax_rate 税率
product_quantity 購入数量
product_total 購入金額 product_price × product_quantity
product_add_point 付与ポイント
product_point_rate_power ポイント変倍
plg_raku2_stock_price 原価
product_weight 重量
product_reg_flag 商品区分 商品、定期
product_url 商品詳細URL
product_jan_cd ご購入明細JANコード
b2b_trade_rate ご購入明細掛け率