API更新履歴一覧

在庫検索API

2022.06.23

更新内容 更新理由 詳細 参照
レスポンス byte数変更 - 「id(商品ID)」32 → 18

実店舗在庫更新API

2023.01.31

更新内容 更新理由 詳細 参照
エラーコード 記載追加 - 「StockNotFound」記載追加

2023.01.13

更新内容 更新理由 詳細 参照
エラーコード 記載追加 - 「InvalidDateFormat,ProductNotFound,NotManagementSettings」記載追加

実店舗在庫削除API

2023.01.13

更新内容 更新理由 詳細 参照
エラーコード 記載追加 - 「InvalidDateFormat,ProductNotFound,NotManagementSettings」記載追加

受注取得API

2024.06.05

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

2024.01.24

更新内容 更新理由 詳細 参照
レスポンス 新規追加 au PAY(ネット支払い)追加のため 「paymentType」に「AU_PAY :au PAY(ネット支払い)(SBPS)」を追加
レスポンス 出力仕様修正 以前よりマニュアル上では、「Number」で記載していましたが、実際には「String」で出力されていたため、修正となります。 「bundleDiscountTotal(バンドル販売割引金額)」の出力形式
「String」 → 「Number」
レスポンス 新規追加 配送・送料(upgrade版)提供のため 「usingUpgradedPostage(配送・送料(upgrade版)使用フラグ)」を追加
レスポンス 新規追加 配送・送料(upgrade版)提供のため 「shipmentList(お届け先情報)」以下の項目の出力内容を一部変更。
レスポンス 新規追加 配送・送料(upgrade版)提供のため 「deliveryServiceInfo(配送サービス情報)」を追加。
および、配下に以下の項目を追加
------------------------------------------------------
「name(配送サービス名)」
「code(配送種別区分)」
「companyCode(運送会社区分)」
「isCoolDelivery(クール便使用フラグ)」
「isRoomTemperatureDelivery(常温便使用フラグ)」
「specialArea(離島など一部地域フラグ)」
レスポンス 新規追加 配送・送料(upgrade版)提供のため 「temperatureRangeType(温度帯区分)」を追加。

2023.03.07

更新内容 更新理由 詳細 参照
レスポンス 受注キャンセルに関するレスポンス追加 マイページからの注文キャンセル機能のため (※1)「cancelDate(キャンセル日時)」
「cancelRequestDate(キャンセルリクエスト日時)」
「cancelRequestRevoked(キャンセルリクエスト取消)」
(※2)「orderCancelDisabled(キャンセル不可フラグ)」
(※1)
(※2)
レスポンス 新規追加 - 「selectionCode(選択肢コード)」追加
レスポンス 「price(価格)」「tax(消費税)」型変更 - 「Number」→「String」

2022.10.19

更新内容 更新理由 詳細 参照
レスポンス 「paymentType」に出力内容追加 「paymentType」に「PAIDY:あと払い(ペイディ)」追加 決済方法あと払い(ペイディ)追加のため
レスポンス key新規追加 「paidyPaymentId」追加 決済方法あと払い(ペイディ)追加のため

2022.09.05

更新内容 更新理由 詳細 参照
レスポンス 「productTotal(商品合計金額)」の出力内容変更 - 「オプション価格を含まない → オプション価格を含む 」へ変更
レスポンス 「shipmentList > productList > optionPriceList > price(価格)」の出力内容変更 - 「消費税を含まない → 消費税を含む 」へ変更

2022.06.23

更新内容 更新理由 詳細 参照
レスポンス receiptShopName(支払い店舗)追加 - 「receiptShopName」新規追加
レスポンス 「paymentType」出力条件追加 決済方法NP後払い(即時与信)追加のため 「NP_POSTPAY_RTA:NP後払い(即時与信)」追加
レスポンス npTransactionId(NP後払い 取引ID)追加 決済方法NP後払い(即時与信)追加のため 「npTransactionId」新規追加
レスポンス pdCompanyCode(NP後払い 運送会社コード)追加 決済方法NP後払い(即時与信)追加のため 「pdCompanyCode」新規追加

2022.02.24

更新内容 更新理由 詳細 参照
レスポンス 「addressInfo」出力条件追加 店舗受取オプション対応のため 「deliveryService(配送サービス区分)」が「STORE_PICKUP(店舗受取)」の場合、初回の購入者情報を出力
レスポンス 「deliveryService」出力条件追加 店舗受取オプション対応のため 「STORE_PICKUP:店舗受取」新規追加
レスポンス 「受け取り店舗」情報関連key新規追加 店舗受取オプション対応のため 以下を新規追加

「storeCode(店舗コード)」
「storeName(店舗名)」
「storeZipCode(店舗郵便番号)」
「storePrefecture(店舗都道府県区分)」
「storeAddress1(店舗住所1)」
「storeAddress2(店舗住所2)」
「storeAddress3(店舗住所3)」
「storePhoneNo(店舗電話番号)」
レスポンス key新規追加 店舗受取オプション対応のため 「excludedStorePickup(店舗受取対象外フラグ)」新規追加
レスポンス byte数変更 - 「nickName(ニックネーム)」100 → 50
レスポンス byte数変更 - 「companyName(会社名)」50 → 200
レスポンス byte数変更 - 「memberStageName(会員ステージ名)」40 → 60
レスポンス byte数変更 - 以下、15 → 13に変更

「telNoMain(電話番号(メイン))」
「telNoAlternate(電話番号(サブ))」
「faxNo(FAX番号)」
「companyTelNo(電話番号(会社))」
「companyFaxNo(電話番号(FAX))」
「phoneNo(お届け先電話番号)」

2021.09.29

更新内容 更新理由 詳細 参照
レスポンス deliveryService(配送サービス区分)追加 配送サービス名以外に、メール便の判定を行うため 「deliveryService」新規追加
レスポンス couponName(利用クーポン)の型/byteの変更) 受注に利用されたクーポン情報(複数可)を取得可能にするため String → Text

受注検索API

2024.06.05

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

2024.01.24

更新内容 更新理由 詳細 参照
レスポンス 新規追加 au PAY(ネット支払い)追加のため 「paymentType」に「AU_PAY :au PAY(ネット支払い)(SBPS)」を追加
レスポンス 新規追加 配送・送料(upgrade版)提供のため 「usingUpgradedPostage(配送・送料(upgrade版)使用フラグ)」を追加
レスポンス 新規追加 配送・送料(upgrade版)提供のため 「shippingInfo(配送情報)」以下の項目の出力内容を一部変更。
レスポンス 新規追加 配送・送料(upgrade版)提供のため 「deliveryServiceInfo(配送サービス情報)」を追加。
および、配下に以下の項目を追加
------------------------------------------------------
「name(配送サービス名)」
「code(配送種別区分)」
「companyCode(運送会社区分)」
「isCoolDelivery(クール便使用フラグ)」
「isRoomTemperatureDelivery(常温便使用フラグ)」
「specialArea(離島など一部地域フラグ)」
レスポンス 新規追加 配送・送料(upgrade版)提供のため 「temperatureRangeType(温度帯区分)」を追加。

2023.03.07

更新内容 更新理由 詳細 参照
パラメータ 受注キャンセルに関するパラメータ追加 マイページからの注文キャンセル機能のため 「cancelDateStart(受注キャンセル日時(start))」
「cancelDateEnd(受注キャンセル日時(end))」
「cancelRequestDateStart(受注キャンセルリクエスト日時(start))」
「cancelRequestDateEnd(受注キャンセルリクエスト日時(end))」
レスポンス 受注キャンセルに関するレスポンス追加 マイページからの注文キャンセル機能のため (※1)「cancelDate(キャンセル日時)」
「cancelRequestDate(キャンセルリクエスト日時)」
「cancelRequestRevoked(キャンセルリクエスト取消)」
(※2)「orderCancelDisabled(キャンセル不可フラグ)」
(※1)
(※2)
レスポンス 新規追加 - 「selectionCode(選択肢コード)」追加
レスポンス 新規追加 - 「taxRateCode(消費税率区分)」追加
レスポンス 「price(価格)」「tax(消費税)」型変更 - 「Number」→「String」
エラーコード 受注キャンセルに関するエラーコード追加 マイページからの注文キャンセル機能のため 「InvalidDateFormat」「InvalidDateRange」追加

2022.10.19

更新内容 更新理由 詳細 参照
レスポンス 「paymentType」出力条件追加 決済方法あと払い(ペイディ)追加のため 「PAIDY:あと払い(ペイディ)」追加

2022.09.05

更新内容 更新理由 詳細 参照
レスポンス 「productTotal(商品合計金額)」の出力内容変更 - 「オプション価格を含まない → オプション価格を含む 」へ変更
レスポンス 「shipmentList > productList > optionPriceList > price(価格)」の出力内容変更 - 「消費税を含まない → 消費税を含む 」へ変更

2022.06.23

更新内容 更新理由 詳細 参照
レスポンス receiptShopName(支払い店舗)追加 - 「receiptShopName」新規追加
レスポンス 「paymentType」出力条件追加 決済方法NP後払い(即時与信)追加のため 「NP_POSTPAY_RTA:NP後払い(即時与信)」追加

2022.02.24

更新内容 更新理由 詳細 参照
レスポンス 「addressInfo」出力条件追加 店舗受取オプション対応のため 「deliveryService(配送サービス区分)」が「STORE_PICKUP(店舗受取)」の場合、初回の購入者情報を出力
レスポンス 「deliveryService」出力条件追加 店舗受取オプション対応のため 「STORE_PICKUP:店舗受取」新規追加
レスポンス 「受け取り店舗」情報関連key新規追加 店舗受取オプション対応のため 以下を新規追加

「storeCode(店舗コード)」
「storeName(店舗名)」
「storeZipCode(店舗郵便番号)」
「storePrefecture(店舗都道府県区分)」
「storeAddress1(店舗住所1)」
「storeAddress2(店舗住所2)」
「storeAddress3(店舗住所3)」
「storePhoneNo(店舗電話番号)」
レスポンス key新規追加 店舗受取オプション対応のため 「excludedStorePickup(店舗受取対象外フラグ)」新規追加
レスポンス byte数変更 - 以下、15 → 13に変更

「telNoMain(電話番号(メイン))」
「faxNo(FAX番号)」
「companyTelNo(電話番号(会社))」
「companyFaxNo(電話番号(FAX))」
「phoneNo(お届け先電話番号)」

2021.09.29

更新内容 更新理由 詳細 参照
レスポンス deliveryService(配送サービス区分)追加 配送サービス名以外に、メール便の判定を行うため 「deliveryService」新規追加
::

実店舗取得API

2022.02.24

更新内容 更新理由 詳細 参照
レスポンス key新規追加 店舗受取オプション対応のため 以下を新規追加

「telNo(電話番号)」
「telNoLinkEnabled(電話番号リンク利用設定)」
「storePickupEnabled(店舗受取利用設定)」
「storePickupGoogleTag(Google マップ埋め込みタグ)」
「storePickupComment(フリーコメント)」
「storePickupDetailComment(受取店舗詳細フリーコメント)」
「storePickupMail(受取通知メールに挿入する文章)」
レスポンス 「htmlComment(フリーコメント)」型変更 - String → text

実店舗登録API

2022.02.24

更新内容 更新理由 詳細 参照
リクエストボディ(json) 「必須」指定解除 店舗受取オプション対応のため 以下のkeyに関して「必須」指定解除

「storeNameLinkUrl(店舗名(リンクURL))」
「storeNameFull(店舗名(正式名称))」
「zipCode(郵便番号)」
「address(所在地)」
「addressLinkUrl(所在地(リンクURL))」
「additionalItem11~5(name・url)(任意項目1~5)」
「htmlComment(フリーコメントエリア)」
「saleStoreCode(販売店舗コード(omni))」
「stockStoreCode(在庫店舗コード)」
リクエストボディ(json) 「htmlComment(フリーコメントエリア)」の型・byte/文字制限変更 店舗受取オプション対応のため String(16000byte)→Text(最大16,000文字)
リクエストボディ(json) key新規追加 店舗受取オプション対応のため 以下を新規追加

「telNo(電話番号)」
「telNoLinkEnabled(電話番号リンク利用設定)」
「storePickupEnabled(店舗受取利用設定)」
「storePickupGoogleTag(Google マップ埋め込みタグ)」
「storePickupComment(フリーコメント)」
「storePickupDetailComment(受取店舗詳細フリーコメント)」
「storePickupMail(受取通知メールに挿入する文章)」
エラーコード 新規追加されたkeyに対するエラーコードを新規追加 店舗受取オプション対応のため 以下の「コード」「メッセージ」を新規追加

「InvalidValue」
「TooLong」
「StorePickupAddressRequired」
「StorePickupAddressInvalidValue」

実店舗更新API

2022.02.24

更新内容 更新理由 詳細 参照
リクエストボディ(json) 「必須」指定解除 店舗受取オプション対応のため 以下のkeyに関して「必須」指定解除

「storeName(店舗名)」
「storeNameLinkUrl(店舗名(リンクURL))」
「storeNameFull(店舗名(正式名称))」
「displayOrder(表示順)」
「areaCode(店舗エリア)」
「zipCode(郵便番号)」
「address(所在地)」
「addressLinkUrl(所在地(リンクURL))」
「additionalItem11~5(name・url)(任意項目1~5)」
「htmlComment(フリーコメントエリア)」
「saleStoreCode(販売店舗コード(omni))」
「stockStoreCode(在庫店舗コード)」
リクエストボディ(json) 「htmlComment(フリーコメントエリア)」の型・byte/文字制限変更 店舗受取オプション対応のため String(16000byte)→Text(最大16,000文字)
リクエストボディ(json) key新規追加 店舗受取オプション対応のため 以下を新規追加

「telNo(電話番号)」
「telNoLinkEnabled(電話番号リンク利用設定)」
「storePickupEnabled(店舗受取利用設定)」
「storePickupGoogleTag(Google マップ埋め込みタグ)」
「storePickupComment(フリーコメント)」
「storePickupDetailComment(受取店舗詳細フリーコメント)」
「storePickupMail(受取通知メールに挿入する文章)」
エラーコード 新規追加されたkeyに対するエラーコードを新規追加 店舗受取オプション対応のため 以下の「コード」「メッセージ」を新規追加

「InvalidValue」
「TooLong」
「StorePickupAddressRequired」
「StorePickupAddressInvalidValue」

会員検索API

2024.01.24

更新内容 更新理由 詳細 参照
レスポンス 新規追加 Gmail メール送信者のガイドライン「ワンクリック登録解除」対応のため 以下を追加
「listUnsubscribeLinkMail」
「listUnsubscribeLinkMobileMail」

------------------------------------------------------
【出力仕様修正】※2024.01.10追記
「出力形式」の修正  「String」 → 「Text」

ポイントステータス変更API

2022.04.13

更新内容 更新理由 詳細 参照
エラーコード エラーコードを新規追加 「調整ポイント」「利用ポイント」「返還ポイント」のステータス変更にはご利用いただけないため 「CannotUpdateAdjustedPoints」調整ポイント更新不可
「CannotUpdateUsedPoints」利用ポイント更新不可
「CannotUpdateReturnedPoints」返還ポイント更新不可

発送API

2022.08.31

更新内容 更新理由 詳細 参照
リクエストボディ-invoiceNo byte数修正 20byte → 100byte

2022.06.23

更新内容 更新理由 詳細 参照
エラーコード-results エラーコードを新規追加 店舗受取オプションの追加対応 「CannotUpdateStorePickup」追加

入金API

2024.06.05

更新内容 更新理由 詳細 参照
各決済の最小金額 決済方法と制御を追加 楽天ペイ(オンライン決済)V2(SBPS)追加のため 「楽天ペイ(オンライン決済)V2(SBPS)」追加

2024.01.24

更新内容 更新理由 詳細 参照
各決済の最小金額 決済方法と制御を追加 決済方法au PAY(ネット支払い)(SBPS)追加のため 「au PAY(ネット支払い)(SBPS)」追加

2022.10.19

更新内容 更新理由 詳細 参照
各決済の最小金額 決済方法と制御を追加 決済方法あと払い(ペイディ)追加のため 「あと払い(ペイディ)」を追加

2022.06.23

更新内容 更新理由 詳細 参照
各決済の最小金額 決済方法と制御を追加 決済方法NP後払い(即時与信)追加のため 「NP後払い(即時与信)」を追加
レスポンス MinPurchaseAmountの説明を変更 - 「受注金額が各決済の最小金額を下回った場合に返却されます。」に変更(管理画面での金額設定を削除。)

商品検索API

2024.06.05

更新内容 更新理由 詳細 参照
レスポンス 新規追加 配送・送料(upgrade版)の新機能提供のため 以下を追加
(1)productList > weight(梱包重量)
(2)productList > variation > variationList >
   weight(梱包重量(バリエーション毎))
(3)productList > packingGroupName(同梱可能グループ)
(1)
(2)
(3)

2024.01.24

更新内容 更新理由 詳細 参照
レスポンス 新規追加・出力条件変更 配送・送料(upgrade版)提供のため 配送・送料(upgrade版)関連項目追加

2023.10.12

更新内容 更新理由 詳細 参照
レスポンス image > imageListにkey新規追加 「商品サムネイル画像」設定の取得のため 「thumbnailEnabled」を新規追加

2023.07.11

更新内容 更新理由 詳細 参照
レスポンス variation> variationListにkey新規追加 バリエーション価格 ・「price(バリエーション価格)」
・「representativeVariation(代表バリエーションフラグ)」
レスポンス preorderにkey新規追加 バリエーション価格 「preorderUnitPriceEnabled(予約販売価格設定)」
レスポンス preorder>preorderListにkey新規追加 バリエーション価格 ・「price(バリエーション予約価格)」
・「representativeVariation(代表バリエーションフラグ)」

2023.03.15

更新内容 更新理由 詳細 参照
レスポンス key新規追加 設定>店舗共通>消費税設定の設定出力のため 「taxConfig:消費税設定」
「enabled:加算設定」
「standardTaxRate:標準税率」
「reducedTaxRate:軽減税率」
「roundingType:端数計算区分」

2022.10.19

更新内容 更新理由 詳細 参照
レスポンス key新規追加 - 商品URIを出力するkey「uri」を追加