運用サポート(平日10:00~17:00) 06-6485-6485
コマースクリエイター無効コマースクリエイター有効コマースクリエイター運用中説明を表示 ▼

futureshop APIv2について

×

マニュアル閲覧上の注意

店舗の状態にあわせて、上のボタンからいずれかを選択してください。表示される項目が変更されます。

コマースクリエイター無効
以前からの管理画面で構築し、以前からのECサイト(ユーザー画面)で店舗を構築・運用されている場合(コマースクリエイターをご利用でない場合)はこちらを選択してください。
コマースクリエイター有効
以前からの管理画面で構築し、以前からのECサイト(ユーザー画面)で店舗を構築・運用しながら、コマースクリエイター管理画面が使用できる場合はこちらを選択してください。
コマースクリエイター運用中(切替後)
コマースクリエイター管理画面で構築し、コマースクリエイター専用ECサイト(ユーザー画面)で店舗を構築・運用されている場合(以前からのユーザー画面をご利用でない場合)はこちらを選択してください。

上記のボタンは再選択できます。店舗の状態がわからない方はコマースクリエイターご利用状況の確認方法についてをご覧ください。

目次

futureshop APIv2について

物流システム、および店舗様でご利用の基幹システムにて、出荷処理・受注処理を行えるよう、商品データや受注データを取得できる以下のAPIをご用意しています。

形式は、json形式です。
本ページにて、お申込み方法と共通仕様をご確認後、各APIの説明ページにて詳細をご覧ください。

  1. 在庫検索API
  2. 在庫更新API
  3. 受注検索API(発送・入金ステータス)
  4. 発送API

ご利用のお申込みと流れについて

※【FS】:フューチャーショップを指します。

  1. 【店舗様・開発者様】お申込みフォームより開発者登録
    お申込みフォーム内の利用規約を必ずご確認の上、お申し込みください。
    お申し込みいただいた後、2~3営業日で検証環境用のAPI接続情報をご案内いたします。
  2. 【FS】検証環境用API情報のお渡し
    検証はトライアル店舗にて行っていただきます。
    現在ご利用のない場合はトライアル店舗もあわせてお渡しいたします。
  3. 【店舗様/開発者様】検証環境で開発・検証
    トライアル店舗でお使いになりたいAPIをお試しください。
    検証環境用のAPIは公開しているすべてのAPIをお試しいただけます。
  4. 【店舗様/開発者様】稼働中店舗での利用申込み
    ご利用になる店舗様で利用するAPIをお申し込みください(futureshop管理画面)。
    お申し込みいただいた後、2~3営業日で本番環境用のAPI接続情報をご案内いたします。

    <お申し込み画面>
    [コマースクリエイター利用店舗様]:システム>申し込み・登録情報変更
    [コマースクリエイター未利用店舗様]:管理TOP>管理者設定>管理者一覧
  5. 【FS】本番環境用API情報のお渡し
    4でお申し込みいただいたAPIを利用できるAPI接続情報をご案内いたします。
  6. 【店舗様/開発者様】稼働中店舗での利用開始
    検証環境で試していただいたAPI接続情報を5でお渡ししたAPI接続情報に変更し、運用を開始してください。

futureshop APIv1(旧API/XML形式)も、ご利用の目的、用途により併用いただくことが可能です。

ただし、本マニュアル上のfutureshop APIv2(新API/json形式)とは仕様が異なります。
また、今後はfutureshop APIv2(新API/json形式)へ統一を進めてまいりますため、futureshop APIv1(旧API/XML形式)が廃止される可能性がございます。あらかじめご了承ください。

futureshop APIv1(旧API/XML形式)について
以下をご用意しております。ご利用の際にはPDFマニュアルをお渡しいたします。

  • 受注ステータス更新
  • 入金ステータス更新
  • 発送ステータス更新
  • 送り状番号更新
  • 在庫更新

新旧APIの機能について:futureshop APIv1/v2 機能比較表をご参照ください。

※「実店舗在庫更新」「入金ステータス更新」については、futureshop APIv1(旧API/XML形式)のみとなります。
※futureshop APIv1(旧API/XML形式)をご利用の際には、機密保持契約の締結が必要です。事前にお問い合わせください。

futureshop API の概要

本リファレンスは、、futrueshopシステム情報の一部を操作するための開発者用ドキュメントです。
本リファレンスの内容は予告なしに変更することがあります。

バージョン 更新日
version2.0 2020/10/17

はじめに

APIをご利用いただくにあたり、事前にクライアントID、およびクライアントシークレットの発行が必要です。
クライアントIDの発行には接続元IPとして固定IPをご用意いただく必要があります。

基本仕様

APIの呼び出しは1秒間に1回となります。
リクエスト、レスポンス共にJSON形式を用い、文字コードはUTF-8 となります。

共通リクエストヘッダー

ヘッダー名
X-SHOP-KEY 店舗キー

Authorizationヘッダー

アクセストークンをHTTPヘッダーに含む形で送信するため、GET/POST/PUTなど任意のHTTPメソッドでもリクエストが送信でき、アクセストークンとウェブAPI固有のパラメータ分離できるのが特徴です。
特別な理由がない限りAuthorizationヘッダーを使ったWeb APIリクエスト方式を推奨します。

用語 説明
用語について
店舗キー futureshopシステム契約時に付与される店舗毎に一意のキー
クライアントID 依頼により店舗毎に発行されるAPI用のID
クライアントシークレット 依頼により店舗毎に発行されるAPI用のパスワード
アクセストークン API実行時の認証キーとして用いられるパスワード(認証APIにて取得)

HTTPコード

API呼び出し時に問題がある場合は、HTTPコード、またはレスポンスにエラー原因を返します。
返される可能性があるHTTPコードは以下の通りです。

HTTPコード 説明
400 Bad Request店舗キーが設定されていない場合に返されます。
401 Unauthorized 認証APIにて取得するアクセストークンが無効、または有効期限が切れた場合に返されます。認証APIからアクセストークンを再取得してください。
403 Forbidden APIの操作権限が無い場合に返されます。
404 Not Found 指定されたリソースが見つからない場合に返されます。
405 405 Method Not Allowed 許可されていないHTTPメソッドからのリクエストの場合に返されます。
409 409 Unprocessable Entity リクエスト内容に問題があった場合に返されます。詳細はレスポンスをご確認下さい。
415 Unsupported Media Type Content-Typeにapplication/jsonが設定されていない場合に返されます。
422 Conflict リクエスト内容に矛盾が生じた場合に返されます。詳細はレスポンスをご確認下さい。
429 Too Many Requests 連続したリクエストを検知した場合に返されます。リクエストは1秒間に1回になるよう、ご調整下さい。
500 Internal Server Error 内部的な問題によってデータを返すことができない場合に返されます。
503 Service Temporarily Unavailable メンテナンス中の場合に返されます。

認証API

クライアントIDとクライアントシークレットにてログインする事でアクセストークンを取得します。
取得したアクセストークン用いて各種APIをご利用いただけます。
アクセストークンの有効期間は1時間です。

エンドポイント

https://{APIドメイン}/oauth/token

リクエスト

HTTPメソッド
POST
Authorizationヘッダー
basic認証:ユーザー名にクライアントID、パスワードにクライアントシークレットを設定する。
必須パラメータ
キー
grant_type client_credentials
レスポンス
キー 内容 説明
access_token アクセストークン 各種APIのAuthorizationに設定
token_type トークンタイプ
expires_in 有効時間 発行から1時間有効:返却値は秒数
{
    "access_token":"be85ae2a-e7f7-4ca3-b439-fbbbb55f854d",
    "token_type":"bearer",
    "expires_in":3600
}

サンプルコード(php)

<?php

$shopKey = '店舗キー';
$apiClient = 'クライアントID';
$apiSecret = 'クライアントシークレット';

$header = [
    "X-SHOP-KEY:{$shopKey}",
    'Authorization: Basic ' . base64_encode("{$apiClient}:{$apiSecret}")
];

$url = 'https://{APIドメイン}/oauth/token';
$param = array(
'grant_type' => 'client_credentials'
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_CUSTOMREQUEST,  'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER,     $header);
curl_setopt($ch, CURLOPT_URL,            $url);
curl_setopt($ch, CURLOPT_POST,           true);
curl_setopt($ch, CURLOPT_POSTFIELDS,     http_build_query($param));

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

サンプルコード(ruby)

require 'net/http'
require 'uri'
require 'openssl'

uri = URI.parse("https://{APIドメイン}/oauth/token")
request = Net::HTTP::Post.new(uri)
request.basic_auth("クライアントID", "クライアントシークレット")
request["X-SHOP-KEY"] = "店舗キー"
request.set_form_data(
  "grant_type" => "client_credentials",
)

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

アクセストークンによる認証

認証(/oauth/token)以外のAPIでは認証キーとして、/oauth/tokenにて取得したワンタイムパスワードを用います。

サンプルコード(php)

<?php
// 認証APIのaccess_tokenを設定
$accessToken = "###########";
$shopKey = '店舗キー';

$header = [
    "X-SHOP-KEY:{$shopKey}",
    'Authorization: Bearer ' . $accessToken
];
$url = 'https:// {APIドメイン} /admin-api/v1/inventory?types= regular ';

$ch = curl_init();
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

サンプルコード(ruby)

// 認証APIのaccess_tokenを設定
token = "####################"

uri = URI.parse("https:// {APIドメイン} /admin-api/v1/inventory?types= regular,planned")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer " + token
request["X-SHOP-KEY"] = "店舗キー"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

項目表示について

各項目は以前からのECサイト用・コマースクリエイター用・共通の3種類があります。コマースクリエイター有効(切替前)は両方の項目が表示されます。

以前からのECサイト用項目で、コマースクリエイターでは使用しません。(右側にこちらの色の点線が表示されます。)

コマースクリエイター専用ECサイト用の項目です。以前からのECサイトには影響しません。(右側にこちらの色の点線が表示されます。)

上記以外は共通で使用する項目です。(何も表示されません。)

×

店舗の状態にあわせて、下のボタンからいずれかを選択してください。

コマースクリエイター無効 コマースクリエイター有効 コマースクリエイター運用中
コマースクリエイター無効
以前からの管理画面で構築し、以前からのECサイト(ユーザー画面)で店舗を構築・運用されている場合(コマースクリエイターをご利用でない場合)はこちらを選択してください。
コマースクリエイター有効
以前からの管理画面で構築し、以前からのECサイト(ユーザー画面)で店舗を構築・運用しながら、コマースクリエイター管理画面が使用できる場合はこちらを選択してください。
コマースクリエイター運用中(切替後)
コマースクリエイター管理画面で構築し、コマースクリエイター専用ECサイト(ユーザー画面)で店舗を構築・運用されている場合(以前からのユーザー画面をご利用でない場合)はこちらを選択してください。

再度選択できますので、店舗の状態がわからない方はいったん「有効」をお選びください。
詳しくはコマースクリエイターご利用状況の確認方法についてをご覧ください。