1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Ship&co APIのサブユーザー機能で複数拠点・複数店舗の出荷を一元管理する

1
Posted at

はじめに:こんな課題はありませんか?

全国に複数の店舗・倉庫を持つEC企業が、各拠点からの出荷をAPIで管理しようとすると、こんな問題が生じます。

  • 拠点ごとに異なるヤマト運輸・佐川急便の契約アカウントを持っている
  • 各拠点のシステムに出荷機能を組み込みたいが、メインのAPIトークンを全拠点に配布するのはセキュリティ上問題がある
  • 請求は本社で一括管理したい
  • 各拠点の出荷数・出荷履歴を独立して管理したい

Ship&coのサブユーザーAPIは、これらの課題をまとめて解決します。

📖 公式APIドキュメント:https://developer.shipandco.com
🧪 Postmanコレクション:https://postman.shipandco.com


ユースケース:全国50店舗の中古品ECチェーン

具体的なケースで説明します。

ある中古家電ECチェーンが全国に50店舗を展開しています。各店舗は販売拠点でありながら、オンラインストアで売れた商品の発送拠点でもあります。顧客はiPhoneを購入する際、「秋葉原店から発送」「梅田店から発送」といった形で発送元を選択できます。

構成のポイント:

  • 各店舗は独自のヤマト運輸B2契約アカウントを持つ
  • 各店舗の受注管理システムにShip&co APIが組み込まれている
  • 請求はすべて本社(メインアカウント)に一括集約
  • 各店舗のスタッフはShip&coのWebアプリにはアクセスしない(API経由のみ)

この構成を実現するのが、Ship&coのサブユーザー機能です。


サブユーザーとは

サブユーザーは、メインアカウント配下に作成するAPIオンリーのアカウントです。

項目 メインアカウント サブユーザー
Webアプリ(GUI)アクセス ✅ あり ❌ なし(APIのみ)
独自APIトークン
独自の運送会社アカウント登録
Ship&coの費用 メインに請求 メインアカウントに集約
送り状発行件数の独立管理
作成・管理 メインアカウントのみ可能

上限:1メインアカウントにつき最大500サブユーザーまで作成可能。


APIエンドポイント一覧

ベースURL:https://api.shipandco.com/v1

メソッド エンドポイント 説明
POST /sub-users サブユーザーを新規作成
GET /sub-users サブユーザー一覧を取得
GET /sub-users/:id 特定のサブユーザー情報を取得
POST /sub-users/:id サブユーザーのAPIトークンを再発行
DELETE /sub-users/:id サブユーザーを削除

:id はサブユーザーのメールアドレス(小文字)をMD5ハッシュ化したものです。


サブユーザーの作成

curl -X POST https://api.shipandco.com/v1/sub-users \
  -H "x-access-token: YOUR_MAIN_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "akihabara-store@example.com",
    "api_token": true,
    "contact": {
      "full_name": "秋葉原店 出荷担当",
      "company": "株式会社テック中古 秋葉原店"
    },
    "language": "ja"
  }'

リクエストパラメータ:

フィールド 必須 説明
email string サブユーザーのメールアドレス
api_token boolean true にするとサブユーザー作成と同時にAPIトークンを発行
contact.full_name string 担当者名
contact.company string 店舗・会社名

レスポンス例:

{
  "id": "d41d8cd98f00b204e9800998ecfxxxx",
  "created_at": "2026-03-10T10:30:00Z",
  "email": "akihabara-store@example.com",
  "token": "abc123...",
  "full_name": "秋葉原店 出荷担当",
  "company": "株式会社テック中古 秋葉原店",
  "shipments": {
    "total": 0,
    "current_period": 0
  }
}
  • token:このサブユーザー専用のAPIトークン。各店舗システムに設定する。
  • shipments.total:送り状の累計発行件数
  • shipments.current_period:当請求期間内の送り状の発行件数

サブユーザーによるラベル発行

作成されたサブユーザーは、メインアカウントとまったく同じ出荷APIエンドポイントを使って送り状を作成できます。

各サブユーザーは独自の運送会社アカウント(例:秋葉原店のヤマト運輸B2契約)をダッシュボードに登録し、そのアカウントを使って出荷します。

# サブユーザー(秋葉原店)のトークンでラベルを発行
curl -X POST https://api.shipandco.com/v1/shipments \
  -H "x-access-token: AKIHABARA_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "setup": {
      "carrier": "yamato",
      "service": "yamato_regular",
      "shipment_date": "2026-03-10"
    },
    "from_address": {
      "full_name": "秋葉原店",
      "company": "株式会社テック中古",
      "phone": "031230000000",
      "country": "JP",
      "zip": "1010021",
      "province": "東京都",
      "address1": "千代田区外神田1-1-1"
    },
    "to_address": {
      "full_name": "田中 花子",
      "phone": "0907000000",
      "country": "JP",
      "zip": "5300001",
      "province": "大阪府",
      "address1": "大阪市北区梅田1-1"
    },
    "products": [
      { "name": "iPhone 13 (中古)", "price": 58000, "quantity": 1 }
    ]
  }'

APIトークンの再発行・サブユーザーの削除

トークン再発行

サブユーザーのAPIトークンは、メインアカウントのみが再発行できます。

curl -X POST https://api.shipandco.com/v1/sub-users/SUB_USER_ID \
  -H "x-access-token: YOUR_MAIN_API_TOKEN"

サブユーザーの削除

curl -X DELETE https://api.shipandco.com/v1/sub-users/SUB_USER_ID \
  -H "x-access-token: YOUR_MAIN_API_TOKEN"

削除はソフトデリートです。サブユーザーは無効化されAPIトークンも失効しますが、レコードは保持されます。削除後は同じメールアドレスで新規サブユーザーを作成することができます。


よくある質問

Q. サブユーザーはShip&coのWebアプリにログインできますか?
いいえ。サブユーザーはAPIアクセス専用です。Webアプリ(GUI)へのログインはできません。また、Ship&coからサブユーザー宛に連絡がいくこともありません。

Q. サブユーザーごとに異なる運送会社アカウントを使えますか?
はい。各サブユーザーは独自の運送会社アカウントを登録できます。たとえば秋葉原店と梅田店がそれぞれ別のヤマト運輸B2契約を持っていても、それぞれのサブユーザーに個別に設定できます。

Q. Ship&coからの請求はどのように管理されますか?
Ship&coの利用料はメインアカウントに集約して請求されます。各サブユーザーが何件発行したかはAPIレスポンスの shipments.current_period で確認できます。

Q. サブユーザーは何アカウントまで作れますか?
1メインアカウントにつき最大500サブユーザーまで作成できます。

Q. 3PL(物流代行)業者や外部パートナーにも使えますか?
はい。3PLパートナーや倉庫業者それぞれにサブユーザーを発行することで、メインの認証情報を共有せずにAPI権限を委譲できます。


サブユーザー機能:まとめ

ポイント 内容
最大サブユーザー数 500(1メインアカウントあたり)
アクセス方法 APIのみ(Webアプリ不可)
運送会社アカウント サブユーザーごとに独立して設定可能
Ship&coからの請求 メインアカウントに一括集約
トークン管理 メインアカウントのみ発行・再発行可能

複数拠点・複数ブランド・3PLパートナーとの連携など、規模の大きな出荷運用に特に有効な機能です。


Ship&co APIを試してみる
→ アカウント登録(30日間無料トライアル):https://app.shipandco.com/join
→ APIドキュメント:https://developer.shipandco.com
→ Postmanコレクション:https://postman.shipandco.com
→ ユースケース紹介:https://www.shipandco.com/ja/api#cases

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?