【Yahoo!ショッピング】[10月3日提供開始]「LINEギフト」注文データ連携の導入に伴う仕様変更について

※「LINEギフト」をご利用の出店者様向けのご案内です。

いつもYahoo!ショッピングをご利用いただき、誠にありがとうございます。
2021年10月よりYahoo!ショッピングの商品がLINEギフトに併売出品できるようになりました。

商品・在庫管理についてはストアクリエイターProにて、受注管理についてはショップCMSにて行っていただいておりますが、今後は受注管理についてもストアクリエイターProで行えるようになります。

また、Yahoo! JAPANデベロッパーネットワーク提供のAPIも活用して受注管理が行えるようになりますので、 影響のある注文APIについてご説明いたします。

影響があるAPI

注文検索

https://developer.yahoo.co.jp/webapi/shopping/orderList.html
- 検索条件( Condition) :

キー名 最大長 項目 内容
LineGiftDisplayType 未指定:LINEギフト含む全注文取得
0 :LINEギフト含む全注文取得
1:LINEギフト注文のみ取得
2:非LINEギフト注文のみ取得
1byte(固定) LINEギフト表示種別
※LINEギフト専用項目
取得情報にLINEギフト注文を含めるかを判定するフラグです。
LineGiftShippableType(※5) 0 or 未指定:LINEギフト含む全注文取得
1:通常注文+出荷可能なLINEギフト注文取得
2:出荷不可なLINEギフト注文のみ取得
1byte(固定) LINEギフト出荷可能種別
※LINEギフト専用項目
出荷可能なLINEギフト注文を取得するか判定するフラグです。
ShippingDeadlineFrom YYYYMMDDHH24MISS 14byte(固定) LINEギフト発送期限(From)
※LINEギフト専用項目
LINEギフト発送期限のレンジ検索時に指定する検索開始日時です。
ShippingDeadlineTo YYYYMMDDHH24MISS 14byte(固定) LINEギフト発送期限(To)
※LINEギフト専用項目
LINEギフト発送期限のレンジ検索時に指定する検索終了日時です。

- 取得情報(Field) :

キー名 最大長 項目 情報区分 内容
LineGiftOrderId (文字列) 20byte LINEギフト注文ID
※LINEギフト専用項目
受注時に連携されたLINEギフト注文IDです。
IsLineGiftOrder false : LINEギフト注文以外
true : LINEギフト注文
5byte LINEギフト注文
※LINEギフト専用項目
LINEギフト注文かどうかを判定するフラグです。
IsLineGiftShippable false : LINEギフト出荷不可
true : LINEギフト出荷可能
5byte LINEギフト出荷可能フラグ
※LINEギフト専用項目
LINEギフト注文が出荷可能状態であるかを判定するフラグです。
ShippingDeadline YYYY-MM-DDTHH24:mi:SS(日本標準時) 25byte(固定) LINEギフト発送期限
※LINEギフト専用項目
LINEギフト注文の発送期限です。
LineGiftCharge (数値) 10byte(固定) LINEギフト手数料
※LINEギフト専用項目
LINEギフト注文の手数料です。

注文詳細API

https://developer.yahoo.co.jp/webapi/shopping/orderInfo.html
- 取得可能項目 : (文字列)、10000byte(最大)

分類 キー名 項目 最大長 内容
注文 LineGiftOrderId LINEギフト注文ID
※LINEギフト専用項目
(文字列) 20byte(最大) 受注時に連携されたLINEギフト側の注文ID
IsLineGiftOrder LINEギフト注文フラグ
※LINEギフト専用項目
false : LINEギフト注文以外
true : LINEギフト注文
5byte(最大) LINEギフト注文であるかのフラグ
請求 LineGiftPayMethodName LINEギフト支払い方法名称
※LINEギフト専用項目
(文字列) 150byte(最大) LINEギフト側で決済に利用された支払方法の名称
配送 IsLineGiftShippable LINEギフト出荷可能フラグ
※LINEギフト専用項目
false : LINEギフト出荷不可
true : LINEギフト出荷可能
5byte(最大) LINEギフト注文が出荷可能状態であるかのフラグ
ShippingDeadline 発送期限
※LINEギフト専用項目
YYYY-MM-DDTHH24:mi:SS(日本標準時) 25byte(最大) LINEギフト注文の発送期限
明細 LineGiftCharge LINEギフト手数料
※LINEギフト専用項目
(数値) 10 byte(最大) LINEギフト注文の手数料
セラー LineGiftAccount LINEギフトアカウント(LINEギフトショップID)
※LINEギフト専用項目
(文字列) 20byte(最大) 受注時に連携されたLINEギフトのショップアカウント

注文ステータス変更API

https://developer.yahoo.co.jp/webapi/shopping/orderStatusChange.html
▼ エラーコード

コード HTTPステータスコード 説明
od90180 400 LINEギフト注文でまだ操作不可な状態で変更操作が行われた場合のエラー
od90183 400 LINEギフト注文で注文ステータスを保留にしようとした場合のエラー
od91060 500 LINEギフト注文の注文キャンセル時にLINE側都合(キャンセル可能期間が過ぎているなど)で失敗した場合のエラー
od91061 500 LINEギフト注文のAPIと連携エラーした場合のエラー
od91062 500 LINEギフト注文のAPIでタイムアウトが発生した場合のエラー
od91063 500 LINEギフト注文のAPIで他のエラーに分類できないエラーが発生した場合のエラー
od91183 500 LINEギフト注文で出荷ステータスが「出荷済み」または「着荷済み」以外で注文ステータスを完了にしようとした場合のエラー

入金ステータス変更API

https://developer.yahoo.co.jp/webapi/shopping/orderPayStatusChange.html
エラーコード

コード HTTPステータスコード 説明
od90178 400 LINEギフト注文で変更不可な操作をした場合のエラー

出荷ステータス変更API

https://developer.yahoo.co.jp/webapi/shopping/orderShipStatusChange.html
リクエストパラメータ

パラメータ 説明
Req/Order/Ship/CashOnDeliveryTax integer ※ヤマトピック&デリバリー専用項目
代引き用消費税額
税額無しの場合は0を指定
税額未入力の場合は、出荷指示ステータス=出荷指示済み変更時に10%で自動計算された値が入ります。

毎日23:00~翌7:00までシステムメンテナンスに入ります。

ヤマト運輸へのデータ連携は翌7:00から行われますので当日中連携をご希望の場合は22:30ごろまでに更新をお願いします。
※連携の件数によっては22:30に行なっても翌朝になるケースもございます。
※LINEギフト注文は更新不可です。
Req/Order/Ship/IsEazy boolean EAZY注文フラグ

true:EAZY注文
false:非EAZY注文

※ShipMethodを指定している場合、IsEazyは無効パラメータ扱いとなる。
※EazyDeliveryCode、EazyDeliveryNameを変更する場合、IsEazy=trueもセット(同値更新)すること。
※LINEギフト注文は更新不可です。
Req/Order/Ship/EazyDeliveryCode integer EAZYコード

0:対面受取
1:玄関ドア前
2:自宅宅配BOX
3:ガスメーターBOX
4:物置
5:車庫
6:自転車かご
7:建物内受付/管理人預け

※ShipMethodを指定している場合、EazyDeliveryCodeは無効パラメータ扱いとなる。
※LINEギフト注文は更新不可です。
Req/Order/Ship/EazyDeliveryName string EAZY受け取り場所名

0:対面受取
1:玄関ドア前
2:自宅宅配BOX
3:ガスメーターBOX
4:物置
5:車庫
6:自転車かご
7:建物内受付/管理人預け

※ShipMethodを指定している場合、EazyDeliveryNameは無効パラメータ扱いとなる。
※LINEギフト注文は更新不可です。

エラーコード

コード HTTPステータスコード 説明
od90178 400 LINEギフト注文で変更不可な操作をした場合のエラー
od90180 400 LINEギフト注文でまだ操作不可な状態で変更操作が行われた場合のエラー

注文内容変更API

https://developer.yahoo.co.jp/webapi/shopping/orderChange.html
- 更新情報キー :

分類 キー名 項目 最大長 内容
Suspect 悪戯フラグ 0 : 非悪戯注文
1 : 悪戯注文
2 : 悪戯解除済注文
1byte(固定) ※ほかの項目と同時に更新できません。更新する場合は、この項目のみで更新してください。
※LINEギフト注文は更新不可です。
PayType 支払い分類 0 : 後払い
1 : 前払い
1byte(固定) ※LINEギフト注文は更新不可です。
PayKind 支払い種別 変更可能な支払い方法は以下の通りです。
0 : カード
1 : ネットバンキング
2 : キャリア決済
3 : 振込
4 : 代引
5 : コンビニ
6 : 電子マネー
7 : その他
1byte(固定) ※LINEギフト注文は更新不可です。
PayMethod 支払い方法 (文字列)
payment_決済ID
payment_a1:カード決済
payment_a6:コンビニ決済(セブンイレブン)
payment_a7:コンビニ決済(その他)
payment_a8:モバイルSuica決済
payment_a9:d払い
payment_a10:auかんたん決済
payment_a11:ソフトバンクまとめて支払い
payment_a15:ペイジー
payment_a16:Yahoo!マネー/預金払い
payment_a17:PayPay残高払い
payment_a19:PayPayあと払い
payment_b[1-6]:銀行振込(名称はストアの自由設定)
payment_c1:ゆうちょ銀行(前払い)
payment_c2:ゆうちょ銀行(後払い)
payment_c3:現金書留
payment_d1:商品代引
payment_e[1-15]:ストアの自由なお支払い方法名
payment_z1:ポイント全額払い
11byte(最大) お支払方法番号。
変更可能なステータスは以下の通りです。
カード決済:支払い完了 or 決済完了 or オーソリーエラー
コンビニ、ペイジー、モバイルSuica決済:支払い待ち or 有効期限切れ or Suicaアドレスエラー
キャリア決済:支払い待ち(+他のステータスの状態次第)
※ PayMethodを変えるだけではストアクリエイターProの決済方法の表示は変更できません。PayMethodNameも同時に変更してください。
※LINEギフト注文は更新不可です。
PayMethodName 支払い方法名称 (文字列)
支払方法
150byte最大) ※LINEギフト注文は更新不可です。
PrintSlipTime 注文伝票出力時刻 (YYYYMMDDHH24MISS) 14byte(固定) 注文伝票を出力した日時です。
※LINEギフト注文は更新不可です。
PrintDeliveryTime 納品書出力時刻 (YYYYMMDDHH24MISS) 14byte(固定) 納品書を出力した日時です。
※LINEギフト注文は更新不可です。
PrintBillTime 請求書出力時刻 (YYYYMMDDHH24MISS) 14byte(固定) 請求書を出力した日時です。
※LINEギフト注文は更新不可です。
RefundStatus 返金ステータス (文字列) 1byte(固定) 返金の要不要や返金の状態を表す区分です。
0:不要
1:必要
2:返金済み
APIで更新できるのは1:必要から2:返金済みへの更新のみ。
※LINEギフト注文は更新不可です。
IsFirstClassDrugAgreement 第1類医薬品承諾フラグ false:未承諾
true:承諾済み
5byte(最大) 第1類医薬品を含む注文の承諾状況を判定します。
※LINEギフト注文は更新不可です。
請求 PayDate 入金日 (YYYYMMDD) 8byte(固定) 入金日
※LINEギフト注文は更新不可です。
PayNotes 入金処理備考 (文字列) 1000byte(最大) 入金処理備考
※LINEギフト注文は更新不可です。
PayManageLimitDate 代金支払い管理注文期限日時 (YYYYMMDD) 8byte(固定) 代金支払い管理注文期限日時
※LINEギフト注文は更新不可です。
NeedBillSlip 請求書有無 キーなし : カートに設定なし
false : 請求書不要
true : 請求書必要
(数値) 請求書有無
※LINEギフト注文は更新不可です。
NeedDetailedSlip 明細書有無 キーなし : カートに設定なし
false : 明細書不要
true : 明細書必要
(数値) 明細書有無
伝票画面上では、「納品書」表記です。
帳票出力でも「納品書」出力で、「明細書」が出力可能です。
※LINEギフト注文は更新不可です。
NeedReceipt 領収書有無 キーなし : カートに設定なし
false : 領袖書不要
true : 領袖書必要
(数値) 領収書有無
BillFirstName ご請求先名前 (文字列) 297byte(最大) ご請求先名前
※LINEギフト注文は更新不可です。
BillFirstnameKana ご請求先名前カナ (文字列) 297byte(最大) ご請求先名前(フリガナ)
※LINEギフト注文は更新不可です。
BillLastName ご請求先名字 (文字列) 297byte(最大) ご請求先名字
※LINEギフト注文は更新不可です。
BillLastNameKana ご請求先名字カナ (文字列) 297byte(最大) ご請求先名字(フリガナ)
※LINEギフト注文は更新不可です。
BillZipCode ご請求先郵便番号 (文字列) 10byte(最大) ご請求先郵便番号
※LINEギフト注文は更新不可です。
BillPrefecture ご請求先都道府県 (文字列) 12byte(最大) ご請求先都道府県
海外の場合「その他」が入ります。
※LINEギフト注文は更新不可です。
BillPrefectureKana ご請求先都道府県フリガナ (文字列) 18byte(最大) ご請求先都道府県フリガナ
※LINEギフト注文は更新不可です。
BillCity ご請求先市区郡 (文字列) 297byte(最大) ご請求先市区郡
※LINEギフト注文は更新不可です。
BillCityKana ご請求先市区郡フリガナ (文字列) 297byte(最大) ご請求先市区郡フリガナ
※LINEギフト注文は更新不可です。
BillAddressFrom ご請求先住所引用元 P : ご登録自宅住所
B : ご登録勤務先住所
ship : お届け先と同じ
O1 : その他1
O2 : その他2
O3 : その他3
O4 : その他4
O : その他で入力
4byte(最大) ご請求先住所引用元
※LINEギフト注文は更新不可です。
BillAddress1 ご請求先住所1 (文字列) 297byte(最大) ご請求先住所1
※LINEギフト注文は更新不可です。
BillAddress1Kana ご請求先住所1フリガナ (文字列) 297byte(最大) ご請求先住所1フリガナ
※LINEギフト注文は更新不可です。
BillAddress2 ご請求先住所2 (文字列) 297byte(最大) ご請求先住所2
※LINEギフト注文は更新不可です。
BillAddress2Kana ご請求先住所2フリガナ (文字列) 297byte(最大) ご請求先住所2フリガナ
※LINEギフト注文は更新不可です。
BillPhoneNumber ご請求先電話番号 (文字列) 14byte(最大) ご請求先電話番号
※LINEギフト注文は更新不可です。
BillEmgPhoneNumber ご請求先電話番号(緊急) (文字列) 14byte(最大) ご請求先電話番号(緊急)
※LINEギフト注文は更新不可です。
BillMailAddress ご請求先メールアドレス (文字列) 99文字(最大) バイヤーの入力したメールアドレスです。Wallet利用の場合でかつ追加メールアドレス欄に入力がある場合は追加メールアドレスを入れます。
※LINEギフト注文は更新不可です。
BillSection1Field ご請求先所属1フィールド名 (文字列) 297byte(最大) ご請求先所属1フィールド名
※LINEギフト注文は更新不可です。
BillSection1Value ご請求先所属1入力情報 (文字列) 297byte(最大) ご請求先所属1入力情報
※LINEギフト注文は更新不可です。
BillSection2Field ご請求先所属2フィールド名 (文字列) 297byte(最大) ご請求先所属2フィールド名
※LINEギフト注文は更新不可です。
BillSection2Value ご請求先所属2入力情報 (文字列) 297byte(最大) ご請求先所属2入力情報
※LINEギフト注文は更新不可です。
ArriveType きょうつく、あすつく 0 : 通常
1 : きょうつく注文
2 : あすつく注文
1byte(固定) きょうつく注文、あすつく注文の場合設定
※LINEギフト注文は更新不可です。
NeedGiftWrap ギフト包装有無 キーなし : カートに設定なし
false : ギフト包装無し
true : ギフト包装有り
5byte(最大) ギフト包装の有無
※モバイル支払いの場合、ギフト包装の変更はできません。
※LINEギフト注文は更新不可です。
GiftWrapType ギフト包装種類 (文字列) 30byte(最大) ギフト包装の種類
※LINEギフト注文は更新不可です。
GiftWrapMessage ギフトメッセージ (文字列) 297byte(最大) ※LINEギフト注文は更新不可です。
NeedGiftWrapPaper のし有無 キーなし : カートに設定なし
false : のし無し
true : のし有り
(数値) のしの有無
※LINEギフト注文は更新不可です。
GiftWrapPaperType のし種類 (文字列) 30byte(最大) のし(種類)
※LINEギフト注文は更新不可です。
GiftWrapName 名入れ (文字列) 297byte(最大) 名入れ(メッセージ)
※LINEギフト注文は更新不可です。
ShipAddress2 お届け先住所2 (文字列) 297byte(最大) お届け先住所2
※LINEギフト注文は更新不可です。
ShipAddress2Kana お届け先住所2フリガナ (文字列) 297byte(最大) お届け先住所2フリガナ
※LINEギフト注文は更新不可です。
ShipSection1Field お届け先所属1フィールド名 (文字列) 297byte(最大) お届け先所属1フィールド名
※LINEギフト注文は更新不可です。
ShipSection1Value お届け先所属1値 (文字列) 297byte(最大) お届け先所属1入力情報
※LINEギフト注文は更新不可です。
ShipSection2Field お届け先所属2フィールド名 (文字列) 297byte(最大) お届け先所属2フィールド名
※LINEギフト注文は更新不可です。
ShipSection2Value お届け先所属2 (文字列) 297byte(最大) お届け先所属2入力情報
※LINEギフト注文は更新不可です。
CashOnDeliveryTax 代引き用消費税額 (数値) 15byte(最大) ※ヤマトピック&デリバリー専用項目
税額無しの場合は0を指定
税額未入力の場合は、出荷指示ステータス=出荷指示済み変更時に10%で自動計算された値が入ります。
※LINEギフト注文は更新不可です。
ReceiveShopCode 配送元店頭コード (文字列) 50byte(最大) ※LINEギフト注文は更新不可です。
ReceiveShopName 配送元店頭名 (文字列) 200byte(最大) ※LINEギフト注文は更新不可です。
IsEazy EAZY注文フラグ (文字列) 5byte(最大) EAZY注文フラグ
※ShipMethodを指定している場合、IsEazyは無効パラメータ扱いとなる。
※EazyDeliveryCode、EazyDeliveryNameを変更する場合、IsEazy=trueもセット(同値更新)すること。
※LINEギフト注文は更新不可です。
EazyDeliveryCode EAZYコード (数値) 2byte(最大) EAZYコード
※ShipMethodを指定している場合、EazyDeliveryCodeは無効パラメータ扱いとなる。
※LINEギフト注文は更新不可です。
EazyDeliveryName EAZY受け取り場所名 (文字列) 50byte(最大) EAZY受け取り場所名
※ShipMethodを指定している場合、EazyDeliveryNameは無効パラメータ扱いとなる。
※LINEギフト注文は更新不可です。
明細 PayCharge 手数料 (数値) 10byte(最大) セラーが設定した手数料(代引き手数料など)、Yahoo!決済の決済手数料は別です。
※LINEギフト注文は更新不可です。
ShipCharge 送料 (数値) 10byte(最大) 送料
※LINEギフト注文は更新不可です。
GiftWrapCharge ギフト包装料 (数値) 10byte(最大) ギフト包装料
※LINEギフト注文は更新不可です。
Discount 値引き (数値) 10byte(最大) 値引き
※LINEギフト注文は更新不可です。
Adjustments 調整額 (数値) 10byte(最大) 調整額
マイナスの値も許容、その場合は -(10byte) が許容最大
※LINEギフト注文は更新不可です。
商品 Quantity 数量 (数値) 3byte(最大) 商品ごとの数量
※LINEギフト注文は更新不可です。
ReleaseDate 発売日 (YYYYMMDD) 8byte(固定) 発売日の入力がある場合です。
発売日>注文日の場合、予約注文として扱います。
※LINEギフト注文は更新不可です。

エラーコード

コード HTTPステータスコード 説明
od90178 400 LINEギフト注文で変更不可な操作をした場合のエラー
od90180 400 LINEギフト注文でまだ操作不可な状態で変更操作が行われた場合のエラー
od90181 400 文字数制限となった場合のエラー

注文操作履歴一覧API

https://developer.yahoo.co.jp/webapi/shopping/orderChangeHistory.html
※サンプルレスポンスを修正しました。

注文分割API

https://developer.yahoo.co.jp/webapi/shopping/orderSplit.html
エラーコード

コード HTTPステータスコード 説明
od90178 400 LINEギフト注文で変更不可な操作をした場合のエラー

注文ライン追加API

https://developer.yahoo.co.jp/webapi/shopping/orderItemAdd.html
エラーコード

コード HTTPステータスコード 説明
od90178 400 LINEギフト注文で変更不可な操作をした場合のエラー

新規エラーレスポンスコード一覧

エラーコード HTTPステータスコード 説明 注文内容変更API 注文ステータス変更API 注文詳細API 注文検索API 出荷ステータス変更API 注文ライン追加API 注文分割API 入金ステータス変更API
od90178 400 LINEギフト注文で変更不可な操作をした場合のエラー
od90180 400 LINEギフト注文でまだ操作不可な状態で変更操作が行われた場合のエラー
od90181 400 文字数制限となった場合のエラー
od90183 400 LINEギフト注文で注文ステータスを保留にしようとした場合のエラー
od91060 500 LINEギフトの注文キャンセル時にLINE側都合(キャンセル可能期間が過ぎているなど)で失敗した場合のエラー
od91061 500 LINEギフトのAPIと連携エラーした場合のエラー
od91062 500 LINEギフトのAPIでタイムアウトが発生した場合のエラー
od91063 500 LINEギフトのAPIで他のエラーに分類できないエラーが発生した場合のエラー
od91183 500 LINEギフト注文で出荷ステータスが「出荷済み」または「着荷済み」以外で注文ステータスを完了にしようとした場合のエラー

支払い情報について

LINEギフト注文の決済処理はLINEギフト側で行われるため、ストアクリエイターProではYahoo!ショッピング外決済として扱います。
支払い情報の各項目について受注連携時は以下となります。支払い方法は変更できませんので購入者様とご相談の上ご対応をお願いいたします。
キー名 項目名 内容
PayMethod 支払方法 payment_z3
PayMethodName 支払方法名称 LINEギフト外部決済
PayType 支払分類 1:前払い
PayKind 支払種別 7:その他

アプリケーションの管理

利用のルール

開発のヒント