開発者向けサポート

受注関連

受注情報を編集したり、検索することができます。

リソース一覧

リソースURI 説明
受注ヘッダ一覧
受注ヘッダ
受注明細一覧
受注明細
受注配送先一覧
受注配送先
受注明細一覧
受注CSV処理
受注No一覧
仮受注一覧

リソース属性

このリソースが持つ属性を以下に示します。本リソースについてのAPIを実行すると、以下の属性を取得、変更することができます。

カラム名必須Byte型概要
ORDER_NO〇8半角数値受注番号です。受注データを一意にする識別子です。
PC_MOBILE_KBN〇1半角数値購入時の端末区分です。1:PC
ORDER_DISP_NO〇30半角文字列受注表示番号です。受注を一意にします。表示用として使用します。
ORDER_DATE日付受注日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
USER_AGENT〇512半角文字列端末機種情報です。
KESSAI_ID〇3半角数値支払方法を示すIDです。
HAISO_ID4半角数値配送方法を示すIDです。
SEIKYU〇12半角数値請求金額合計です。請求金額合計＝内訳（商品定価）＋内訳（消費税）＋内訳（送料）＋内訳（代引手数料） -内訳（ポイント使用額）
TAX12半角数値消費税です。
TEIKA_SUM〇12半角数値商品定価です。
TEIKA_SUM_TAX12半角数値商品定価消費税です。
SHIRE_SUM12半角数値仕入金額合計です。
SORYO8半角数値送料です。
SORYO_TAX12半角数値送料の消費税です。
DAIBIKI8半角数値代引手数料です。
DAIBIKI_TAX12半角数値代引手数料の消費税です。
MEMBER_WARIBIKI_SUM12半角数値会員割引額です。
POINT_WARIBIKI8半角数値ポイント使用額です。
COUPON_WARIBIKI〇12半角数値クーポン使用額です。
TAX_RATE7半角数値税率です。整数部分が5桁、少数部分が2桁、合計7桁まで指定できます。
PAYMENT_DATE日付入金日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
CANCEL_DATE日付受注取消日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
AUTHORIZATION_FIXED_DATE日付オーソリ確定日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
AUTHORY_STATUS1半角数値クレジット処理結果ステータスです。
AUTHORY_DATE日付オーソリ日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
ATOBARAI_STATUS200全角文字列後払いステータスです。
DEL_DATE日付削除日です。削除時に設定します。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
SEND_DATE日付配送日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
SEND_HOPE_DATE日付配送希望日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
NEXT_SEND_HOPE_DATE日付次回配送予定日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
IS_TEIKI_HEADER_FLG1半角数値1:定期親受注を示します。
TEIKI_HEADER_ORDER_NO8半角数値定期受注の場合、その受注データの元となった定期ヘッダ受注番号を示します。
YOYAKU_STATUS半角数値null:本受注、1:予約受注を示します。
YOYAKU_DATE日付予約日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
COUPON_ID8半角数値利用クーポンIDです。
BIKO2000全角文字列備考です。
MEMBER_ID8半角数値注文を行った会員IDです。
L_NAME〇30全角文字列注文者の姓です。
F_NAME〇30全角文字列注文者の名です。
L_KANA30全角文字列注文者の姓（カナ）です。
F_KANA30全角文字列注文者の名（カナ）です。
ZIP15半角文字列注文者の郵便番号です。
ADDR1100全角文字列注文者の住所１(都道府県)です。
ADDR2200全角文字列注文者の住所２(市区町村、番地)です。
ADDR3200全角文字列注文者の住所３(ビル、マンション名等)です。
TEL30半角文字列注文者の電話番号です。
PC_MAIL200半角文字列注文者のPCメールアドレスです。
MOBILE_MAIL200半角文字列注文者の携帯メールアドレスです。
SEND_L_NAME30全角文字列送付先の姓です。
SEND_F_NAME30全角文字列送付先の名です。
SEND_L_KANA30全角文字列送付先の姓（カナ）です。
SEND_F_KANA30全角文字列送付先の名（カナ）です。
SEND_ZIP15半角文字列送付先の郵便番号です。
SEND_ADDR1100全角文字列送付先の住所１(都道府県)です。
SEND_ADDR2200全角文字列送付先の住所２(市区町村、番地)です。
SEND_ADDR3200全角文字列送付先の住所３(ビル、マンション名等)です。
SEND_TEL30半角文字列送付先の電話番号です。
SEND_MAIL200半角文字列配送先のPCメールアドレスです。
POINT_USE8半角数値注文時に使用したポイント数です。
ADD_POINT_SUM13半角数値注文によって付与されるポイント数です。入金後に付与されます。
PAYMENT_STATUS200全角文字列受注決済ステータスです。
VERI_TORIHIKI_ID100半角文字列決済取引の結果割り振られる一意な情報です。売上確定処理等一連の処理で使用します。
SAVED_CARD_DUMMY_ORDER_FLG1半角数値カード番号登録受注フラグです。1の場合は通常の受注ではなく、決済用のデータを保持するダミーの受注となります。
SAVED_CARD_VERI_TORIHIKI_ID100半角文字列クレジットカードを保存した時に発番される取引IDです。注文時に同時に新たなカードを登録したときと、登録済みのカード情報で決済したときに設定されます。
SYOUKAI_NO20半角文字列決済取引の結果割り振られる一意な情報です。一部の決済方法によっては30桁まで許容しています。
ADMIN_UPDATE_USER_ID8半角数値管理ツールでの更新者のユーザIDです。
ORDER_MAIL_DATE日付受注確認メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
SEND_MAIL_DATE日付配送確認メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
CANCEL_MAIL_DATE日付取消メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
YOYAKU_MAIL_DATE日付予約確定メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
DOWNLOAD_DATE日付ダウンロード日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
PAYMENT_MONEY14半角数値入金額です。整数部分が12桁、少数部分が2桁、合計14桁まで指定できます。
CREDIT_LIMIT7半角文字列有効期限です。
CREDIT_COUNT2半角数値分割回数です。
CREDIT_KIND20半角文字列カード種別です。
PAY_LIMIT日付払込期限です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
RECEIPT_NO32半角文字列受付番号です。
HARAIKOMI_URL300半角文字列払込票URLです。
TEIKI_ORDER_DATE日付定期販売受注処理日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
TEIKI_SEND_HOPE_MONTHLY_DAY2半角数値定期販売毎月配送希望日です。
TEIKI_SEND_SPAN8半角数値定期販売発送スパンです。
TEIKI_YM6半角数値定期販売対象年月です。
TEIKI_KBN1半角数値定期販売区分です。
TEIKI_STOP_DATE日付定期販売停止日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_DATE1日付受注自由区分１です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_DATE2日付受注自由区分２です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_DATE3日付受注自由区分３です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_DATE4日付受注自由区分４です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_DATE5日付受注自由区分５です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_MAIL_DATE1日付受注自由区分1メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_MAIL_DATE2日付受注自由区分2メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_MAIL_DATE3日付受注自由区分3メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_MAIL_DATE4日付受注自由区分4メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_MAIL_DATE5日付受注自由区分5メール配信日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
SEISAN_PAGE_ID1000半角文字列精算ページIDです。
ORDER_H_ACCESS_BROWSER_KBN100半角文字列受注アクセスブラウザ区分です。
KESSAI_ORDER_ID8半角数値決済連携IDです。
ESCOTTPLUS_AUTHORY_ID8半角数値ソニーペイメントサービス（e-SCOTT） オーソリIDです。
GMOPS_SHIPPING_COMPANY_ID8半角数値運送会社ID（GMOPS後払い用）です。
AUTO_ALERT_ICON_LIST2000半角文字列自動お知らせアイコンです。形式は「自動お知らせID_アイコンファイル名」で複数ある場合はカンマ区切りでセットされています。
ORDER_API_STATUS1半角数値受注API連携ステータスです。1:連携済み, 2:連携エラー を示します。
MEDIA_CD20半角文字列広告媒体コードです。
ACCESS_URL2000半角文字列アクセスURLです。
SALES_CAMPAIGN_WARIBIKI12半角数値キャンペーン割引額です。
SALES_CAMPAIGN_ADD_POINT8半角数値キャンペーン付与ポイントです。
SEIKYU112半角数値内訳（請求金額合計：標準税率対象）です。
SEIKYU212半角数値内訳（請求金額合計：軽減税率対象です。
TAX112半角数値内訳（消費税額：標準税率対象）です。
TAX212半角数値内訳（消費税額：軽減税率対象）です。
COUPON_RATE_WARIBIKI_DIVISION112半角数値内訳（クーポン割引額：標準税率対象）<率>です。
COUPON_AMOUNT_WARIBIKI_DIVISION112半角数値内訳（クーポン割引額：標準税率対象）<額>です。
COUPON_RATE_WARIBIKI_DIVISION212半角数値内訳（クーポン割引額：軽減税率対象）<率>です。
COUPON_AMOUNT_WARIBIKI_DIVISION212半角数値内訳（クーポン割引額：軽減税率対象）<額>です。
POINT_WARIBIKI_DIVISION18半角数値内訳（ポイント使用額：標準税率対象）です。
POINT_WARIBIKI_DIVISION28半角数値内訳（ポイント使用額：軽減税率対象）です。
BUNDLE_SALE_WARIBIKI_DIVISION112半角数値内訳（まとめ買い割引額：標準税率対象）です。
BUNDLE_SALE_WARIBIKI_DIVISION212半角数値内訳（まとめ買い割引額：軽減税率対象）です。
SALES_CAMPAIGN_WARIBIKI_DIVISION112半角数値内訳（キャンペーン割引：標準税率対象）です。
SALES_CAMPAIGN_WARIBIKI_DIVISION212半角数値内訳（キャンペーン割引：軽減税率対象）です。
TAX_RATE17半角数値内訳（消費税率：標準税率対象）です。整数部分が5桁、少数部分が2桁、合計7桁まで指定できます。
TAX_RATE27半角数値内訳（消費税率：軽減税率対象）です。整数部分が5桁、少数部分が2桁、合計7桁まで指定できます。
SAVED_CARD_DUMMY_ORDER_MASKED_NO20半角文字列マスクされたカード番号です。
CREDIT_NAME60全角文字列カード名義です。
SEND_YOTEI_DATE日付出荷予定日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
CONTINUOUS_INVALID_FLG1半角数値有効性エラーフラグです。
KESSAI_RESULT_MESSAGE_PC_MAIL60000全角文字列決済結果文言メールPCです。
ORDER_STEPMAIL_FLG1半角数値この注文の商品に関する情報を受信するフラグです。1:ステップメールを受信する, null:受信しない
ATOBARAI_ORDER_ID100半角文字列後払い注文IDです。
ESTIMATE_ORDER_FLG1半角数値見積フラグです。
ESTIMATE_NO8半角数値見積番号です。
ESTIMATE_DATE日付見積作成日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
ESTIMATE_LIMIT_DATE日付見積有効期限です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
ESTIMATE_COMMENT2000全角文字列見積コメントです。
ESTIMATE_REPLY_COMMENT2000全角文字列見積回答コメントです。
ESTIMATE_REPLY_DATE日付見積回答日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
ESTIMATE_KESSAI_ID3半角数値見積時決済IDです。
KESSAI_KEY_DATA12000全角文字列決済キー項目1です。
KESSAI_KEY_DATA22000全角文字列決済キー項目2です。
KESSAI_DATA12000全角文字列決済項目1です。
KESSAI_DATA22000全角文字列決済項目2です。
REGIST_USER_ID8半角数値データ登録者です。
UPDATE_USER_ID8半角数値データ更新者です。
REGIST_DATE日付データの登録日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
UPDATE_DATE日付データが最後に更新された日です。「YYYY/MM/DD」もしくは「YYYY/MM/DD HH:MM」の形で指定してください。
FREE_ITEM1～100--------自由項目です。店舗によって用途は異なります。使用可能設定になっている自由項目のみにアクセスできます。
order_details--------受注に紐づく明細のオブジェクトです。配列の形式になります。詳細はこちらを参照してください。
send_data--------受注に紐づく受注配送先のオブジェクトです。配列の形式になります。詳細はこちらを参照してください。
metadata--------受注ヘッダに紐づくメタデータのオブジェクトです。Appsで独自定義したキー、バリューを保持することができます。取得時にはリクエストしたAppsが登録したメタデータが本パラメータの対象です。
メタデータはPUT /orders/{id}にて登録・更新できます。
一度に指定可能なメタデータ数は20となっております。20を超えた場合、登録・更新を行わずエラーを返します。
metadataに多量のデータを登録した場合、店舗の運用費の負担が増えることにつながりますので、不要なデータの登録が行われないようにお願いします。