Ship&co APIのご利用

Ship&co APIは、RESTの原則に基づいて設計されたAPIです。全てのShip&coユーザー様にご利用いただけます。

当社のREST APIには、送り状作成機能、送料確認機能、追跡機能など含まれています。既に独自の管理システムをお持ちのEC関連企業様や倉庫業者様には、Ship&co APIをご利用いただく事で、Ship&coの管理画面にアクセスする必要がなく、既存のシステムにShip&coの機能を組み込んでご利用いただけます。ホームページでは、Ship&coのAPI仕様書を公開しています。API仕様書はこちら。
 

Ship&co APIを設定する

Ship&co APIを使用するには、次の手順をお進みください。

1. Ship&coアカウントを作成
   APIのご利用には、Ship&coのアカウント登録が必要となります。アカウント登録はこちら。
2. Ship&coの管理画面でAPIトークンを取得
   こちらをご参照のうえShip&coダッシュボードの「API」画面で「APIトークン」を取得し、HTTPヘッダーに設定することで、アカウントを認証し、APIを使用できるようになります。
   ご注意：1つのShip&coユーザーアカウントにつき1つのAPIトークンしか同時取得できません。APIトークンを更新した場合は、以前のトークンは無効となりそれを使ったAPIの呼び出しもエラーとなりますのでご注意ください。
3. APIコール/APIコールのテストを実施
   API仕様書とサンプルコードを利用し、簡単にAPIコールを実行できます。

Ship&co APIを使用する前に、次の詳細を必ず確認してください

• Ship&co APIは、複数の運送会社システム (API) と連携しています。送り状作成のリクエストを実行する際、常に正確な発送元と荷受人住所が必要です。テストの場合でも、有効な住所情報をご利用ください。
• APIサービスのご利用料金は、Ship&coアプリのご利用と同じ料金体系です。Ship&coの料金について詳細はこちら。
• アカウントのご登録後、まず30日間の無料トライアルが開始されます。無料トライアルが終了した後、引き続きサービスをご利用いただく場合はShip&co管理画面の「プロフィール」画面にてサブスクリプションの登録が必須となります。
   

Ship&co APIのテスト環境を利用する

Ship&co APIでテストコールを行う場合、リクエスト内に"test": trueを追加することで、テスト用の送り状を無料で作成できます。テスト環境では、実際に出荷には利用できないダミーのラベルが発行され、Ship&coの課金対象外となります。

ご注意：テストラベルは現在、UPS、DHL、佐川急便、ヤマト運輸のみ利用可能です。佐川急便とヤマト運輸は、契約アカウントの登録も不要です。テスト環境のご案内はこちら。
 

サブユーザー機能を使う

Ship&co APIには、サブユーザー機能を使って、データを分離して管理する事ができます。サブユーザーは、Ship&co管理画面で作成されたアカウントに所属し、各自のトークンを持ってAPIをコールし、データを分離して管理できます。全く同じ動きをするトークンを複数持つことはできません。また、サブユーザーのAPI自体は正規アカウントのトークンしか使えません（サブユーザーは、自身でサブユーザーAPIをコールする事ができません）。
 

APIの問題に関するサポート体制

エラーメッセージや問題が発生した場合、Ship&coかスタマサポートチームがサポートします。APIコールをテストして正常に機能するかどうかを確認し、エラーの原因となる誤った情報や不足している情報を特定するお手伝いをいたします。APIコールに関する問題が発生してサポートが必要な場合は、どうぞお気軽にサポートセンターまでお問い合わせください。お問い合わせの際、最適なサポートを提供するために以下の情報を含めるようにしてください。

• 実行しようとしたAPIアクション
• APIコールの全コード（リクエストとレスポンスを含む）

ご利用量の多い（10,000件/月 以上）事業者様には、ご利用実績に応じて料金のご相談に応じます。ご不明点は、hello@shipandco.comまでお問い合わせください。