受注取得API

指定した受注情報の取得を行います。

まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。

基本機能

受注検索APIでは取得できない「ポイントステータス」や「クーポン割引額」、「ショップメモ」「通信欄」など、受注ごとの詳細データが取得できます。
受注番号を指定し、受注ごとに取得します。

＜目次＞

更新/更新予定

※日付が「予定日」のものは、更新内容が変わる可能性がございます。

更新日/予定日	更新内容		更新理由
2024.06.05	レスポンス	「paymentType」に「RAKUTEN_PAY_V2 ：楽天ペイ（オンライン決済）V2（SBPS）」を追加	楽天ペイ（オンライン決済）V2（SBPS）追加のため	参照
2024.06.05	レスポンス	お届け先情報リスト(shipmentList)＞productList内に以下を追加・weight（梱包重量）・packingGroupName（同梱可能グループ）	配送・送料（upgrade版）の新機能提供のため	参照

更新履歴はAPI更新履歴一覧をご覧ください。

URL

URLにorderNoを指定してリクエストを行って下さい。

https://{APIドメイン}/admin-api/v1/orders/{orderNo}

HTTPメソッド

GET

リクエストヘッダー

アクセストークンなどの詳細はアクセストークンによる認証を参照してください。

リクエストボディ

なし

パラメータ

なし

レスポンス

※「必須（〇）」項目にデータがない場合は空欄が出力されます。

2024.01.24リリースの配送・送料（upgrade版）に伴い、一部項目が追加、また出力内容が変更となっています。

「KEY」名に（★）が付記されている項目が、変更・追加対象です。

なお、以下の受注（表中では（◆）と表記）に該当するか否かにより、出力内容が異なる項目がございますので、「内容」欄の注釈にご注意ください。

「配送・送料機能（upgrade版）」切替え（アップグレード完了）後の受注
「配送・送料機能（upgrade版）」切替え（アップグレード完了）後、配送関連のデータを修正した、アップグレード前の受注
2024.01.24以降futureshop新規発行店舗様の受注

key				項目名	必須	型	byte	内容
orderNo				受注番号	◯	String	12
date				注文日時	◯	String	19	「yyyy-mm-ddThh:mm:ss」形式
grandTotal				請求合計金額	◯	Number	9	総合計金額 - ポイント利用額 - 値引合計金額（商品）- 値引合計金額（送料） - 割引額 - バンドル販売割引金額
totalCost				総合計金額	◯	Number	9	値引き前の金額（商品合計金額　＋　包装手数料　＋　送料　＋　決済手数料　＋　クール便手数料）
productTotal				商品合計金額	◯	Number	9	税込み商品本体　＋　オプション価格
taxTotal				消費税合計	◯	Number	9	内税設定している場合は、「0」と出力（消費税のみの金額データは取得できません）商品・オプション価格の税額（手数料・送料の消費税は除く）
giftWrappingChargeTotal				包装手数料	◯	Number	9
postage				送料	◯	Number	9
paymentChargeTotal				決済手数料	◯	Number	9
coolDeliveryChargeTotal				クール便手数料	◯	Number	9
paymentType				決済方法	◯	String	37	BANK_TRANSFER：銀行振込 COD：代金引換 POSTAL_TRANSFER：郵便振込 FREGI_CONVENI：コンビニ支払（F-REGI） FREGI_CREDIT_CARD：クレジットカード（F-REGI） IN_STORE：店頭払い RAKUTEN_BANK：楽天銀行（リアルタイム自動引落） ORICO_WEB_CREDIT：オリコWebクレジット NONE：決済不要 NP_POSTPAY：NP後払い（CSV） AMAZON_PAY：Amazon Pay RAKUTEN_PAY：楽天ペイ（オンライン決済） APPLE_PAY：Apple Pay（F-REGI） CUSTOM1：任意決済 CUSTOM2：任意決済２ CUSTOM3：任意決済３ SBPS_CREDIT_CARD：クレジットカード（SBPS） PAYPAY：PayPay（SBPS） DOCOMO：d払い（SBPS） SOFTBANK：キャリア決済　ソフトバンクまとめて支払い（SBPS） AU：キャリア決済　auかんたん決済（SBPS） SBPS_CONVENI：コンビニ支払（SBPS） NP_POSTPAY_RTA：NP後払い（即時与信） PAIDY：あと払い（ペイディ） AU_PAY ：au PAY（ネット支払い）（SBPS） RAKUTEN_PAY_V2：楽天ペイ（オンライン決済）V2（SBPS） ------------------------------------------------------ ※2023.10.03廃止：MOBILE_EDY：MobileEdy（F-REGI）/CYBER_EDY：CyberEdy（F-REGI）
conveniType				コンビニ区分	◯	String	12	SEVEN_ELEVEN：セブンイレブン LAWSON：ローソン FAMILY_MART：ファミリーマート SEICO_MART：セイコーマート MINISTOP：ミニストップ
conveniPayoutNo				コンビニ支払番号	◯	String	32
deviceType				購入経路区分	◯	String	11	PC MOBILE SMART_PHONE
communication				通信欄	◯	String	2000
customerContact				お客様へのご連絡事項	◯	String	2000
shopMemo				ショップメモ	◯	String	2000
status				処理状況区分	◯	String	16	AWAITING_PAYMENT：通常処理 CANCELLED：注文取消 REFUNDED：返品 AWAITING_SHIPMENT：未回収 COMPLETED：処理済 ON_HOLD：保留 PREORDER：予約
cancelDate				キャンセル日時	○	String	19	「yyyy-mm-ddThh:mm:ss」形式
cancelRequestDate				キャンセルリクエスト日時	○	String	19	「yyyy-mm-ddThh:mm:ss」形式
cancelRequestRevoked				キャンセルリクエスト取消	○	Boolean	-	true：キャンセルリクエスト取消 false：上記以外
paymentStatus				決済ステータス	◯	String	11	RECEIVED：入金済 NOTRECEIVED：未入金
receiptDate				入金確認日	◯	String	10	「yyyy-mm-dd」形式
receiptShopName				支払い店舗	○	String	200	決済方法がIN_STORE：店頭払いの場合に出力
orderEmailDateSent				メール送信日（注文確認）	◯	String	19	「yyyy-mm-ddThh:mm:ss」形式
paymentEmailNumSent				メール送信回数（入金確認）	◯	Number	5
paymentEmailDateSent				メール送信日（入金確認）	◯	String	19	「yyyy-mm-ddThh:mm:ss」形式
oricoProcedureDate				オリコWebクレジット手続き日	◯	String	10	「yyyy-mm-dd」形式
multipleShipments				複数お届け先フラグ	◯	Boolean	-	true：複数お届け先 false：1お届け先
usedPointPrice				ポイント利用額	◯	Nunber	9
earnedPointStatus				ポイントステータス	◯	String	8	UNDEFINED：未設定 INVALID：無効 SUSPENDED：保留 EXPIRED：期限切れ USED：利用済 VALID：有効 PENDING：有効待ち
dateLastUpdated				最終更新日	◯	String	19	「yyyy-mm-ddThh:mm:ss」形式
fregiOrderNo				F-REGI取引番号	◯	Strinng	32
fregiAuthNo				F-REGI承認番号	◯	Strinng	32
thanksEmailNumSent				メール送信回数（サンクス）	◯	Number	9
thanksEmailDateSent				メール送信日（サンクス）	◯	String	19	「yyyy-mm-ddThh:mm:ss」形式
type				受注種別	◯	String	12	REGULAR：通常受注 SUBSCRIPTION：定期受注 HANPUKAI：頒布会受注 PREORDER：予約受注
productCouponDiscountName				割引名（商品）	◯	String	300	クーポン名
productCouponDiscountTotal				割引合計金額（商品）	◯	Number	9	クーポン割引額
postageCouponDiscountName				割引名（送料）	◯	String	300	クーポン名
postageCouponDiscountTotal				割引合計金額（送料）	◯	Number	9	クーポン割引額
couponName				利用クーポン	◯	Text	-
couponList				利用クーポンリスト	◯	Array	-
	id			クーポンID		String	15
	name			クーポン名		String	300
volumeDiscountName				割引名	◯	String	50
volumeDiscountTotal				割引合計金額	◯	Number	9	設定＞割引＞購入金額別割引設定／【CC未利用・移行中】構築＞送料・決済設定＞割引設定による割引合計金額ポイント、クーポンやバンドル値引き額は含まれません。
blackOrder				ブラック警告	◯	Boolean	-	true：ブラック false：非ブラック
dateProcessed				注文処理日	◯	String	19	「yyyy-mm-ddThh:mm:ss」形式
bundleDiscountCaption				バンドル販売割引金額キャプション	◯	String	50
bundleDiscountTotal				バンドル販売割引金額	◯	Number	9
bundleUrls				適用バンドル販売URL情報	◯	String	32
bundleNames				適用バンドル販売名情報	◯	String	300
amazonOrderReferenceId				AmazonリファレンスID	◯	Text	-	※定期・頒布会受注の場合は「空文字」を出力
rakutenPayOrderId				楽天ペイ（オンライン決済）番号	◯	String	64
subscriptionNo				申込コード	◯	String	12
subscriptionPeriodNo				受注確定回（定期・頒布会）	◯	Number	9
subscriptionTotalNumPeriods				処理済み受注回数（定期・頒布会	◯	Number	9
taxConfigEnabled				消費税加算フラグ	◯	Boolean	-	true：税込 false：税別
taxRoundingType				消費税端数計算区分	◯	String	13	ROUND_DOWN：切り捨て ROUND_HALF_UP：四捨五入 ROUND_UP：切り上げ
standardTaxRate				標準税率	◯	Number	2
reducedTaxRate				軽減税率	◯	Number	2
rateDiscountTargetPriceStdTaxIncl				[按分値引き]対象金額（標準税率）	◯	Number	9
rateDiscountTargetPriceReducedTaxIncl				[按分値引き]対象金額（軽減税率）	◯	Number	9
rateDiscountTargetPriceStdTax				[按分値引き]内消費税等（標準税率）	◯	Number	9
rateDiscountTargetPriceReducedTax				[按分値引き]内消費税等（軽減税率）	◯	Number	9
priorityDiscountTargetPriceStdTaxIncl				[標準税率優先値引き]対象金額（標準税率）	◯	Number	9
priorityDiscountTargetPriceReducedTaxIncl				[標準税率優先値引き]対象金額（軽減税率）	◯	Number	9
priorityDiscountTargetPriceStdTax				[標準税率優先値引き]内消費税等（標準税率）	◯	Number	9
priorityDiscountTargetPriceReducedTax				[標準税率優先値引き]内消費税等（軽減税率）	◯	Number	9
sbpsTrackingId				SBPS処理トラッキングID	◯	String	14	SBPS利用店舗のみ
sbpsFraudScoringId				SBPS不正スコアリングID	◯	String	36	SBPS利用店舗のみ AI不正検知対象のクレジッカードを利用した受注について、SBPSに問合せをする際に必要なID「不正スコアリングID」を出力 ------------------------------------------------------ ※詳しくはAI不正検知についてをご覧ください。
sbpsAlert				SBPSアラート	◯	String	4	SBPS利用店舗のみ WARN：警告 ------------------------------------------------------ ※詳しくはAI不正検知についてをご覧ください。
npTransactionId				NP後払い取引ID	◯	String	12	NP後払い（即時与信）で決済された場合に、NP取引IDを出力
paidyPaymentId				PaidyペイメントID	◯	String	20	あと払い（ペイディ）で決済された場合に、Payment IDを出力
usingUpgradedPostage（★）				配送・送料（upgrade版）使用フラグ	○	Boolean	-	true：配送・送料（upgrade版）を使用（切替え済み） false：配送・送料（upgrade版）を不使用 ------------------------------------------------------ ※「配送・送料機能（upgrade版）」とは？
buyerInfo				購入者情報	◯	-	-
	memberId			会員ID	◯	String	20	ゲストの場合は空欄
	lastName			氏名（姓）	◯	String	200
	firstName			氏名（名）	◯	String	200
	lastNameKana			フリガナ（姓）	◯	String	200
	firstNameKana			フリガナ（名）	◯	String	200
	mail			メールアドレス（メイン）	◯	String	200
	mobileMail			メールアドレス（モバイル）	◯	String	200
	zipCode			郵便番号	◯	String	7	3桁 -(半角) 4桁
	prefecture			都道府県区分	◯	String
	address1			住所1	◯	String	200
	address2			住所2	◯	String	200
	address3			住所3	◯	String	200
	telNoMain			電話番号（メイン）	◯	String	13
	telNoAlternate			電話番号（サブ）	◯	String	13
	faxNo			FAX番号	◯	String	13
	gender			性別区分	◯	String	11	UNSPECIFIED：指定なし MALE：男性 FEMALE：女性
	birthday			生年月日	◯	String	8	「yyyy-mm-dd」形式
	nickName			ニックネーム	◯	String	50
	companyName			会社名	◯	String	200
	companyNameKana			会社名（フリガナ）	◯	String	200
	departmentName			部署名	◯	String	200
	departmentNameKana			部署名（フリガナ）	◯	String	200
	companyTelNo			電話番号（会社）	◯	String	13
	companyFaxNo			電話番号（FAX）	◯	String	13
	orderCount			購入回数	◯	Number	9
	totalOrderCount			全購入回数	◯	Number	9
	memberStageName			会員ステージ名	◯	String	60
	additionalItem1			追加属性項目１	◯	Text	-
	additionalItem2			追加属性項目２	◯	Text	-
	additionalItem3			追加属性項目３	◯	Text	-
	additionalItem4			追加属性項目４	◯	Text	-
	additionalItem5			追加属性項目５	◯	Text	-
	additionalItem6			追加属性項目６	◯	Text	-
	additionalItem7			追加属性項目７	◯	Text	-
	additionalItem8			追加属性項目８	◯	Text	-
	additionalItem9			追加属性項目９	◯	Text	-
	additionalItem10			追加属性項目１０	◯	Text	-
	additionalItem11			追加属性項目１１	◯	Text	-
	additionalItem12			追加属性項目１２	◯	Text	-
	additionalItem13			追加属性項目１３	◯	Text	-
	additionalItem14			追加属性項目１４	◯	Text	-
	additionalItem15			追加属性項目１５	◯	Text	-
	additionalItem16			追加属性項目１６	◯	Text	-
	additionalItem17			追加属性項目１７	◯	Text	-
	additionalItem18			追加属性項目１８	◯	Text	-
	additionalItem19			追加属性項目１９	◯	Text	-
	additionalItem20			追加属性項目２０	◯	Text	-
shipmentList（★）				お届け先情報	◯	Array	-	お届け先ごとに配列出力 ------------------------------------------------------ 一部項目は、配送・送料（upgrade版）ご利用状況により出力が異なります。
	shipmentNo			お届け先別明細番号	◯	Number	3
	giftWrappingLabel			包装名	◯	String
	productTotal			お届け先別商品合計	◯	Number	9	税込みオプション価格を含む
	taxTotal			お届け先別消費税	◯	Number	9	商品・オプション価格の税額（手数料・送料の消費税は除く）
	postage			お届け先別基本送料	◯	Number	9
	coolDeliveryCharge			お届け先別クール便手数料	◯	Number	9
	giftWrappingCharge			お届け先別包装手数料	◯	Number	9
	paymentCharge			お届け先別決済手数料	◯	Number	9
	contactLater			お店から後ほど連絡	◯	Boolean	-	true：連絡する false：連絡しない
	invoiceNo			送り状番号	◯	String	100
	expectedArrival			着予定	◯	String	10
	preferredDeliveryDate			お届け希望日	◯	String	10	「yyyy-mm-dd」形式
	preferredDeliveryTime			お届け希望時間	◯	String	50
	instructions			詳細指定事項欄	◯	text	-
	shipped			発送フラグ	◯	Boolean	-	true：発送済 false：未発送
	shippingDate			発送日	◯	String	10	「yyyy-mm-dd」形式
	isCoolDelivery（★）			クール便使用フラグ	◯	Boolean	-	true：クール便 false：非クール便 ------------------------------------------------------ （◆）に該当する受注は「false」
	deliveryServiceName（★）			配送サービス名	◯	String	100	（◆）に該当する受注は「空文字」
	deliveryService（★）			配送サービス区分	◯	String	25	COURIER：宅配便 KURONEKO_MAIL_BIN：クロネコメール便 KURONEKO_MAIL_BIN_EXPRESS：クロネコメール便速達サービス（廃止済） HIKYAKU_MAIL_EXPRESS：飛脚メール便 MAIL_1：メール便サービス１ MAIL_2：メール便サービス２ MAIL_3：メール便サービス３ NEKOPOS：ネコポス STORE_PICKUP：店舗受取 ------------------------------------------------------ （◆）に該当する受注は「空文字」
	deliveryServiceInfo（★）			配送サービス情報	-	Boolean	-	本項目内の項目は、（◆）に該当する受注の場合のみ、出力されます。それ以外は「空文字」もしくは「false」で出力されます。
		name（★）		配送サービス名	〇	String	50	宅配便設定-表示設定メール便設定-表示設定店舗受取設定-表示設定にて設定した名称を出力 ------------------------------------------------------ （◆）に該当しない受注は「空文字」
		code（★）		配送種別区分	〇	String	12	COURIER：宅配便 MAIL：メール便 STORE_PICKUP：店舗受取 ------------------------------------------------------ （◆）に該当しない受注は「空文字」
		companyCode（★）		運送会社区分	〇	String	14	YAMATO_UNYU：ヤマト運輸 SAGAWA_KYUBIN：佐川急便 NIHON_YUBIN：日本郵便 SEINO_UNYU：西濃運輸 FUKUYAMA_TSUUN：福山通運 OTHER：その他空文字：「店舗受取」で受注した場合 ------------------------------------------------------ （◆）に該当しない受注は「空文字」
		isCoolDelivery（★）		クール便使用フラグ	〇	Boolean	-	true：クール便商品あり false：クール便商品なし ------------------------------------------------------ （◆）に該当しない受注は「false」
		isRoomTemperatureDelivery（★）		常温便使用フラグ	〇	Boolean	-	true：常温便商品あり false：常温便商品なし ------------------------------------------------------ （◆）に該当しない受注は「false」
		specialArea（★）		離島など一部地域フラグ	〇	Boolean	-	true：「離島など一部地域」で設定された地域に該当する場合 false：「離島など一部地域」で設定された地域に該当しない場合 ------------------------------------------------------ （◆）に該当しない受注は「false」
	shipmentEmailNumSent			メール送信回数（発送通知）	◯	Number	4
	shipmentEmailDateSent			メール送信日（発送通知）	◯	String	19	「yyyy-mm-ddThh:mm:ss」形式
	storeCode			店舗コード	◯	String	10
	storeName			店舗名	◯	String	200	「店舗名（正式名称）」「店舗名（正式名称）」空欄時は「店舗名」を出力
	storeZipCode			店舗郵便番号	◯	String	8
	storePrefecture			店舗都道府県区分	◯	String	9	※prefecture出力内容
	storeAddress1			店舗住所1	◯	String	200
	storeAddress2			店舗住所2	◯	String	200
	storeAddress3			店舗住所3	◯	String	200
	storePhoneNo			店舗電話番号	◯	String	13
	pdCompanyCode			NP後払い運送会社コード	◯	String	5	NP後払い（即時与信）で決済された場合、配送に利用された運送会社コード／【CC未利用・移行中】運送会社コードを出力
	productList			商品リスト	◯	-	-
		productNo		商品番号	◯	String	32
		skuNo		SKU番号	◯	String	232	商品番号+枝番(横軸)+枝番(縦軸)
		janCode		JANコード	◯	String	30
		name		商品名	◯	String	300
		hanpukaiName		頒布会商品名	◯	String	100
		verticalVariationName		縦バリエーション名	◯	String	100
		horizontalVariationName		横バリエーション名	◯	String	100
		price		販売単価	◯	Number	9	（税込み設定にかかわらず）税込み
		count		購入数量	◯	Number	9
		taxIncluded		消費税種類	◯	String	12	TAX_INCLUDED：税込 TAX_EXCLUDED：税別
		tax		消費税	◯	Number	9
		taxRateCode		消費税率区分（商品）	◯	String	8	STANDARD：標準税率 REDUCED：軽減税率
		preorder		予約商品フラグ	◯	Boolean	-	true：予約商品 false：非予約商品
		nextShippingDate		入出荷予定日	◯	String	10	「yyyy-mm-dd」形式
		shippingDateLabel		入出荷予定日（表記名）	◯	String	50
		excludedStorePickup		店舗受取対象外フラグ	○	Boolean	-	true：対象外 false：対象
		orderCancelDisabled		キャンセル不可フラグ	○	Boolean	-	true：キャンセル不可 false：キャンセル可
		temperatureRangeType（★）		温度帯区分	○	String	25	空文字：「メール便」「店舗受取」で受注した場合 ROOM_TEMPERATURE_DELIVERY：「常温便」 CHILLED_DELIVERY：「クール便(冷蔵)」 FROZEN_DELIVERY：「クール便(冷凍)」 ------------------------------------------------------ ・（◆）に該当する受注の場合は、出力・（◆）に該当しない受注の場合は、「空文字」
		weight（★）		梱包重量	○	String	6	・（◆）に該当する受注かつ、登録がある場合は出力・（◆）に該当しない受注の場合は、「空文字」
		packingGroupName（★）		同梱可能グループ	○	String	510	・（◆）に該当する受注かつ、登録がある場合は出力・（◆）に該当しない受注の場合は、「空文字」
		optionPriceList		オプション価格	◯	Array	-	オプション価格ごとに配列出力
			name	項目名		String	100
			selectionName	選択肢名		String	100
			selectionCode	選択肢コード		String	50
			price	価格		String	9	税込み
			tax	消費税		String	9
			taxRateCode	消費税率区分		String	8	STANDARD：標準税率 REDUCED：軽減税率
		optionList		オプションリスト	◯	Array	-	項目選択肢ごとに配列出力
			name	項目名		String	100
			selectionItem	選択肢		String	100
	addressInfo（★）			お届け先情報	◯	-	-	「STORE_PICKUP（店舗受取）」の場合、注文時の購入者情報（お客様情報）が出力されます。 ------------------------------------------------------ 「STORE_PICKUP（店舗受取）」の判定先は以下になります。・（◆）に該当する受注については、「配送種別区分（code）」・（◆）に該当しない受注については、「配送サービス区分（deliveryService）」
		lastName		お届け先氏名（姓）	◯	String	200
		firstName		お届け先氏名（名）	◯	String	200
		lastNameKana		お届け先フリガナ（姓）	◯	String	200
		firstNameKana		お届け先フリガナ（名）	◯	String	200
		zipCode		お届け先郵便番号	◯	String	7	3桁 -(半角) 4桁
		prefecture		お届け先都道府県区分	◯	String	9
		address1		お届け先住所１	◯	String	200
		address2		お届け先住所２	◯	String	200
		address3		お届け先住所３	◯	String	200
		phoneNo		お届け先電話番号	◯	String	13

prefecture出力内容

出力		出力		出力		出力
HOKKAIDO	北海道	AOMORI	青森県	AKITA	秋田県	IWATE	岩手県
MIYAGI	宮城県	YAMAGATA	山形県	FUKUSHIMA	福島県	IBARAKI	茨城県
TOCHIGI	栃木県	GUNMA	群馬県	SAITAMA	埼玉県	CHIBA	千葉県
KANAGAWA	神奈川県	TOKYO	東京都	YAMANASHI	山梨県	NIIGATA	新潟県
NAGANO	長野県	SHIZUOKA	静岡県	AICHI	愛知県	MIE	三重県
GIFU	岐阜県	TOYAMA	富山県	ISHIKAWA	石川県	FUKUI	福井県
OSAKA	大阪府	KYOTO	京都府	SHIGA	滋賀県	NARA	奈良県
WAKAYAMA	和歌山県	HYOGO	兵庫県	OKAYAMA	岡山県	HIROSHIMA	広島県
YAMAGUCHI	山口県	TOTTORI	鳥取県	SHIMANE	島根県	KAGAWA	香川県
TOKUSHIMA	徳島県	EHIME	愛媛県	KOCHI	高知県	FUKUOKA	福岡県
SAGA	佐賀県	NAGASAKI	長崎県	KUMAMOTO	熊本県	OITA	大分県
MIYAZAKI	宮崎県	KAGOSHIMA	鹿児島県	OKINAWA	沖縄県	OTHER	その他

エラーコード

受注が存在しない場合、404が返却されます。