SC-API（外部システム連携用API）

SC-APIは、お客様が利用している外部システムから、SCシステムの商品・入荷・受注・在庫の情報を登録・取得するためのAPIです。
受注管理システム（OMS）や自社開発のシステムと、SCシステムをつなぐときに使います。
ECサイト（モール・カート）とのAPI連携とは仕組みが異なるため、利用を始める前に違いと準備をご確認ください。

SC-APIの仕組み

モール・カートとのAPI連携との違い

SC-APIでは、外部システムからSCシステムへ情報を送ります。
SCシステムからモール・カートへ情報を取りに行くAPI連携とは、連携の方向が逆になります。

項目	モール・カートとのAPI連携	SC-API
連携の方向	SCシステムがモール・カートへ情報を取りに行く	外部システムがSCシステムへ情報を送る・取りに来る
設定する場所	SCシステムの店舗設定	外部システム側（SCシステムではAPIキーを受け取るだけ）
必要な情報	モール・カート側で発行した認証情報	STOCKCREWが発行するAPIキーと会社コード
エラーの確認場所	SCシステムの「API連携エラーログ」	外部システム側（APIの応答で返る）

SC-APIでできること・できないこと

SC-APIでは、次の情報を登録・取得できます。

商品の登録
入荷予定の登録
受注の登録
納品指示（BtoB）の登録
在庫・入荷実績・出荷実績の取得

次の操作は、SC-APIでは行えません。

外装ラベルの作成（SCシステムから出力してください）
モール・カートへの商品連携

利用の流れ

SC-APIに対応したサービスを経由して利用する場合

GoQSystemやクロスマなど、SC-APIに対応済みのサービスを利用する場合です。
APIキーを依頼し、連携先のサービスに設定すると利用できます。
連携先サービスでの設定手順は、各サービスのマニュアルをご確認ください。

自社開発のシステムから利用する場合

お客様が自社で開発したシステムを、SCシステムに直接つなぐ場合です。
APIキーの発行後に、APIの仕様書（APIドキュメント）をご案内します。
開発会社などに開発を委託する場合は、お客様の責任でAPIキーを管理し、共有する情報は必要最小限にしてください。

利用前の準備

APIキーの発行には、「サービス利用約款」の「API利用規約」への同意が必要です。
内容をご確認のうえ、依頼してください。

1. SCシステムにサインインできるアカウントを用意する

APIキーは、SCシステムのアカウントに紐づけて発行します。
SCシステムにサインインできるアカウントが、最低1件必要です。

2. マスタを設定する

SC-APIで受注を登録するときは、配送方法・支払方法・配送時間帯を、SCシステムのコードで指定します。
事前にSCシステムで各マスタを設定してください。
設定の内容は「【重要】ECサイト・モールとの連携設定をする前に」をご確認ください。

3. 店舗を登録する

SC-APIで受注を登録するときは、店舗コードの指定が必要です。
[店舗設定] の [店舗登録] で、SC-APIで使う店舗を登録してください。
対応サービスを経由する場合は、[プラットフォーム] で連携先のサービス名（例：GoQSystem、クロスマ）を選択します。
登録手順は「店舗登録」をご確認ください。

4. APIキーを依頼する

カスタマーポータルから、APIキーの発行を依頼してください。
依頼時には、次の内容をお知らせください。

会社コードと会社名
連携先のサービス名（自社開発の場合は「自社開発」）
必要な環境（本番環境／検証環境）

発行後、担当者からAPIキーをご連絡します。

APIキーと会社コード

APIキー

APIキーは、1社につき1つ発行します。
GoQSystemとクロスマのように連携先が複数ある場合も、同じAPIキーを共用します。
APIキーに有効期限はありません。
再発行や再設定をしない限り、同じAPIキーを使い続けられます。

※ APIキーは第三者に共有しないでください。
※ APIキーが不要になった場合や、漏えいした可能性がある場合は、カスタマーポータルからご連絡ください。

会社コードと店舗コード

SC-APIでは、会社コードと店舗コードの2種類のコードを使います。
会社コードは、SCシステム開設時にお客様の会社ごとに割り当てた6桁のコードです。
店舗コードは、SCシステムに登録した店舗ごとのコードです。

受注を登録するときの店舗コードには、会社コードではなく店舗コードを指定してください。
店舗コードは、[店舗設定] の [店舗一覧] で確認できます。
詳しくは「店舗一覧」をご確認ください。

検証環境

検証環境を使う場面

検証環境は、本番のデータに影響を与えずにSC-APIの動作を試すための環境です。
自社開発のシステムで、登録・更新・削除の処理を試す場合におすすめします。
SC-APIに対応したサービスを経由する場合は、本番環境のAPIキーだけで利用できます。

検証環境の準備

検証環境のAPIキーは、本番環境とは別に発行します。
カスタマーポータルから、検証環境のAPIキーを依頼してください。
あわせて、検証環境のSCシステムのアカウントを新規登録していただきます。
登録先のURLは、依頼後に担当者からご案内します。

※ 本番環境のAPIキーは、検証環境では使えません。接続先とAPIキーの組み合わせをご確認ください。
※ 検証環境のアカウントは、本番環境とは別です。本番環境と同じパスワードではサインインできません。
※ 入荷実績・出荷実績は、倉庫での作業によって作られます。検証環境で実績データが必要な場合は、カスタマーポータルからご相談ください。

注意点

エラーの確認方法

SC-APIでエラーが発生すると、APIの応答としてエラーの内容が返ります。
SCシステムの「API連携エラーログ」には表示されません。
対応サービスを経由する場合は、連携先サービスの画面でエラーを確認してください。
自社開発の場合は、APIの応答を確認してエラーを検知する仕組みをご用意ください。

リクエスト数の上限

SC-APIには、一定時間あたりのリクエスト数に上限があります。
上限の詳細は、APIドキュメントをご確認ください。

利用条件

SC-APIの利用条件は、「サービス利用約款」の「API利用規約」をご確認ください。
APIキーの管理方法や、検証環境の利用目的なども定めています。

置き配（配送指定場所）の指定

指定する項目

受注の登録・更新時に、配送指定場所コード（deliveryHandoverLocationCode）を指定すると、置き配の配送指定場所を登録できます。
対象は、新規受注登録・新規受注一括登録・受注更新です。
登録した配送指定場所コードは、出荷予定取得で確認できます。

コード	配送指定場所
10	対面
11	玄関前
12	宅配ボックス
13	ガスメーターボックス
14	物置
15	車庫
16	自転車かご
17	建物内受付／管理人預け

指定できる配送方法

配送方法コード	配送方法	配送指定場所コード
1010	ヤマト運輸宅急便EAZY(ソフト)	必須
1011	ヤマト運輸宅急便EAZY(ハード)	必須
2001	佐川急便飛脚宅配便	任意
9001	おまかせ便（ソフト）	任意
9002	おまかせ便（ハード）	任意
9003	おまかせ便（ケース出荷）	任意

上記以外の配送方法では、配送指定場所コードを指定できません。
佐川急便とおまかせ便では、指定しない場合は従来どおりの配送として受け付けます。
おまかせ便は、受注登録時点では指定した配送方法コード（9001〜9003）のまま登録され、配送会社の確定時にヤマト運輸なら宅急便EAZY（1010／1011）、佐川急便なら飛脚宅配便（2001）になります。

受注更新時の取り扱い

配送指定場所コードを省略した場合は、現在の配送指定場所コードを維持します。
佐川急便とおまかせ便では、空文字を指定すると配送指定場所の指定を解除できます。
宅急便EAZY（ソフト／ハード）は配送指定場所の指定が必須のため、解除できません。
配送方法を変更する場合は、現在の配送指定場所コードが変更先の配送方法で利用できるかをご確認ください。

注文者メールアドレスなどの利用条件は「置き配（配送指定場所）の利用条件」をご確認ください。
条件を満たさない場合は、APIの応答でエラーが返ります。