メインコンテンツまでスキップ

はじめに

Ship&co APIは、国内外の複数運送会社に対応した送り状発行や貨物追跡などの機能を提供する、柔軟なソリューションです。
これにより、既存のシステムやアプリケーションに簡単に統合できます。
下記の図は、Ship&co APIの典型的なリクエストとレスポンスの流れを示しています。 Diagram

主な機能

複数運送会社配送対応

  • 国内配送: ヤマト運輸、佐川急便、日本郵便、西濃運輸
  • 海外配送: DHL、FedEx、UPS、日本郵便国際、ペガサスグローバルエクスプレス

出荷業務を支える中核機能

  • 複数運送会社の配送料金見積を取得
  • 各運送会社準拠のフォーマットで送り状を作成
  • 海外発送用のコマーシャルインボイスを自動生成
  • 追跡番号と配送状況を取得

アカウント・ユーザー管理

  • 組織内でサブユーザーを作成・管理
  • 運送会社アカウントを追加し、配送設定を構成
  • サブユーザー環境での一元管理

Ship&co APIトークンを取得する

Ship&co APIの利用を開始するには、Ship&coにアカウント登録し、認可セクションを参照してください。

仕組みについて

Ship&co APIは、RESTアーキテクチャに基づいたシンプルな認証とリクエストモデルを採用しています。

  1. 認証: Ship&coのダッシュボード【設定】ページで取得したAPIトークンを、HTTPヘッダーに付与してください （詳しくは認可セクションをご覧ください）。
  2. APIリクエスト: 適切なエンドポイントに対して、JSON形式のペイロードを含むHTTPリクエスト（GET/POST）を送信します。

リクエスト例

運送会社に対応したリクエストの具体例は、Postmanコレクションをご確認ください。

注意事項

APIのリクエストパラメーターやレスポンス形式は、選択した運送会社や配送サービスによって異なる場合があります。
実装時は、必ず各運送会社に関するドキュメントを参照してください。
ご不明な点があれば、お気軽にお問い合わせください。

認可

Ship&Co APIは、APIダッシュボードから発行できるAPIトークンをHTTPヘッダーに指定することで認可され、利用できます。 APIトークンの取得方法は以下です。
  1. Ship&Coダッシュボードにログインする
  2. 【設定】をクリックし、【Ship&co API token取得】のセクションに移動します。
Diagram 作成してコピーしたAPIトークンを、以下のようにHTTPヘッダーに追加すると、APIリクエストの認証ができます。

x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD

サブユーザーのAPIトークンを使ってユーザーごとのデータ管理も可能です。詳細はサブユーザーを参照してください。

※APIトークンを新しく作成した場合は、以前のトークンは無効となりそれを使ったAPIの呼び出しもエラーとなりますのでご注意ください。

リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}

呼び出し制限

x-api-call-limit文字列

APIの残りの呼び出し可能数/単位時間あたりの最大呼び出し可能数。

x-api-call-reset文字列

上記の残りの呼び出し可能数が最大呼び出し可能数にリセットされる日時。

ヘッダーのレスポンス例
1"X-Api-Call-Limit": "9/10"
2"X-Api-Call-Reset": "Fri Feb 14 2025 16:28:44 GMT+0900 (Japan Standard Time)"

出荷

出荷情報の作成

指定した荷受人住所や荷物、製品情報、運送会社の情報を元に配送ラベル付きの出荷情報を作成します。

テスト環境について： リクエスト内容のsetupに"test": trueを追加することで課金対象外のテストラベルを発行することができます。テストラベル発行にはクレジットカード登録は不要ですが、配送に使うこともできません。テストラベルはUPS、DHL、佐川急便、ヤマト運輸でのみ利用可能です。佐川急便とヤマト運輸は運送会社の登録も必要としません。
ヤマト運輸のテスト環境は、月曜日から金曜日の09:00～22:00（日本時間）にのみ利用可能です。土曜日、日曜日は利用できません。

ご注意： 出荷情報の作成や送料の取得に必要なリクエストパラメータならびに値は、運送会社によって異なります。特に、日本国内の運送会社（ヤマト運輸、佐川急便、日本郵便〈ゆうパック・ゆうパケット・ゆうメール〉、西濃運輸）と、海外配送の運送会社（FedEx、DHL、UPS、Pegasus、国際郵便）では必要項目が大きく異なるためご注意ください。

リクエスト

POST https://api.shipandco.com/v1/shipments


to_addressオブジェクト

荷受人住所です。
注：provinceはコードがある国の場合、名称ではなくコードで指定する必要があります。（例：アメリカのカリフォルニア州の場合CA）
※住所の最大長は運送会社やサービスで異なります。（例： DHLはaddress1とaddress2それぞれ45文字、合計90文字まで指定可能）

from_addressオブジェクト

発送人住所です。

parcels配列

荷物情報です。※国内の荷物情報はこのパラメータではなく、setupの荷物サイズと数量を使って指定してください。荷物サイズはwidth、height、depth（cm）の３つで指定するか、packageで運送会社規定のサイズを指定することができます。荷物の重さはweight（グラム）で指定できます。packageに指定可能な値は以下です。
FedEX:
"fedex_envelope", "fedex_pak", "fedex_box", "fedex_10kg_box", "fedex_25kg_box", "fedex_tube"
DHL:
"dhl_jumbo_doc", "dhl_jumbo_parcel", "dhl_document", "dhl_express_envelope", "dhl_jumbo_box", "dhl_jumbo_junior_box"

products配列

製品情報です。

customsオブジェクト

カスタム情報です。content_typeには以下の値を設定できます。 "GIFT", "NON_COMMERCIAL_DOCS", "SAMPLE", "MERCHANDISE", "PERSONAL", "RETURN", "REPAIR", "OTHER"
インコタームズは以下のように指定できます。 "duty_paid": true = "DDP", "duty_paid": false = "DDU"
"ioss_number": IOSS番号とEU圏への輸出について

setupオブジェクト

設定情報です。
詳細は運送会社とサービスを参照してください。
料金の一覧を利用して最適なserviceを探すこともできます。
※"test": trueを追加することで課金されないダミーのラベルを発行することができます。


➜ サンプルリクエストはPostmanで確認できます。

レスポンス

id文字列

出荷情報の一意のIDです。GETで利用できます。

delivery.carrier文字列

指定した運送会社の名称です。

delivery.tracking_numbers配列

出荷の追跡番号です。返送用ラベルも生成した場合は複数あります。

delivery.label文字列

作成されたラベルのイメージ情報です。返送用ラベルも生成した場合は複数ページ作成されます。

delivery.invoice文字列

Base64フォーマットでエンコードされた、PDF形式の出荷インボイス/納品書です。国際配送の場合のみ対応されている場合に含まれます。

delivery.carrier_invoice文字列

キャリアの請求書PDFへのリンク。国際配送の場合のみ対応されている場合に含まれます。

delivery.warnings配列

運送会社固有の警告がある場合表示されます。（例：DHL PLTで対象外になった場合。DHL PLTの警告が表示された場合はこちらの内容をご確認ください）

リクエスト
1{
2  "setup": {
3    "carrier_id": "3hoFeaK12ere8484s",
4    "service": "yamato_regular",
5    "ref_number": "照会番号。。。",
6    "pack_amount": 1,
7    "shipment_date": "2025-01-18",
8    "cool_options": "frozen"
9  },
10  "from_address": {
11    "full_name": "テスト 名前",
12    "company": "テスト Inc.",
13    "email": "test@gmail.com",
14    "phone": "08044523652",
15    "country": "JP",
16    "zip": "5670001",
17    "province": "大阪府",
18    "address1": "茨木市安威",
19    "address2": "2丁目1番15号",
20    "extra": "ビル西"
21  },
22  "to_address": {
23    "full_name": "西中島 太郎",
24    "company": "一般会社",
25    "email": "abcd@gmail.com",
26    "phone": "08044512365",
27    "country": "JP",
28    "zip": "3420038",
29    "province": "埼玉県",
30    "address1": "吉川市吉川市美南3-25-1ｲｵﾝ吉川美南東街区",
31    "address2": "ビルABCD",
32    "extra": "ドア84"
33  },
34  "products": [
35    {
36      "name": "商品1",
37      "price": 5000,
38      "quantity": 1
39    },
40    {
41      "name": "商品2",
42      "price": 3000,
43      "quantity": 2
44    },
45    {
46      "name": "商品3",
47      "price": 3250,
48      "quantity": 2
49    },
50    {
51      "name": "商品4",
52      "price": 1000,
53      "quantity": 5
54    }
55  ]
56}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "API-FMZZCG87OQ",
3  "state": "active",
4  "test": false,
5  "scope": "api",
6  "created_at": "2025-01-14T08:30:05.873Z",
7  "to_address": {
8    "full_name": "西中島 太郎",
9    "company": "一般会社",
10    "address1": "吉川市吉川市美南3-25-1ｲｵﾝ吉川美南東街区",
11    "address2": "ビルABCD",
12    "extra": "ドア84",
13    "province": "埼玉県",
14    "zip": "3420038",
15    "country": "JP",
16    "phone": "08044512365",
17    "email": "abcd@gmail.com"
18  },
19  "from_address": {
20    "full_name": "テスト 名前",
21    "company": "テスト Inc.",
22    "address1": "茨木市安威",
23    "address2": "2丁目1番15号",
24    "extra": "ビル西",
25    "province": "大阪府",
26    "zip": "5670001",
27    "country": "JP",
28    "phone": "08044523652",
29    "email": "test@gmail.com"
30  },
31  "products": [
32    {
33      "name": "商品1",
34      "quantity": 1,
35      "price": 5000
36    },
37    {
38      "name": "商品2",
39      "quantity": 2,
40      "price": 3000
41    },
42    {
43      "name": "商品3",
44      "quantity": 2,
45      "price": 3250
46    },
47    {
48      "name": "商品4",
49      "quantity": 5,
50      "price": 1000
51    }
52  ],
53  "setup": {
54    "insurance": 0,
55    "ref_number": "照会番号。。。",
56    "discount": 0,
57    "shipping_fee": 0,
58    "pack_amount": 1,
59    "cool_options": "frozen",
60    "care": {},
61    "pick_up": false
62  },
63  "delivery": {
64    "carrier": "yamato",
65    "method": "yamato_regular",
66    "tracking_numbers": ["438496228414"],
67    "label": "https://storage.googleapis.com/dev-shipandco/labels/202501/xxxx/yyyy.pdf"
68  }
69}

出荷情報の一覧


作成した出荷情報を一覧表示します。
このエンドポイントでは、直近2ヶ月以内に作成された配送情報のみを返します。2ヶ月以上前の配送は取得されません。

リクエスト

GET https://api.shipandco.com/v1/shipments

carrier文字列

運送会社のtypeを指定します。運送会社の一覧で取得できるもの

scope文字列

API経由で作成された出荷情報のみ (api)、またはAPIとアプリ双方にて作成された出荷情報 (all)、いずれかを指定します (初期値: api, 指定可能な値: api, all)

state文字列

初期値 active, 指定可能な値: active, void, any

レスポンス

作成した出荷情報の配列です。

ページネーション

ページネーションのパラメーターについては、ページネーションを参照してください。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "API-O8APFNW9S8",
3  "state": "active",
4  "scope": "api",
5  "created_at": "2019-01-07T14:15:01.151Z",
6  "to_address": {
7    "full_name": "John Doe",
8    "company": "John Doe Inc.",
9    "country": "FR",
10    "email": "john@doe.io",
11    "phone": "0601234567",
12    "address1": "32 Rue de Rivoli",
13    "address2": "Batiment A 4eme etage",
14    "city": "Paris",
15    "zip": "75001"
16  },
17  "from_address": {
18    "full_name": "Yamada Taro",
19    "company": "World Company",
20    "address1": "OSAKAFU",
21    "country": "JP",
22    "email": "ytaro@worldcompany.com",
23    "phone": "08012341234",
24    "address2": "OTECHO",
25    "city": "IBARAKI SHI",
26    "province": "OSAKA",
27    "zip": "5670883"
28  },
29  "products": [
30    {
31      "name": "Basket ball",
32      "quantity": 2,
33      "price": 4850,
34      "hs_code": "HS9988",
35      "origin_country": "JP"
36    }
37  ],
38  "parcels": [
39    {
40      "weight": 200,
41      "amount": 1,
42      "width": 10,
43      "height": 10,
44      "depth": 10
45    }
46  ],
47  "customs": {
48    "duty_paid": false,
49    "content_type": "MERCHANDISE"
50  },
51  "setup": {
52    "currency": "JPY",
53    "insurance": 0,
54    "ref_number": "REF123456",
55    "delivery_note": "Please leave at the front door if unattended.",
56    "discount": 0,
57    "return_label": false,
58    "signature": false
59  },
60  "delivery": {
61    "carrier": "japanpost",
62    "method": "japanpost_ems",
63    "tracking_numbers": ["EN027977320JP"],
64    "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/undefined.pdf"
65  }
66}

出荷情報の取得


出荷情報をIDで取得します。

リクエスト

GET https://api.shipandco.com/v1/shipments/:id

レスポンス

１つの出荷情報を返します。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "API-O8APFNW9S8",
3  "state": "active",
4  "scope": "api",
5  "created_at": "2019-01-07T14:15:01.151Z",
6  "to_address": {
7    "full_name": "John Doe",
8    "company": "John Doe Inc.",
9    "country": "FR",
10    "email": "john@doe.io",
11    "phone": "0601234567",
12    "address1": "32 Rue de Rivoli",
13    "address2": "Batiment A 4eme etage",
14    "city": "Paris",
15    "zip": "75001"
16  },
17  "from_address": {
18    "full_name": "Yamada Taro",
19    "company": "World Company",
20    "address1": "OSAKAFU",
21    "country": "JP",
22    "email": "ytaro@worldcompany.com",
23    "phone": "08012341234",
24    "address2": "OTECHO",
25    "city": "IBARAKI SHI",
26    "province": "OSAKA",
27    "zip": "5670883"
28  },
29  "products": [
30    {
31      "name": "Basket ball",
32      "quantity": 2,
33      "price": 4850,
34      "hs_code": "HS9988",
35      "origin_country": "JP"
36    }
37  ],
38  "parcels": [
39    {
40      "weight": 200,
41      "amount": 1,
42      "width": 10,
43      "height": 10,
44      "depth": 10
45    }
46  ],
47  "customs": {
48    "duty_paid": false,
49    "content_type": "MERCHANDISE"
50  },
51  "setup": {
52    "currency": "JPY",
53    "insurance": 0,
54    "ref_number": "REF123456",
55    "delivery_note": "Please leave at the front door if unattended.",
56    "discount": 0,
57    "return_label": false,
58    "signature": false
59  },
60  "delivery": {
61    "carrier": "japanpost",
62    "method": "japanpost_ems",
63    "tracking_numbers": ["EN027977320JP"],
64    "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/undefined.pdf"
65  }
66}

出荷情報の削除


出荷情報をIDで削除します。

リクエスト

DELETE https://api.shipandco.com/v1/shipments/:id

レスポンス

処理結果のメッセージが表示されます。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1"Shipment API-O8APFNW9S8 deleted."

料金

料金の一覧

作成する出荷情報を元に指定した運送会社のサービスごとの料金を一覧表示します。料金APIは出荷APIと共に利用されるように想定されています。料金APIのみ利用している場合は、アクセストークンが無効になる可能性がありますのでご注意ください。

リクエスト

POST https://api.shipandco.com/v1/rates


serviceを除いた出荷情報の作成と同じです。詳細は、出荷情報の作成を参照してください。

ご注意： 出荷情報の作成や送料の取得に必要なリクエストパラメータならびに値は、運送会社によって異なります。特に、日本国内の運送会社（ヤマト運輸、佐川急便、日本郵便〈ゆうパック・ゆうパケット・ゆうメール〉、西濃運輸）と、海外配送の運送会社（FedEx、DHL、UPS、Pegasus、国際郵便）では必要項目が大きく異なるためご注意ください。

各運送会社の具体的なリクエスト例は、以下のPostmanページをご参照ください。

➜ サンプルリクエストはPostmanで確認できます。

レスポンス

各サービスの料金の配列です。詳細は、運送会社とサービスを参照してください。

運送会社の詳細

• FedEx、DHL、UPS、ペガサス：レスポンスにて、契約料金を返します。
• 国際日本郵便：通常料金を返します。
• 佐川急便、ヤマト運輸、ゆうパック：通常料金を返します。これらの料金はregularサービス（クール便などのオプションなし）のみ対応します。

エラー

特定のキャリアでエラーが発生した場合、レスポンスには成功した料金に加えて、失敗したキャリアの詳細を含む errors 配列が返されます。配列内の各エラーオブジェクトには、対象の carrier 名と、そのエラー内容を示す message が含まれます。以下の例をご覧ください。 
1{
2  "rates": [
3    {
4      "carrier_id": "aZSzwKJDGP5KfdRid",
5      "carrier": "fedex",
6      "service": "fedex_international_first",
7      "currency": "JPY",
8      "price": 31235,
9      "surcharges": []
10    }
11  ],
12  "errors": [
13    {
14      "carrier": "ups",
15      "message": "Invalid destination address"
16    },
17    {
18      "carrier": "japanpost", 
19      "message": "Service not available for this destination"
20    }
21  ]
22}
リクエスト
1{
2  "setup": {
3    "currency": "JPY",
4    "ref_number": "123-REF-3456",
5    "signature": false
6  },
7  "to_address": {
8    "full_name": "John Doe",
9    "phone": "09000000",
10    "country": "FR",
11    "zip": "75002",
12    "city": "Paris",
13    "address1": "12 Rue du 2 juillet"
14  },
15  "from_address": {
16    "full_name": "Yamada Taro",
17    "company": "World Company",
18    "email": "ytaro@worldcompany.com",
19    "phone": "080000000",
20    "country": "JP",
21    "zip": "6050012",
22    "province": "KYOTO",
23    "city": "KYOTO",
24    "address1": "HIGASHIYAMA KU",
25    "address2": "SAIKAISHICHO"
26  },
27  "products": [
28    {
29      "name": "T-Shirt",
30      "quantity": 2,
31      "price": 25000,
32      "origin_country": "JP"
33    }
34  ],
35  "parcels": [
36    {
37      "weight": 2000,
38      "amount": 1,
39      "width": 10,
40      "height": 10,
41      "depth": 10
42    }
43  ],
44  "customs": {
45    "content_type": "MERCHANDISE"
46  }
47}
このリクエストは以下のようなレスポンスを返します。
1[
2  {
3    "carrier_id": "nznqM23wD3apjEJF6",
4    "carrier": "dhl",
5    "service": "dhl_express_0900",
6    "currency": "JPY",
7    "price": 10129,
8    "surcharges": [
9      {
10        "type": "9:00 PREMIUM",
11        "price": 5500
12      }
13    ]
14  },
15  {
16    "carrier_id": "nznqM23wD3apjEJF6",
17    "carrier": "dhl",
18    "service": "dhl_express_worldwide",
19    "currency": "JPY",
20    "price": 3021,
21    "surcharges": []
22  },
23  {
24    "carrier_id": "eMYDqTqiaR4Bdf4wW",
25    "carrier": "fedex",
26    "service": "fedex_international_first",
27    "currency": "JPY",
28    "price": 54954,
29    "surcharges": [
30      {
31        "type": "Demand Surcharge",
32        "price": 360
33      }
34    ]
35  },
36  {
37    "carrier_id": "eMYDqTqiaR4Bdf4wW",
38    "carrier": "fedex",
39    "service": "fedex_international_priority_express",
40    "currency": "JPY",
41    "price": 4116,
42    "surcharges": [
43      {
44        "type": "Demand Surcharge",
45        "price": 360
46      }
47    ]
48  },
49  {
50    "carrier_id": "FPTThBHJhDTA4CzPv",
51    "carrier": "japanpost",
52    "service": "japanpost_ems",
53    "currency": "JPY",
54    "price": 6700,
55    "surcharges": []
56  },
57  {
58    "carrier_id": "FPTThBHJhDTA4CzPv",
59    "carrier": "japanpost",
60    "service": "japanpost_smallpacket_air",
61    "currency": "JPY",
62    "price": 3930,
63    "surcharges": []
64  }
65]

契約料金

Ship&co APIを使用すると、ヤマト運輸、佐川急便、日本郵便ゆうパック向けの契約料金をアップロードおよび削除できます。これにより、運送会社と事前に契約した特別料金を持つ事業者が、自社の送料を入力・管理できるようになります。契約料金をアップロードしない場合、これらの運送会社の送料API(料金endpoint)を呼び出すと、一般公開（割引なし）の料金が返されます。

契約料金のアップロード

国内運送会社向けの契約料金をアップロードします。

リクエスト

POST https://api.shipandco.com/v1/carriers/:id/rates

from文字列

発送元の地域名

size数値

荷物のサイズ

priceオブジェクト

各地域の送料 { "toRegionName": "price" } の形式で指定

レスポンス

処理結果のメッセージが表示されます。

運送会社ごとの地域名の違い

契約料金を設定する際、運送会社ごとに使用する地域名（地方名）が異なります。以下は、各運送会社で正しく使用すべき地方名の一覧です。
  • ゆうパック（日本郵便）: 北海道, 東北, 関東, 信越, 北陸, 東海, 近畿, 中国, 四国, 九州, 沖縄
  • 佐川急便: 北海道, 北東北, 南東北, 関東, 信越, 東海, 北陸, 関西, 中国, 四国, 北九州, 南九州, 沖縄
  • ヤマト運輸: 北海道, 北東北, 南東北, 関東, 信越, 北陸, 中部, 関西, 中国, 四国, 九州, 沖縄
 各運送会社の仕様に従い、適切な地域名を使用して料金をアップロードしてください。 重要な注意点:
  • 契約料金のアップロード時には、運送会社指定の有効な地域名を使用する必要があります。
  • 冷凍・冷蔵便の料金設定は後日サポート予定です。
リクエスト 契約料金のアップロード
1[
2  {
3      "from": "北海道",
4      "size": 60,
5      "price": {
6          "南九州": "1,700",
7          "北九州": "1,700",
8          "四国": "1,600",
9          "関西": "1,500",
10          "中部": "1,400",
11          "北陸": "1,200",
12          "信越": "1,200",
13          "関東": "1,100",
14          "南東北": "1,100",
15          "北東北": "1,000",
16          "北海道": "700"
17      }
18  },
19  {
20      "from": "関東",
21      "size": 260,
22      "price": {
23          "南九州": "9,850",
24          "北九州": "9,800",
25          "四国": "8,800",
26          "関西": "8,000",
27          "中部": "8,000",
28          "北陸": "7,150",
29          "信越": "7,150",
30          "関東": "7,150",
31          "南東北": "7,150",
32          "北東北": "7,400",
33          "北海道": "9,950"
34      }
35    ]
36

契約料金の削除

既にアップロードされた契約料金を削除します。

リクエスト

DELETE https://api.shipandco.com/v1/carriers/:id/rates

レスポンス

処理結果のメッセージが表示されます。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}

運送会社

運送会社の登録

運送会社を登録します。詳細は、弊社サイトを参照してください。

リクエスト

POST https://api.shipandco.com/v1/carriers


type文字列

登録したい運送会社の種類。指定可能な値は japanpost、ups、fedex、dhl、sagawa、yamato、yuupack、yuupacket、yuumail、pegasus。

credentialsオブジェクト

運送会社のシステム利用に必要な認証情報です。内部のパラメータは各運送会社ごとに異なります。詳細は以下を参照ください。

settingsオブジェクト

運送会社の固有の設定です。内部のパラメータは各運送会社ごとに異なります。詳細は以下を参照ください。

➜ サンプルリクエストはPostmanで確認できます。

運送会社ごとの認証情報


DHL

DHLからsite_idとpasswordを入手する手順はこちらのサポートページからご確認ください。
site_id文字列必須
password文字列必須
account_number文字列必須
import_acc_number文字列
address.country文字列必須
address.zip文字列必須
address.address1文字列
address.address2文字列
address.city文字列
address.company文字列
address.email文字列
address.full_name文字列
address.phone文字列

UPS

access_key文字列必須
account_number文字列必須
password文字列必須
user_name文字列必須

FedEx

account_number文字列必須
address.address1文字列必須
address.address2文字列必須
address.city文字列必須
address.company文字列必須
address.country文字列必須
address.email文字列必須
address.full_name文字列必須
address.phone文字列必須
address.zip文字列必須
invoice_2faオブジェクト必須

API を使用して FedEx アカウントを登録する際に必須のフィールドです。このオブジェクトは、2FA（請求書番号による認証）のための請求書情報を提供します。標準の FedEx アカウント認証情報に加え、最新の請求書の詳細を以下の通り指定してください


日本郵便 海外

customer_numbers配列

配列、最小長： 4、最大長： 4、必須（例：['000000000','000000000','000000000','000000000']）


佐川急便

account_number文字列必須
key文字列必須
password文字列必須
佐川急便からkeyとpasswordを入手するにはShip&Coの運送会社の管理画面から申請を行ってください。5～8営業日で情報が送られ、アカウントは自動的に有効化されます。

日本郵便 国内（ゆうパック）

user_id文字列必須
日本郵便からuser_idを入手するにはこちらの申し込みフォームを埋めて日本郵便に提出する必要があります。5～8営業日で情報が送られます。

日本郵便 国内（ゆうパケット）

上記と同じです。

日本郵便 国内（ゆうメール）

上記と同じです。

ヤマト運輸

key文字列必須
freight_number文字列

初期値：'01'

ペガサス

user_id文字列必須
password文字列必須

運送会社ごとの設定


DHL

label.hide_account真偽値

ブーリアン型。ラベルにアカウント情報を表示するかどうか

label.extra_page真偽値

ブーリアン型。アーカイブ用のページを作成するかどうか

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_4X6", "PDF_4X8", "ZPL_4X6"


UPS

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_4X6", "ZPL_4X6"


FedEx

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_4X6", "PDF_4X8", "PDF_4X9", "ZPL_4X6", "ZPL_4X8"


日本郵便 海外

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_A4"


佐川急便

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_A5", "PDF_4.2X8.3_BLUE", "PDF_4.2X8.3_GREEN"


日本郵便 国内（ゆうパック）

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_A5", "PDF_YU_THERMAL"


日本郵便 国内（ゆうパケット）

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_A5", "PDF_YU_THERMAL"


日本郵便 国内（ゆうメール）

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_A5", "PDF_YU_THERMAL"


ヤマト運輸

print.size文字列必須

使用するラベルサイズ。指定可能な値: "PDF_A4", "PDF_A5", "PDF_A4_BW", "PDF_A5_BW", "PDF_4.5X7.8"

print.size_fallback文字列必須

使用するラベルサイズ。指定可能な値: "PDF_A4", "PDF_A5", "PDF_A4_BW", "PDF_A5_BW"



レスポンス

登録された運送会社の情報をIDと共に表示します。
リクエスト
1{
2  "type": "yamato",
3  "credentials": {
4    "key": "your_key",
5    "freight_number": "your_freight_number"
6  },
7  "settings": {
8    "print": {
9      "size": "PDF_A4"
10    }
11  }
12}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "a5PZ3428ku784W7gc",
3  "type": "yamato",
4  "state": "active",
5  "created_at": "2025-03-10T06:49:21.730Z",
6  "updated_at": "2025-03-10T06:49:21.730Z",
7  "credentials": {
8    "key": "*****",
9    "freight_number": "*****"
10  },
11  "settings": {
12    "print": {
13      "size": "PDF_A4"
14    }
15  }
16}

運送会社の一覧


登録されている運送会社の情報を一覧表示します。

リクエスト

GET https://api.shipandco.com/v1/carriers

レスポンス

登録されている運送会社の情報の配列です。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1[
2  {
3    "id": "GZDZQNo7zyxr4sbXc",
4    "type": "yuupacket",
5    "state": "active",
6    "created_at": "2019-01-07T14:24:13.045Z",
7    "updated_at": "2019-01-07T14:24:13.045Z",
8    "credentials": {
9      "user_id": "***********"
10    }
11  },
12  {
13    "id": "FbqDPqcBL6AL7PwAo",
14    "type": "yuupack",
15    "state": "active",
16    "created_at": "2019-01-07T14:24:13.042Z",
17    "updated_at": "2019-01-07T14:24:13.042Z",
18    "credentials": {
19      "user_id": "***********"
20    }
21  },
22  {
23    "id": "7iuaQaEp8fasKCzgD",
24    "type": "yamato",
25    "state": "active",
26    "created_at": "2019-01-07T14:06:13.197Z",
27    "updated_at": "2019-01-07T14:06:13.197Z",
28    "credentials": {
29      "key": "*********************************************************",
30      "freight_number": "**"
31    }
32  },
33  {
34    "id": "tbEuFScyfSQMx7bN8",
35    "type": "sagawa",
36    "state": "active",
37    "created_at": "2019-01-07T14:06:39.627Z",
38    "updated_at": "2019-01-07T14:08:45.817Z",
39    "credentials": {
40      "key": "********",
41      "password": "************************",
42      "account_number": "***********",
43      "account_key_number": ""
44    }
45  },
46  {
47    "id": "CFjQRubN5jhhT5hTb",
48    "type": "japanpost",
49    "state": "active",
50    "created_at": "2018-09-24T15:33:58.145Z",
51    "updated_at": "2018-09-24T15:33:58.145Z",
52    "credentials": {
53      "customer_numbers": "****"
54    }
55  }
56]

運送会社の更新


運送会社をIDで更新します。

リクエスト

PUT https://api.shipandco.com/v1/carriers/:id

settingsオブジェクト

運送会社のシステム利用に必要な認証情報です。内部のパラメータは各運送会社ごとに異なります。詳細は以下を参照ください。

レスポンス

更新された運送会社の情報が表示されます。
リクエスト
1{
2  "settings": {
3    "print": {
4      "size": "PDF_4.2X8.3_BLUE"
5    }
6  }
7}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "g3buDjYMCXaj6zNCv",
3  "type": "sagawa",
4  "state": "active",
5  "created_at": "2019-02-25T11:58:57.852Z",
6  "updated_at": "2019-02-25T11:58:57.852Z",
7  "credentials": {
8    "account_number": "*********",
9    "key": "*********",
10    "password": "*********"
11  }
12}

運送会社の削除


運送会社をIDで削除します。

リクエスト

DELETE https://api.shipandco.com/v1/carriers/:id

レスポンス

処理結果のメッセージが表示されます。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1"Carrier GZDZQNo7zyxr4sbXc deleted."

追跡情報

追跡情報の取得

追跡情報を運送会社と追跡番号を指定して取得します。 追跡機能は以下のキャリアに対応しています:
• 国際日本郵便
• ゆうパック、ゆうパケット
• ヤマト運輸
• 佐川急便
• UPS
• DHL

リクエスト

GET https://api.shipandco.com/v1/tracking/:carrier/:trackingNumber

レスポンス

運送会社の追跡情報です。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1{
2  "requested_at": "2019-05-22T14:52:35.155Z",
3  "carrier": "japanpost",
4  "tracking_number": "RN004792035JP",
5  "service": "Registered Mail / Insured Mail",
6  "from_address": {},
7  "to_address": {},
8  "current_status": {
9    "date": "2019-05-20T17:30:00.000Z",
10    "status": "Arrival at outward office of exchange",
11    "details": "",
12    "location": "OSAKA"
13  },
14  "history": [
15    {
16      "date": "2019-05-20T07:45:00.000Z",
17      "status": "Posting/Collection",
18      "details": "",
19      "location": "OSAKA"
20    },
21    {
22      "date": "2019-05-20T17:30:00.000Z",
23      "status": "Arrival at outward office of exchange",
24      "details": "",
25      "location": "OSAKA"
26    }
27  ]
28}

荷受人住所

荷受人住所の登録

リクエスト

POST https://api.shipandco.com/v1/addresses

登録する荷受人住所の情報です。詳細は、出荷情報の作成を参照してください。

レスポンス

登録された荷受人住所の情報をIDと共に表示します。
リクエスト
1{
2  "full_name": "Ship Co",
3  "company": "Ship&Co",
4  "email": "shipco@shipandco.com",
5  "phone": "0312345678",
6  "country": "JP",
7  "address1": "chukyo-ku",
8  "address2": "Building A",
9  "extra": "Suite 123",
10  "province": "Kyoto-fu",
11  "zip": "123-4567",
12  "city": "Kyoto-shi"
13}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "kr54qe8YPdc5HZSBu",
3  "created_at": "2019-01-12T09:04:43.619Z",
4  "updated_at": "2019-01-12T09:04:43.619Z",
5  "address": {
6    "full_name": "Ship Co",
7    "company": "Ship&Co",
8    "address1": "chukyo-ku",
9    "address2": "Building A",
10    "extra": "Suite 123",
11    "city": "Kyoto-shi",
12    "province": "Kyoto-fu",
13    "zip": "123-4567",
14    "country": "JP",
15    "phone": "0312345678",
16    "email": "shipco@shipandco.com"
17  }
18}

荷受人住所の一覧

登録されている荷受人住所の情報を一覧表示します。

リクエスト

GET https://api.shipandco.com/v1/addresses

レスポンス

登録されている荷受人住所の情報の配列です。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1[
2  {
3    "id": "dC32vpNEja8W7WNwR",
4    "created_at": "2019-01-12T08:32:55.411Z",
5    "updated_at": "2019-01-12T08:32:55.411Z",
6    "address": {
7      "full_name": "John Doe",
8      "company": "John Doe Inc.",
9      "country": "FR",
10      "email": "john@doe.io",
11      "phone": "0601234567",
12      "address1": "32 Rue de Rivoli",
13      "address2": "Batiment A 4eme etage",
14      "city": "Paris",
15      "zip": "75001"
16    }
17  },
18  {
19    "id": "kr54qe8YPdc5HZSBu",
20    "created_at": "2019-01-12T09:04:43.619Z",
21    "updated_at": "2019-01-12T09:04:43.619Z",
22    "address": {
23      "full_name": "Ship Co",
24      "company": "Ship&Co",
25      "address1": "chukyo-ku",
26      "address2": "Building A",
27      "extra": "Suite 123",
28      "city": "Kyoto-shi",
29      "province": "Kyoto-fu",
30      "zip": "123-4567",
31      "country": "JP",
32      "phone": "0312345678",
33      "email": "shipco@shipandco.com"
34    }
35  }
36]

倉庫

倉庫の登録

登録する荷送人情報です。

リクエスト

POST https://api.shipandco.com/v1/warehouses

レスポンス

登録された荷送人情報をIDと共に表示します。
リクエスト
1{
2  "full_name": "Taro Yamada",
3  "full_name_kanji": "山田太郎",
4  "company": "ACME",
5  "company_kanji": "株式会社ACME",
6  "email": "taro.yamada@example.com",
7  "phone": "090-1234-5678",
8  "country": "JP",
9  "address1": "HIGASHIYAMA KU",
10  "address2": "SAIKAISHICHO",
11  "province": "KYOTO",
12  "address1_kanji": "京都市東山区",
13  "address2_kanji": "西海子町",
14  "extra_kanji": "神宮道",
15  "province_kanji": "京都府",
16  "zip": "604-0012",
17  "city": "KYOTO SHI"
18}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "cki5wYEHddBZuEtPv",
3  "created_at": "2019-01-31T07:34:25.071Z",
4  "updated_at": "2019-01-31T07:34:25.071Z",
5  "address": {
6    "full_name": "Taro Yamada",
7    "company": "ACME",
8    "address1": "HIGASHIYAMA KU",
9    "address2": "SAIKAISHICHO",
10    "city": "KYOTO SHI",
11    "province": "KYOTO",
12    "zip": "604-0012",
13    "country": "JP",
14    "phone": "090-1234-5678",
15    "email": "taro.yamada@example.com",
16    "full_name_kanji": "山田太郎",
17    "company_kanji": "株式会社ACME",
18    "address1_kanji": "京都市東山区",
19    "address2_kanji": "西海子町",
20    "extra_kanji": "神宮道",
21    "province_kanji": "京都府"
22  }
23}

倉庫の一覧

登録されている荷送人情報を一覧表示します。

リクエスト

GET https://api.shipandco.com/v1/warehouses

レスポンス

登録されている荷送人情報の配列です。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1[
2  {
3    "id": "cki5wYEHddBZuEtPv",
4    "created_at": "2019-01-31T07:34:25.071Z",
5    "updated_at": "2019-01-31T07:34:25.071Z",
6    "address": {
7      "full_name": "Taro Yamada",
8      "company": "ACME",
9      "address1": "HIGASHIYAMA KU",
10      "address2": "SAIKAISHICHO",
11      "city": "KYOTO SHI",
12      "province": "KYOTO",
13      "zip": "604-0012",
14      "country": "JP",
15      "phone": "090-1234-5678",
16      "email": "taro.yamada@example.com",
17      "full_name_kanji": "山田太郎",
18      "company_kanji": "株式会社ACME",
19      "address1_kanji": "京都市東山区",
20      "address2_kanji": "西海子町",
21      "extra_kanji": "神宮道",
22      "province_kanji": "京都府"
23    }
24  },
25  {
26    "id": "phuAH6qFvoxdASoCr",
27    "created_at": "2019-01-31T07:37:46.332Z",
28    "updated_at": "2019-01-31T07:37:46.332Z",
29    "address": {
30      "full_name": "John Doe",
31      "company": "John Doe Inc.",
32      "country": "FR",
33      "email": "john@doe.io",
34      "phone": "0601234567",
35      "address1": "32 Rue de Rivoli",
36      "address2": "Batiment A 4eme etage",
37      "city": "Paris",
38      "zip": "75001"
39    }
40  }
41]

イメージファイル

ファイルのアップロード

このエンドポイントは、Ship&Coの設定にファイルをアップロードするために使用します。現在、DHLのペーパーレス請求書に必要となります。

リクエスト

POST https://api.shipandco.com/v1/files

file文字列

ファイルサイズは1MB以下にしてください。Base64フォーマットでエンコードされたJPEGまたはPNGに限ります。

type文字列

アップロードできるファイルの種類は以下の通りです：

  • "signature": 電子署名用の画像ファイル
  • "logo": ロゴ用の画像ファイル

レスポンス

file文字列

エンコードされたBase64ファイルです。

id文字列

ファイルのIDです。

type文字列

ファイルの種類です。

リクエスト
1{
2  "type": "logo",
3  "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAAAoCAMAAAA/pq9xAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyVpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDYuMC1jMDA2IDc5LjE2NDY0OCwgMjAyMS8wMS8xMi0xNTo1MjoyOSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIDIyLjIgKE1hY2ludG9zaCkiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MjMxNTMyODc2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MjMxNTMyODg2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoyMzE1MzI4NTY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoyMzE1MzI4NjY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PhUt+OUAAAAMUExURf38/C4pKv9WHreppVucDhcAAAHiSURBVHjatFfZtoQgDCvk//95pDvrwxxgPApcbUhaopfo2IBav4OetS94aw3mFUTNDQ9JMI/2e8oCz/RCJ9QbDA8OIfKiunKujcg9EHwtMEK5i3J1iYiw9WZx1aH1f3jCI8LeZDJiuFycdrzBSIm/VcCoGxRcNK56aHiPgWu1dYTAY4x/w2PuHyCAUprVtA7fzRcZfKd2IFuSd+Up7tqTdVldoKKtRWxnvsg0d7lxiAJHkaC2DkHayxZxOhA7l4SibMnPolNxbrvdwivm5ZBEdCYBAlvDAiTjudvOnw6mhVPgyIkJDJbXvAeJ7GPUSwTRR7mH4hwsumFZfk9MtF7XOVEQT8HIRCjO+g9M0us26xUogTEnnmcoannDZHJE54K0+JmJE42UbJkM75Bh6BmgzCHXt0Zr8MecYIGiQmMAyTnpJUI5V1eXiXHD2yafNuO40nKsLnSeeN7xWIAUNSreMpGbko0mvudqHhHcnGZbQQJh75L73McK9V3dJjBvT/npzW1l5St7GizZPAWiWTLKR//2+Cvw3tfcQQSjAbc8/slVBuRTVjrk9ggNpXeBzpKnQNCbYaDa0Xk7kCcNFIQjN8uhPuQkHNqQKeFlbOyY9KQkCkw0kxEwxDTnI12+r+EnwAA0EQvTI8JTUwAAAABJRU5ErkJggg=="
4}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "phuAH6qFvoxdASoCr",
3  "type": "logo",
4  "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAAAoCAMAAAA/pq9xAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyVpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDYuMC1jMDA2IDc5LjE2NDY0OCwgMjAyMS8wMS8xMi0xNTo1MjoyOSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIDIyLjIgKE1hY2ludG9zaCkiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MjMxNTMyODc2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MjMxNTMyODg2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoyMzE1MzI4NTY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoyMzE1MzI4NjY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PhUt+OUAAAAMUExURf38/C4pKv9WHreppVucDhcAAAHiSURBVHjatFfZtoQgDCvk//95pDvrwxxgPApcbUhaopfo2IBav4OetS94aw3mFUTNDQ9JMI/2e8oCz/RCJ9QbDA8OIfKiunKujcg9EHwtMEK5i3J1iYiw9WZx1aH1f3jCI8LeZDJiuFycdrzBSIm/VcCoGxRcNK56aHiPgWu1dYTAY4x/w2PuHyCAUprVtA7fzRcZfKd2IFuSd+Up7tqTdVldoKKtRWxnvsg0d7lxiAJHkaC2DkHayxZxOhA7l4SibMnPolNxbrvdwivm5ZBEdCYBAlvDAiTjudvOnw6mhVPgyIkJDJbXvAeJ7GPUSwTRR7mH4hwsumFZfk9MtF7XOVEQT8HIRCjO+g9M0us26xUogTEnnmcoannDZHJE54K0+JmJE42UbJkM75Bh6BmgzCHXt0Zr8MecYIGiQmMAyTnpJUI5V1eXiXHD2yafNuO40nKsLnSeeN7xWIAUNSreMpGbko0mvudqHhHcnGZbQQJh75L73McK9V3dJjBvT/npzW1l5St7GizZPAWiWTLKR//2+Cvw3tfcQQSjAbc8/slVBuRTVjrk9ggNpXeBzpKnQNCbYaDa0Xk7kCcNFIQjN8uhPuQkHNqQKeFlbOyY9KQkCkw0kxEwxDTnI12+r+EnwAA0EQvTI8JTUwAAAABJRU5ErkJggg=="
5}

ファイルのリストアップ

アップロード済みのファイルのリストを取得します。

リクエスト

GET https://api.shipandco.com/v1/files

レスポンス

アップロードされたファイルの配列です。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1[
2  {
3    "id": "cki5wYEHddBZuEtPv",
4    "type": "signature",
5    "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAAAoCAMAAAA/pq9xAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyVpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+"
6  },
7  {
8    "id": "phuAH6qFvoxdASoCr",
9    "type": "logo",
10    "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAAAoCAMAAAA/pq9xAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyVpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+"
11  }
12]

サブユーザー

サブユーザーはShip&Coのダッシュボードで作成された正規アカウントに所属し、各自のトークンを持ってAPIをコールし、データを分離して管理できます。サブユーザーのAPI自体は正規アカウントのトークンしか使えません（つまりサブユーザーはサブユーザーAPI自体は使えません）。

Diagram

サブユーザーの登録


サブユーザーを登録します。

リクエスト

POST https://api.shipandco.com/v1/sub-users

api_token真偽値

トークンを生成するかどうかです。

contactオブジェクト

first_name, last_name, full_name（任意）, company

email文字列

必須です。サブユーザーのキーとなります。


➜ サンプルリクエストはPostmanで確認できます。

レスポンス

登録されたサブユーザーの情報をIDとAPIトークンと共に表示します。生成されたAPIトークンは他のAPIに利用できます。
リクエスト
1{
2  "contact": {
3    "first_name": "John",
4    "last_name": "Doe",
5    "company": "ACME"
6  },
7  "email": "email@test.com",
8  "api_token": true
9}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "f1f97cfa813c828a73528989da671a81",
3  "created_at": "2019-02-25T11:12:14.021Z",
4  "email": "email@test.com",
5  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
6  "first_name": "John",
7  "last_name": "Doe",
8  "company": "ACME"
9}

サブユーザーの一覧


登録されているサブユーザーを一覧表示します。

リクエスト

GET https://api.shipandco.com/v1/sub-users


登録されているサブユーザー情報の配列です。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1[
2  {
3    "id": "f1f97cfa813c828a73528989da671a81",
4    "created_at": "2019-02-25T11:12:14.021Z",
5    "email": "email@test.com",
6    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
7    "first_name": "John",
8    "last_name": "Doe",
9    "company": "ACME"
10  },
11  {
12    "id": "929ab359ada3fa5c7bf53bff7ffcbe58",
13    "created_at": "2019-02-26T11:08:13.749Z",
14    "email": "email2@test.com",
15    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjUzam9qand4ejlQdWZzRXp4IiwiaWF0IjoxNTUxMTc5MjkzfQ.RLb2jWjwo9FZwP3MSyyDYkbQZMTtmjMvTYql-dfgk1o",
16    "first_name": "John 2",
17    "last_name": "Doe 2",
18    "company": "ACME 2"
19  }
20]

サブユーザーの取得


サブユーザーをIDで取得します。

リクエスト

GET https://api.shipandco.com/v1/sub-users/:id

レスポンス

一つのサブユーザーを返します。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1{
2  "id": "f1f97cfa813c828a73528989da671a81",
3  "created_at": "2019-02-25T11:12:14.021Z",
4  "email": "email@test.com",
5  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
6  "first_name": "John",
7  "last_name": "Doe",
8  "company": "ACME"
9}

サブユーザーの最新化


サブユーザーのAPIトークンを再生成します。

リクエスト

POST https://api.shipandco.com/v1/sub-users/:id


レスポンス

再生成されたAPIトークン
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1{
2  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMTc5OTgyfQ.sQChZ4DjIPyDbgOmJ2-jUgMe_xw9d52-TBGizg9lPjo"
3}

サブユーザーの削除


サブユーザーをIDで削除します。

リクエスト

DELETE https://api.shipandco.com/v1/sub-users/:id

レスポンス

処理結果のメッセージが表示されます。
リクエストヘッダー
1{
2  "x-access-token": "YOUR_API_TOKEN_FROM_DASHBOARD",
3  "Content-Type": "application/json"
4}
このリクエストは以下のようなレスポンスを返します。
1"Child user f1f97cfa813c828a73528989da671a81:email@test.com deleted."

共通定義

運送会社とサービス


運送会社値サービスの値海外
日本郵便 海外japanpostjapanpost_ems, japanpost_ems_document, japanpost_epacket_light, japanpost_smallpacket_registered_sal, japanpost_smallpacket_registered_air, japanpost_smallpacket_registered_sea, japanpost_smallpacket_sal, japanpost_smallpacket_air, japanpost_smallpacket_sea, japanpost_parcel_sal, japanpost_parcel_air, japanpost_parcel_sea, japanpost_printed_matter_sal, japanpost_printed_matter_air, japanpost_printed_matter_sea, japanpost_printed_matter_registered_sal, japanpost_printed_matter_registered_air, japanpost_letters_sal, japanpost_letters_air, japanpost_letters_sea, japanpost_letters_registered_sal, japanpost_letters_registered_air海外
日本郵便 国内（ゆうパック）yuupackyuupack_regular, yuupack_fresh, yuupack_frozen国内
日本郵便 国内（ゆうパケット）yuupacketyuupacket_regular国内
日本郵便 国内（ゆうメール）yuumailyuumail_regular国内
UPSupsups_saver, ups_worldwide_express, ups_worldwide_express_plus, ups_worldwide_expedited海外
DHLdhldhl_express_worldwide, dhl_express_1200, dhl_express_0900, dhl_express_jumbo海外
FedExfedexfedex_international_economy, fedex_international_first, fedex_international_priority, fedex_international_priority_express, fedex_international_priority_eod, fedex_international_connect_plus海外
佐川急便sagawasagawa_fresh, sagawa_frozen, sagawa_plane, sagawa_regular国内
ヤマト運輸yamatoyamato_regular, yamato_collect, yamato_direct_mail, yamato_time, yamato_freight_on_delivery, yamato_dispatch_multiple_units, yamato_nekopos, yamato_kuroneko_yuupacket, yamato_taqbin, yamato_taqbin_collect国内
ペガサスpegasuspegasus_dhl, pegasus_ups, pegasus_ems海外
カスタム便（運送会社のアカウント設定無しの配送や、追跡情報を使わないメール便などの配送に使用可）customcustom_standard国内

運送会社荷物サイズの値配達時間の値
佐川急便60, 80, 100, 140, 160not-specified, before-noon, 12-14, 14-16, 16-18, 18-20, 19-21, 18-21
日本郵便 国内（ゆうパック）60, 80, 100, 120, 140, 160, 170not-specified, before-noon, 12-14, 14-16, 16-18, 18-20, 19-21, 20-21
ヤマト運輸not-specified, before-noon, 14-16, 16-18, 18-20, 19-21, before-ten, before-five
carrier_id文字列

出荷情報を作成する際の運送会社アカウントのID。指定可能な値は、APIにて登録を完了された運送会社アカウントのID。同一の運送会社にて複数の有効なアカウントを使い分ける際に便利。 海外, 国内

carrier文字列

出荷情報に使う運送会社の種類。指定可能な値はjapanpost、ups、fedex、dhl、sagawa、yamato、yuupack、pegasus。 海外, 国内

service文字列

選択した運送会社のサービスの名称。上記リストの運送会社ごとの指定可能な値を参照。 海外, 国内

currency文字列

出荷情報のproductsの通貨。ISO 4217の値のみ有効。 海外, 国内

date文字列

配送日。 YYYY-MM-DD書式。例：2018-09-20 省略すると、空欄での反映 (＝原則、運送会社がお届けできる最短での取り扱い) または最短日となります。 海外, 国内

time文字列

運送会社依存の配達時間。yamato、sagawa、yuupackにのみ有効。上記リストを参照。 国内

shipment_date文字列

文字列。 出荷日。 YYYY-MM-DD書式。例：2018-09-18 省略すると未指定として処理されます。yamatoの場合必須です。 海外, 国内

insurance数値

出荷情報と同じ通貨での保険金額。japanpost、dhl、fedexにのみ有効。※無保険にする場合は0を指定。 海外

ref_number文字列

配送ラベルへの参照番号が必要な時に指定。 海外, 国内

delivery_note文字列

配送に関するメモが必要な場合に指定。 海外, 国内

signature真偽値

いくつかの運送会社の有料サービス。 海外

cool_options文字列

指定可能な値はregular、fresh、frozen。 国内

careオブジェクト

fragile: (boolean), side_up: (boolean), valuable_goods: (boolean), 国内

pack_size数値

運送会社依存の荷物サイズ。上記リストを参照。 国内

pack_amount数値

数値。 荷物の数量。 国内

cash_on_deliveryオブジェクト

代引きの金額の合計と税を指定。 amount: (integer), tax: (integer), 国内

return_label真偽値

ブーリアン型。 返送用ラベルの同時発行。サポートしている運送会社（例：DHL）の場合にtrueを設定すると返送用ラベルのページも生成され追跡番号も複数できる。 海外, 国内

print_start_location数値

数値。 A4ラベルの印刷開始ページ。yuupacket_regular、yuumail_regular、yamato_direct_mail、yamato_nekopos、yamato_kuroneko_yuupacketにのみ有効。 国内

shipping_fee数値

数値。 配送料金。PDF形式の出荷インボイス/納品書に反映されます。 海外

security_service真偽値

ブーリアン型。trueまたはfalse。yuupack_regular にのみ有効。 国内

consignee_tax_id文字列

文字列。国際注文における受取人または輸入者のTax ID（例: VAT ID、EORI）を指定します。対応キャリアは、国際日本郵便、Pegasus、UPS、DHL、FedExです。 海外

discount数値

数値。各商品の価格に適用される割引率（パーセンテージ）。例：商品のpriceが5000で discount が10 の場合、最終価格は4500となります。 海外

これらのパラメータおよびレスポンス項目は、リソース一覧を取得する際に、大量のデータをページネーションするために使用されます。
これらは 出荷情報の一覧 エンドポイントでのみ使用されます

リクエストパラメータ

created_after文字列

書式 2018-09-20T00:00:00.000Z

created_before文字列

初期値 today 書式 2018-09-20T00:00:00.000Z

limit数値

初期値 50, 最大値 250

page数値

初期値 1

レスポンスパラメータ

count数値

データ数

current_page数値

レスポンスの現在ページ（リクエストパラメータで指定可能）

pages数値

レスポンスのページ数（リクエストパラメータで指定可能）

エラー

エラーコード


Ship&Co APIには以下のエラーコードがあります。
正常時には200を返します。
400

不正な入力または入力不足によるエラー

403

APIトークンが未指定か間違っています

404

指定されたデータが見つかりません

429

リクエスト数が多すぎます（詳細は呼び出し制限を参照してください)

500

内部エラー

エラーレスポンス


Ship&Co APIは以下のようなエラーレスポンスを返します。
debug_id文字列

各APIのコール毎に一意のIDでShip&Coと連絡を取るために使います

description文字列

エラーの長い説明です

details文字列

各項目毎のエラー詳細です

link文字列

エラー情報へのリンクです

message文字列

エラーの短い説明です

1{
2  "debug_id": "err_8953pxowmMt3YW2XQ",
3  "message": "INVALID",
4  "description": "Request is not well-formed, syntactically incorrect, or violates schema.",
5  "link": "https://developer.shipandco.com",
6  "details": [
7    {
8      "field": "address1",
9      "issue": "address1 is required"
10    },
11    {
12      "field": "country",
13      "issue": "country is required"
14    }
15  ]
16}