概要

Ship&Co APIへようこそ！

APIを使うことで以下のようなことが実現できます。

送り状の発行や運送会社の切り替えを自動化し、大量発送に素早く対応できます。
倉庫や配送先住所の登録や参照をシステム連携し、運用コストを削減できます。
サブユーザーを管理して出荷システムのマーケットプレイスやパートナーのような事業を行えます。

このドキュメントではShip&CoのAPIの使い方について説明します。APIをご利用になる前にこちらからShip&Coのアカウントを登録してください。

このドキュメントの想定読者

ヘッダーやメソッドの操作を含むHTTP通信仕様を理解されている方
サーバーサイドプログラミングとJSONの処理の経験がある方

APIの処理概要

Diagram

Ship&CoのAPIはRESTの規約に基づいており、使い方はとても簡単です。

認可 - ダッシュボードから取得したShip&CoのトークンをHTTPヘッダーに挿入します。
各APIの呼び出し - 各APIのエンドポイントに決められたHTTPメソッドとGETパラメータ、もしくはJSONのPOSTボディでアクセスします。

Postmanでサンプルコードを試す (`Language`で各プログラミング言語を選べます)

QiitaのShip&Coタグをフォローすると便利なTIPSを得られます

免責事項

APIの指定できるパラメータや返されるレスポンスは運送会社やサービスの選択によって変わります。右側のサンプルは特定の運送会社用の完全なリクエストではなく、参考用に運送会社の選択と関係なく全ての項目を表示しています。

認可

curl "EACH_API_END_POINT" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

Ship&Co APIは、APIダッシュボードから発行できるAPIトークンをHTTPヘッダーに指定することで認可され、利用できます。

APIトークンの取得方法は以下です。

Ship&Coダッシュボードにログインする
[設定]メニューをクリックし、[API Settings]の[Token]に表示されているテキストをコピーする

Dashboard

コピーしたAPIトークンを以下のようにHTTPヘッダーに追加することでAPIを利用することができます。

x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD

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

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

出荷

出荷情報の作成

curl -v -X POST "https://api.shipandco.com/v1/shipments" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json" \
  -d '{
  "to_address": {
    "full_name": "John Doe",
    "company": "ACME",
    "address1": "Rua Maria Matos, 32",
    "country": "PT",
    "email": "john@doe.io",
    "phone": "0901231234",
    "address2": "",
    "city": "CHARNECA DA CAPARICA",
    "province": "SETUBAL",
    "zip": "2820-344"
  },
  "from_address": {
    "full_name": "テスト",
    "company": "",
    "email": "",
    "phone": "08012341234",
    "country": "JP",
    "address1": "OSAKAFU",
    "address2": "",
    "province": "OSAKA",
    "zip": "1234567",
    "city": "IBARAKI SHI"
  },
  "products": [
    {
      "name": "Basket ball",
      "quantity": "2",
      "price": "4850",
      "hs_code": "",
      "origin_country": "JP",
      "weight": 100
    },
    {
      "name": "Basket ball2",
      "quantity": "2",
      "price": "4850",
      "hs_code": "",
      "origin_country": "JP",
      "weight": 200
    },
    {
      "name": "Basket ball3",
      "quantity": "2",
      "price": "4850",
      "hs_code": "",
      "origin_country": "JP",
      "weight": 200
    },
    {
      "name": "Basket ball4",
      "quantity": "2",
      "price": "4850",
      "hs_code": "",
      "origin_country": "JP",
      "weight": 180
    },
    {
      "name": "Basket ball5",
      "quantity": "2",
      "price": "4850",
      "hs_code": "",
      "origin_country": "JP",
      "weight": 240
    }
  ],
  "parcels": [
    {
      "amount": 1,
      "width": 10,
      "height": 10,
      "depth": 10,
      "weight": 2000
    }
  ],
  "customs": {
    "duty_paid": false,
    "content_type": "MERCHANDISE",
    "ioss_number": "IM1234567890"
  },
  "setup": {
    "carrier_id": "az3crDeRgh56gFfs3",
    "service": "japanpost_ems",
    "currency": "JPY",
    "shipment_date": "2020-07-26",
    "insurance": 0,
    "ref_number": "",
    "delivery_note": "",
    "signature": false,
    "return_label": false,
    "test": false
  }
}'

{
  "id": "API-QWMHHRLQS8",
  "state": "active",
  "test": true,
  "created_at": "2019-08-31T07:14:20.209Z",
  "to_address": {
    "full_name": "TEST TARO",
    "company": "",
    "address1": "京都市中京区八百屋町117",
    "address2": "",
    "city": "京都府",
    "province": "",
    "zip": "604-8072",
    "country": "JP",
    "phone": "1111111111",
    "email": ""
  },
  "from_address": {
    "full_name": "テスト",
    "company": "",
    "address1": "OSAKAFU",
    "address2": "",
    "city": "IBARAKI SHI",
    "province": "OSAKA",
    "zip": "1234567",
    "country": "JP",
    "phone": "08012341234",
    "email": ""
  },
  "products": [
    {
      "name": "Basket ball",
      "quantity": 2,
      "price": 4850,
      "hs_code": "",
      "origin_country": "JP"
    },
    {
      "name": "Basket ball2",
      "quantity": 2,
      "price": 4850,
      "hs_code": "",
      "origin_country": "JP"
    },
    {
      "name": "Basket ball3",
      "quantity": 2,
      "price": 4850,
      "hs_code": "",
      "origin_country": "JP"
    },
    {
      "name": "Basket ball4",
      "quantity": 2,
      "price": 4850,
      "hs_code": "",
      "origin_country": "JP"
    },
    {
      "name": "Basket ball5",
      "quantity": 2,
      "price": 4850,
      "hs_code": "",
      "origin_country": "JP"
    }
  ],
  "setup": {
    "currency": "JPY",
    "insurance": 0,
    "ref_number": "",
    "delivery_note": "",
    "discount": 0,
    "pack_size": "0",
    "pack_amount": 3,
    "date": "2020-07-28",
    "time": "16-18",
    "care": {
      "fragile": false,
      "side_up": false,
      "valuable_goods": false
    },
    "pick_up": false
  },
  "delivery": {
    "carrier": "sagawa",
    "method": "sagawa_regular",
    "tracking_numbers": ["514699854874"],
    "label": "https://storage.googleapis.com/dev-shipandco/labels/201908/k3wWYYwk8Q8h46NcM/voxZSt9fYeeWzFssm.pdf",
    "invoice": "JVBERi0xLjMKJf////8KNyAwIG9iago8PAovVHlwZSAvUGFnZQovUGFyZW50IDEgMCBSCi9NZWRpYUJveCBbMCAwIDU5NS4yOCA4NDEuODldCi9Db250ZW50cyA1IDAgUgovUmVzb3VyY2VzIDYgMCBSCj4+CmVuZG9iago2IDAgb2JqCjw8Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQovRm9udCA8PAovRjEgOCAwIFIKL0YyIDkgMCBSCi9GMyAxMCAwIFIKPj4KPj4KZW5kb2JqCjUgMCBvYmoKPDwKL0xlbmd0aCAxMDQ0Ci9GaWx0ZXIgL0ZsYXRlRGVjb2RlCj4+CnN0cmVhbQp4nK1Yu67jRgzt/RX6gVU4JIecARYuAiRFugDughS+ltVtsf/f5HAk2ffa8t1IuzZGHoxkHr4fSh3h+yXhUjT1pXaXb4fvh7R2/PtpPk9dps5ce0/d6dvhtz9Tl6g7jYd/vqrYaFcXq+Z2tWz52NG/3emvwx+nw9//k3KuN8p8p3wG5WJXJlXsdtGlPqktLJeJriRhpswOXplMHVdRnIhlJ1fIMBg770KUuobokoXwDVw6dkrdV0vORxDL2FaXHVBcVqDUQB40g3hqMDCK7BIl+Qp9HuK7gxrZmmJIKhYMIjJfdSNtAfFCa54Z9rQLvjmUsZmolzWnzPXY1UmvA5ZaYgpN4yiD9XKzLMdu3IW75rTZj500kne3uRi8tsXf4BSGBiNh+roH1dYcV4tWdU1ZYheyp3AqTTooBNe3vNWxGlZe81xgJKC9xXXC07juUqGuua4YXG2Kw5YBwD0EKtBYgOhswfjV8Ud3Jwb3sCZrcaDn2WHSYsjthDn/qnBt5JKux2u5xav+RMQ6yQp5r8i+iB4bldznBPbR4W3V3Vv88XW6uYOdV6VNRzj6oDkz9hWeeYFjVL1mW1yheemeIEDt6YXKgllnyOvibQzxLH4J4QdQHrIr/hiRN6UCgGsu8MOtxaPBi/eurI/4Q9O/WOEwc2IIDCO3tQeFYWa3Jylndw/JYLxpC62SjlkykhpDp3pt4VrAhsHLEDjies672CDo2sojGxHQDXyqEF84fGxwQVMwmkVez3PYt6felVT0CHKebkd3AjtsdQGYOGvuqXBZSsySB+lePqI5CbG3ykwvqWvJslqx0L/hs0O5r4DGRhN1ZXM609fs54x2Blki+qhGf3tro/aaesKNrVk9f8Ltot8x8ppddvgIW8/mLjNpWUgTEUxIjAVrE1QGjRAZlm+E4eo9spGofgpXsCrWGesN67KcbfUZS32tnBCOn8ENWJvrYEhCVTz/mDTWOOkwpEJbQwhySlBm2hpuKEo4JONPYZHrZrit5CvvkCrZO6l8h1QR26hufVG9+fWSOMELJiRd/DpyYatZm5NzTX2S+oDzrk5kyhUVKPMFg4LtqkHqtWcpzzJgtqyY9ygylPlPyCC9aXrAeZZhF+9aemJ74v0hr8QUi1lH5rJxafk8x3TgtjSWdol5d7eUqtTnqg8c/TpLQVj0g32xW0fiM+XK4234iXm9RLWGdHORdKBGFWgVPESDSlDK4hi7AlXovIs/h6ntwyQ1Ff14DDfHeNswXdtfamsGWgVrWKHN3ApzqzxxL57AvLH0qPNLhZi6tTEGlMauBB/L+Qpn02uUMCOu9x7kzobPDgtm2zNBLSi333a/Nc86GR5IHONn42lhe/NbgMR9MvQKmISFn16j8CjpA8X/AN1/vrsKZW5kc3RyZWFtCmVuZG9iagoxMiAwIG9iagooUERGS2l0KQplbmRvYmoKMTMgMCBvYmoKKFBERktpdCkKZW5kb2JqCjE0IDAgb2JqCihEOjIwMjAwMzExMDc0MzEwWikKZW5kb2JqCjExIDAgb2JqCjw8Ci9Qcm9kdWNlciAxMiAwIFIKL0NyZWF0b3IgMTMgMCBSCi9DcmVhdGlvbkRhdGUgMTQgMCBSCj4+CmVuZG9iago4IDAgb2JqCjw8Ci9UeXBlIC9Gb250Ci9CYXNlRm9udCAvSGVsdmV0aWNhCi9TdWJ0eXBlIC9UeXBlMQovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKOSAwIG9iago8PAovVHlwZSAvRm9udAovQmFzZUZvbnQgL0hlbHZldGljYS1Cb2xkCi9TdWJ0eXBlIC9UeXBlMQovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKMTYgMCBvYmoKPDwKL1R5cGUgL0ZvbnREZXNjcmlwdG9yCi9Gb250TmFtZSAvQ1paWlpaK0lQQWV4R290aGljCi9GbGFncyA0Ci9Gb250QkJveCBbLTI3MC4wMTk1MzEgLTI3OC44MDg1OTQgMTAwMCA5MzAuMTc1NzgxXQovSXRhbGljQW5nbGUgMAovQXNjZW50IDg3OS44ODI4MTMKL0Rlc2NlbnQgLTEyMC4xMTcxODcKL0NhcEhlaWdodCA3MjQuMTIxMDk0Ci9YSGVpZ2h0IDUwNy44MTI1Ci9TdGVtViAwCi9Gb250RmlsZTIgMTUgMCBSCj4+CmVuZG9iagoxNyAwIG9iago8PAovVHlwZSAvRm9udAovU3VidHlwZSAvQ0lERm9udFR5cGUyCi9CYXNlRm9udCAvQ1paWlpaK0lQQWV4R290aGljCi9DSURTeXN0ZW1JbmZvIDw8Ci9SZWdpc3RyeSAoQWRvYmUpCi9PcmRlcmluZyAoSWRlbnRpdHkpCi9TdXBwbGVtZW50IDAKPj4KL0ZvbnREZXNjcmlwdG9yIDE2IDAgUgovVyBbMCBbMjA0OCA1OTkuMTIxMDk0IDM1Ny45MTAxNTYgNTg0Ljk2MDkzOCA2MDYuOTMzNTk0IDI3MC4wMTk1MzEgMzcwLjExNzE4OCAzNDYuMTkxNDA2IDYyOS44ODI4MTMgNjI5Ljg4MjgxMyA2MjkuODgyODEzIDYyOS44ODI4MTMgMjY0LjE2MDE1NiAzNzkuODgyODEzIDYyMS4wOTM3NSA2MTkuMTQwNjI1IDI3MC4wMTk1MzEgMjY0LjE2MDE1NiA2MjkuODgyODEzIDYyOS44ODI4MTMgNjI5Ljg4MjgxMyA0ODguNzY5NTMxIDYyOS44ODI4MTMgNjI5Ljg4MjgxM11dCj4+CmVuZG9iagoxOCAwIG9iago8PAovTGVuZ3RoIDI4MwovRmlsdGVyIC9GbGF0ZURlY29kZQo+PgpzdHJlYW0KeJxdUT1rxDAM3fMrNF6HIxf7PloIhnJdMvSDpp3KDYmtBENjG8cZ8u/rWOldqcF+PElPsqT8XD1VRgfI37yVNQbotFEeRzt5idBir01WMFBahpWlVw6Ny/Iorucx4FCZzkJZZgD5e3SPwc+weVS2xbvF9uoVem162Hye62SpJ+e+cUATYJcJAQq7mO65cS/NgJAn6bZS0a/DvI2qW8TH7BBY4gV9SVqFo2sk+sb0mJW7eETZxSMyNOqfexW13d9oiFCcBHzd6GGfgCliPMHxnuAhwYkRUCQvCMjIScDXLJhg31CytQJlYcSYJAEZORXi5Dut7EBwFJelsd8Wlh6XfVznJyfv4+jS0tLMlmlpg9e9OusWVbo/BpmTygplbmRzdHJlYW0KZW5kb2JqCjEwIDAgb2JqCjw8Ci9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMAovQmFzZUZvbnQgL0NaWlpaWitJUEFleEdvdGhpYwovRW5jb2RpbmcgL0lkZW50aXR5LUgKL0Rlc2NlbmRhbnRGb250cyBbMTcgMCBSXQovVG9Vbmljb2RlIDE4IDAgUgo+PgplbmRvYmoKNCAwIG9iago8PAo+PgplbmRvYmoKMyAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMSAwIFIKL05hbWVzIDIgMCBSCj4+CmVuZG9iagoxIDAgb2JqCjw8Ci9UeXBlIC9QYWdlcwovQ291bnQgMQovS2lkcyBbNyAwIFJdCj4+CmVuZG9iagoyIDAgb2JqCjw8Ci9EZXN0cyA8PAogIC9OYW1lcyBbCl0KPj4KPj4KZW5kb2JqCjE1IDAgb2JqCjw8Ci9MZW5ndGggMjg5NAovRmlsdGVyIC9GbGF0ZURlY29kZQo+PgpzdHJlYW0KeJx1VwtYlFUa/s45/2XmH+bGDAwiKHOBaRgQdUSi6JnBCxFJEpqrhHgD1IhU8EZIpiymKWuIssaqi+a62rbGrnR5qjXNS5pRlrraGl3WTLGnnuxBM2N+9vv/GdR62p/5vplzzsw53+V9v++wsGpRGWjhaWBgmlM2oxRCzxaUkXNwIjz+GMX1+LxZ/ePrKKWVM5bODw1JEaqEWYsXJoTHT6LaML+qLLxOI1BJsx+vKQ+PowEiUuZULlwaGhtGoZpePn92ZXi8A9VCIKg5uj6zZuyEacasa2DUqKvHDI0zlfdzX1/0B88Gj2hAXIBDAaj6CxRR6pMANICrn2jUmV88MeH3NpReXB6BcgOtWoZyDoAVo/Tg0XehfArAd+DmuI0QQMHfiC6U58LyPp6zGUCL8xLuI70EoCtVvFNPjUE1LOQyKMbjL01As5UJ/gRnAmufJNeCVaBcOvwFZsB0WAlN8AHq8VAP+dAJi2EiRrsENsFl2Ax/gINo9RQogmdhCbwCb+FoE87uwQz9CfbBTtgPf4bjuNcZ3OUqfmszNOOO9dAOPfA1zINa3LEMdkA6nMSsPwML4AvYCi1wDF76x1DyOnHFNDTGAw+dfT7RJ3yJuBAQHxFghHGBbEOETtJqREHD6RnPWQk16q0EKMcoIUAoGIwGvaQVeE4j6phGxLUInZUQ/AKu4jskJ3u9KMOG8nazXbQTYiZOYuYJEX0/tQrle2/eoA303WDds8FaflxwebCuU9z7WO+l3iZheO8lFv/TsQJm6+3GdPVdByt3hj8BIqQHnIwCzxFIYQLhRAEMIlA9EXg0y0MY4ThGwJtsOnDAlOz1Zykfhg0ldrPTbE+3c2eCF14N9nCf86k3L/EDtiloKad2upgeRN8HBky4LdquuAgGRQ3BB51QdkjHrwW/pyZqb1NxV9p3nbufvwweGB1wx4y1UJfbwruBEE9sdBSHgeQZYjvOYRQcTo8T54wcbpc2RBHTt6ZvvRYrvvx+5TPun+R0iEKU1RZtw1d0lFUUnAnujGjf8IyR6SPcSW63K31Exkhfgo3tqrrwdP694zL/PvbyI3lN9cfl9lcbn/tm/viZufkfZsk7Fyw/RTJ3cY1HC0ZNmnafNzd+6oJZtUeqyvsqOtPvX1ycmzfe1tC7u7LmOvrwBsY1jZcx3/cHfJxLryfEqEN8EowGkbQYV9CImHNmUIILOkkUPExDOSMQrSaUYZs/y2JKRl+sfsWPRKfZ5HQwDLfPjNaaubT2M+fL2tvX/odMt9Iawsm9wWf4K8HSQ3JViCntYCU1/Kt4opJdjyhQUFIY6M8Dz1GDyHkIhjNSQZfA30KXP8urwIs4030MDyQ1x4/r29u57s6bJUyhOnSAlV7gUpGGOYGhzGM0EqJHVItEIBr0EP+0GmrAKSZq8UyqFzWih2gJJ2lVECGAFfcO3HKPiKE8Kf4xX6RvOL0w2DFwcf709l0absE5J5f4sjhv3WPBXtYrf0TGKTbk9Ml0N/8AWOCRwH3mUZTyxIJQ4Hh0SAmxaNALfDYTCRehw2Azg0UfAZweQ80ZDTppCOMIp9XwyKp+VNsUWCdbvJZQxAWnw2zGEKRnmO1RdrMVIUN3Vy35bu3a3WSgfLEiNzt/PImga+ouTpTfrQuu35qh4vc8WJmVv4KVStonKnz2+9X0CaLbleFj1o49b9qJ7q0qK6+/5661o6cqv1mPeGlGzA+CvECK3hUZiXA3gUhxLcZImRjPYFA8hlXAWBq0juhB8THRJmOYRyr2EfdoPYYzhH7VAXt6ZGLGyBDOnQnMHWkfHmKAKHKinWv+ubeGTMp8OcOfV9ggX5uwrYps7KqvzhtzzSsfm8KKrC+S2O6kpaPHT52bVyj/O5Osql/812VlM5+PPXgebS5Gns5Em71QGBg2KNGpcwlOQBARrz0hDo+xaDWgC5E11uM2eqjXfWuBgmr0kLD5v0FbzqwylWVE28NMdWIq+j86xDucoTfJnJpV1+SmF1oWEO2WSYW1818rKnl9xpxFD879rKJlI8k/VV+/vPBJJmTLpzuqlxFXQVfBuIVrJjy4ISevbnV26he5xP3YnL/tmD0qEnnjx1wc5j8BCSIxgxqgoQwSp1rqiA/54BRErHwjuMNXdwZN9NTBq/IioWiyXEWzSLW8nUzbyd7pHc5impYEvycXHsdYbUMu1mInYZAQiGZ0DKaSU1LJYAwhhFMKv1etqgpS0n2ktqvL2oX1+VzfdZqD9VkHQwODNWMZ44lOwhiDoOfBIPCSTvKE9grXZq9SM0KMMpvsDrXQpZtpjry3ec3okrJ/8id+PiBX5K/1/8Dloa+H0NctuL8GK9WYwFCNyBsNCswEPrGfrdh7DREOZpB4gv1KMGqVUoVHakJHHk5WkYf9SG0IFnsCnouhsvjUD4fIizQtePSbjo7jpE1+6hJ/Qi6WxwT30K+Jl0QpfOnrRRt6VBvuDiSJSmni9aAReLw+GJC2VPP/25DCWJPSRAjmhvgwkj3BTzqCFy6QVvI8f6L3anAy3c2MwRV0uXqhgmHyfjIfurEzRwe0uCUYFKU2I0Vh9Clzj7SQ+e5N9ZUx3fJX8lVnH9Gq9XQR4r0a8T4AO9OYgNuRSGMTJZsrEnHCYwIHRFmxf4bwnmQY5BFwwiAgzkPsNHWGAJ4WQriaISww7qRw94k2m/o7U4KFhFtWP97Zm41X9q1sXfH7T0lyY/muLT/LXS0bZ7xNFsfJz6+bUjBu8h93T/PnldMfOitXfHmyqfnGa/Jncs3po98U7KZz6ey505qaJ5bVT55dO6tBiQODeX3fcW38D6ovmTApMByrXfKo2IRsi8BbIJaQ2AFRWC3DvXaEg6Y4JJfHGOexDbBFGfUREg05lhYm720C3+lfiMOKj6bE9FCbVThr4pWe677dmKNF7k5v0d9UUn1g3Ycn171BJspn21YfPr/mGfmtXeTu2ROX108umj7kgYlU3ltXsuKVmbml906YwTRPydc+fuLhhys+JOwpoeLGv6qmL6jYLn878Z68s8se9OfkLV2SmxjnWDnlYmNO+szcuU8UDnG4MaeVmNNtmFMjDAZXwBIzVmNygYZX7xec1RERwaWlqb7dqkvhTNkT3ElmU8ZIG/pgNoVtN7mT6DpiaKquXi93y1fWV59a9XZbcUnx1O0Hp95XMo2/fPOofFQ+/t6PP75HMknHu3XNO3bKn8tfvdD235arJHb7DhWjkdg/TuKtVgeZAbtOw2NnBiYh7QhTsI93htD1kef6L1L9j0IHfHmVIkLwSqgwwkfYyffQmu9OkDq5uZNIRPeOvMFKNstz8DpyQ15E1sqSem4LxmId8nAw5AfSbInU6JIkBPbg2AH6CApiPK/0oBwykHBxA8Fg8QiDB8XHDVRWhTureagRYRNN6w9ZKOtWJWjs9sVLqeEW7KuM1Gx46YPVyyvXyD3ynq0tS75smlE6uXjjyYrWEuYOVoxi2dVrG47sW72X8A/tL5q2dePk4jYrG9Iqm0L3nFa0e/MdvHRJsYlU4SWP1fxXvPQIgwy/4GXnb+H2lsHOcJaRn6LSQRN/xUtS2HT5bH31ilXn5L6mxhdbfyJJq5oL98ur4sisDdMnjSvf8sLv7n2oiHZ/1LLyzfef23T4bVJAlp8/8kXB1uDGnMqZ1bWlDQ2PLm18tBz/renkTmC174Jybi+UcufhDeqBdnodOugRyOElOI+yHqUYxU/jYRuT+s5xN+AQ19PXi98FnBuGa4tQ5qFUsm6sTBK0oLQGjMpt7A7cpNjSslJTFDFHZirKhtpkC2YpukfVXao+reggSg9KF8rp1JTDqSkHUlMgEInNAa+MlDEOr10C3isg2h9+olP/B5D3fRQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgMTkKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAzMDA1IDAwMDAwIG4gCjAwMDAwMDMwNjIgMDAwMDAgbiAKMDAwMDAwMjk0MyAwMDAwMCBuIAowMDAwMDAyOTIyIDAwMDAwIG4gCjAwMDAwMDAyMzUgMDAwMDAgbiAKMDAwMDAwMDEyNSAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDE1MTQgMDAwMDAgbiAKMDAwMDAwMTYxMSAwMDAwMCBuIAowMDAwMDAyNzc2IDAwMDAwIG4gCjAwMDAwMDE0MzggMDAwMDAgbiAKMDAwMDAwMTM1MiAwMDAwMCBuIAowMDAwMDAxMzc3IDAwMDAwIG4gCjAwMDAwMDE0MDIgMDAwMDAgbiAKMDAwMDAwMzEwOSAwMDAwMCBuIAowMDAwMDAxNzEzIDAwMDAwIG4gCjAwMDAwMDE5NzAgMDAwMDAgbiAKMDAwMDAwMjQyMCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDE5Ci9Sb290IDMgMCBSCi9JbmZvIDExIDAgUgovSUQgWzw4ZTkyYTE0YjIzOGM0NjMwYzIzYzVhYTJjZmZiMDZiYz4gPDhlOTJhMTRiMjM4YzQ2MzBjMjNjNWFhMmNmZmIwNmJjPl0KPj4Kc3RhcnR4cmVmCjYwNzcKJSVFT0YK",
    "warnings": ["DUMMY_WARNING"]
  }
}

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

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

リクエスト

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

項目	説明	必須情報
to_address	荷受人住所です。注：`province`はコードがある国の場合名称ではなくコードで指定する必要があります。（例：アメリカのカルフォルニアの場合`CA`） ※住所の最大長は運送会社やサービスで異なります。（例： DHLはaddress1とaddress2それぞれ45文字、合計90文字まで指定可能）	full_name, phone (一部のサービスのみ), country, address1, province (存在する国の場合のみ), city (存在する国の場合のみ), zip (存在する国の場合のみ)
from_address	発送人住所です。注：`province`はコードがある国の場合名称ではなくコードで指定する必要があります。（例：アメリカのカルフォルニアの場合`CA`） ※住所の最大長は運送会社やサービスで異なります。（例： DHLはaddress1とaddress2それぞれ45文字、合計90文字まで指定可能）	full_name, phone, country, address1, province (存在する国の場合のみ), city (存在する国の場合のみ), zip (存在する国の場合のみ)
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"	amount, width, height, depth, package (`package`は、`width`、`height`、`depth`が未指定の時のみ。最低１つの荷物情報が必要)
products	製品情報です。	name, quantity, price, origin_country, weight
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圏への輸出について	content_type (一部のサービスのみ)
setup	設定情報です。詳細は運送会社とサービスを参照してください。料金の一覧を利用して最適な`service`を探すこともできます。 ※`"test": true`を追加することで課金されないダミーのラベルを発行することができます。	carrier or carrier_id, service, currency

※各運送会社の実際に動作するサンプルリクエストは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の警告が表示された場合はこちらの内容をご確認ください）

出荷情報の一覧

curl -v -X GET "https://api.shipandco.com/v1/shipments?state=active&limit=2&page=1&created_after=2018-12-01T00:00:00.000Z&created_before=2019-01-30T00:00:00.000Z&carrier=sagawa" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

{
  "shipments": [
    {
      "id": "API-SGF5LYSJAF",
      "state": "active",
      "scope": "api",
      "created_at": "2019-01-08T17:17:08.394Z",
      "to_address": {
        "full_name": "太郎山田",
        "address1": "京都市東山区",
        "country": "JP",
        "email": "yamada.taro@demo.com",
        "phone": "08012341234",
        "address2": "西海子町",
        "extra": "神宮道",
        "province": "京都府",
        "zip": "6050012"
      },
      "from_address": {
        "company": "株式会社ACME",
        "address1": "中央区",
        "country": "JP",
        "email": "yamada.hanako@acme.com",
        "phone": "08012341234",
        "address2": "日本橋堀留町",
        "extra": "タワー　＃１００１",
        "province": "東京都",
        "zip": "1030012"
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": 2,
          "price": 4850,
          "hs_code": ""
        }
      ],
      "setup": {
        "currency": "JPY",
        "insurance": 0,
        "ref_number": "",
        "delivery_note": "",
        "discount": 0,
        "pack_size": "60",
        "pack_amount": 1,
        "date": "2019-01-10",
        "time": "16-18",
        "care": {
          "fragile": false,
          "side_up": false,
          "valuable_goods": false
        },
        "pick_up": false,
        "print_start_location": "4"
      },
      "delivery": {
        "carrier": "sagawa",
        "method": "sagawa_regular",
        "tracking_numbers": ["514699818076"],
        "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/WgnXig8zR6hEvZLWE.pdf"
      }
    },
    {
      "id": "API-RXILYS438A",
      "state": "active",
      "scope": "api",
      "created_at": "2019-01-08T17:13:19.968Z",
      "to_address": {
        "full_name": "太郎山田",
        "address1": "京都市東山区",
        "country": "JP",
        "email": "yamada.taro@demo.com",
        "phone": "08012341234",
        "address2": "西海子町",
        "extra": "神宮道",
        "province": "京都府",
        "zip": "6050012"
      },
      "from_address": {
        "company": "株式会社ACME",
        "address1": "中央区",
        "country": "JP",
        "email": "yamada.hanako@acme.com",
        "phone": "08012341234",
        "address2": "日本橋堀留町",
        "extra": "タワー　＃１００１",
        "province": "東京都",
        "zip": "1030012"
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": 2,
          "price": 4850,
          "hs_code": ""
        }
      ],
      "setup": {
        "currency": "JPY",
        "insurance": 0,
        "ref_number": "",
        "delivery_note": "",
        "discount": 0,
        "pack_size": "60",
        "pack_amount": 1,
        "date": "2019-01-10",
        "time": "16-18",
        "care": {
          "fragile": false,
          "side_up": false,
          "valuable_goods": false
        },
        "pick_up": false,
        "print_start_location": "4"
      },
      "delivery": {
        "carrier": "sagawa",
        "method": "sagawa_regular",
        "tracking_numbers": ["514699818065"],
        "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/Fu8f5dvB5zrmBTHfh.pdf"
      }
    },
    {
      "id": "API-Y72ITP6P8G",
      "state": "active",
      "scope": "api",
      "created_at": "2019-01-08T17:05:12.663Z",
      "to_address": {
        "full_name": "太郎山田",
        "address1": "京都市東山区",
        "country": "JP",
        "email": "yamada.taro@demo.com",
        "phone": "08012341234",
        "address2": "西海子町",
        "extra": "神宮道",
        "province": "京都府",
        "zip": "6050012"
      },
      "from_address": {
        "company": "株式会社ACME",
        "address1": "中央区",
        "country": "JP",
        "email": "yamada.hanako@acme.com",
        "phone": "08012341234",
        "address2": "日本橋堀留町",
        "extra": "タワー　＃１００１",
        "province": "東京都",
        "zip": "1030012"
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": 2,
          "price": 4850,
          "hs_code": ""
        }
      ],
      "setup": {
        "currency": "JPY",
        "insurance": 0,
        "ref_number": "",
        "delivery_note": "",
        "discount": 0,
        "pack_size": "60",
        "pack_amount": 1,
        "date": "2019-01-10",
        "time": "16-18",
        "care": {
          "fragile": false,
          "side_up": false,
          "valuable_goods": false
        },
        "pick_up": false,
        "print_start_location": "4"
      },
      "delivery": {
        "carrier": "sagawa",
        "method": "sagawa_regular",
        "tracking_numbers": ["514699818054"],
        "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/dJt72M3PhJQo9pmjE.pdf"
      }
    },
    {
      "id": "API-Q9CASGOIC9",
      "state": "active",
      "scope": "api",
      "created_at": "2019-01-08T16:56:16.944Z",
      "to_address": {
        "full_name": "太郎山田",
        "address1": "京都市東山区",
        "country": "JP",
        "email": "yamada.taro@demo.com",
        "phone": "08012341234",
        "address2": "西海子町",
        "extra": "神宮道",
        "province": "京都府",
        "zip": "6050012"
      },
      "from_address": {
        "company": "株式会社ACME",
        "address1": "中央区",
        "country": "JP",
        "email": "yamada.hanako@acme.com",
        "phone": "08012341234",
        "address2": "日本橋堀留町",
        "extra": "タワー　＃１００１",
        "province": "東京都",
        "zip": "1030012"
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": 2,
          "price": 4850,
          "hs_code": ""
        }
      ],
      "setup": {
        "currency": "JPY",
        "insurance": 0,
        "ref_number": "",
        "delivery_note": "",
        "discount": 0,
        "pack_size": "60",
        "pack_amount": 1,
        "date": "2019-01-10",
        "time": "16-18",
        "care": {
          "fragile": false,
          "side_up": false,
          "valuable_goods": false
        },
        "pick_up": false,
        "print_start_location": "4"
      },
      "delivery": {
        "carrier": "sagawa",
        "method": "sagawa_regular",
        "tracking_numbers": ["514699818043"],
        "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/74FBe7MnjmQ3eM66b.pdf"
      }
    },
    {
      "id": "API-6E53FMVTZF",
      "state": "active",
      "scope": "api",
      "created_at": "2019-01-08T16:55:44.228Z",
      "to_address": {
        "full_name": "太郎山田",
        "address1": "京都市東山区",
        "country": "JP",
        "email": "yamada.taro@demo.com",
        "phone": "08012341234",
        "address2": "西海子町",
        "extra": "神宮道",
        "province": "京都府",
        "zip": "6050012"
      },
      "from_address": {
        "company": "株式会社ACME",
        "address1": "中央区",
        "country": "JP",
        "email": "yamada.hanako@acme.com",
        "phone": "08012341234",
        "address2": "日本橋堀留町",
        "extra": "タワー　＃１００１",
        "province": "東京都",
        "zip": "1030012"
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": 2,
          "price": 4850,
          "hs_code": ""
        }
      ],
      "setup": {
        "currency": "JPY",
        "insurance": 0,
        "ref_number": "",
        "delivery_note": "",
        "discount": 0,
        "pack_size": "60",
        "pack_amount": 1,
        "date": "2019-01-10",
        "time": "16-18",
        "care": {
          "fragile": false,
          "side_up": false,
          "valuable_goods": false
        },
        "pick_up": false,
        "print_start_location": "4"
      },
      "delivery": {
        "carrier": "sagawa",
        "method": "sagawa_regular",
        "tracking_numbers": ["514699818032"],
        "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/2GAfFX6Yy87cCtRqo.pdf"
      }
    }
  ],
  "count": 5,
  "pages": 1,
  "current_page": 1
}

作成した出荷情報を一覧表示します。

リクエスト

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

項目	説明
state	初期値 `active`, 指定可能な値: `active, void, any`
carrier	運送会社の`type`を指定します。運送会社の一覧で取得できるもの
scope	API経由で作成された出荷情報のみ (`api`)、またはAPIとアプリ双方にて作成された出荷情報 (`all`)、いずれかを指定します (初期値: `api`, 指定可能な値: `api, all`)

その他の項目はGETパラメータを参照してください。

レスポンス

作成した出荷情報の配列です。出荷情報の詳細は出荷情報の作成を参照してください。

その他の項目はGETレスポンスを参照してください。

出荷情報の取得

curl -v -X GET "https://api.shipandco.com/v1/shipments/API-O8APFNW9S8" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

{
  "id": "API-O8APFNW9S8",
  "state": "active",
  "scope": "api",
  "created_at": "2019-01-07T14:15:01.151Z",
  "to_address": {
    "full_name": "John Doe",
    "company": "ACME",
    "address1": "Rua Maria Matos, 32",
    "country": "PT",
    "email": "john@doe.io",
    "phone": "0901231234",
    "address2": "",
    "city": "CHARNECA DA CAPARICA",
    "province": "SETUBAL",
    "zip": "2820-344"
  },
  "from_address": {
    "full_name": "Yamada Taro",
    "company": "World Company",
    "address1": "OSAKAFU",
    "country": "JP",
    "email": "ytaro@worldcompany.com",
    "phone": "08012341234",
    "address2": "OTECHO",
    "city": "IBARAKI SHI",
    "province": "OSAKA",
    "zip": "5670883"
  },
  "products": [
    {
      "name": "Basket ball",
      "quantity": 2,
      "price": 4850,
      "hs_code": "HS9988",
      "origin_country": "JP"
    }
  ],
  "parcels": [
    {
      "weight": 200,
      "amount": 1,
      "width": 10,
      "height": 10,
      "depth": 10
    }
  ],
  "customs": {
    "duty_paid": false,
    "content_type": "MERCHANDISE"
  },
  "setup": {
    "currency": "JPY",
    "insurance": 0,
    "ref_number": "",
    "delivery_note": "",
    "discount": 0,
    "return_label": false,
    "signature": false
  },
  "delivery": {
    "carrier": "japanpost",
    "method": "japanpost_ems",
    "tracking_numbers": ["EN027977320JP"],
    "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/undefined.pdf"
  }
}

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

リクエスト

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

レスポンス

１つの出荷情報を返します。出荷情報の詳細は出荷情報の作成を参照してください。

出荷情報の削除

curl -v -X DELETE "https://api.shipandco.com/v1/shipments/API-O8APFNW9S8" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

"Shipment API-O8APFNW9S8 deleted."

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

リクエスト

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

レスポンス

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

料金

料金の一覧

curl -v -X POST "https://api.shipandco.com/v1/rates" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json" \
  -d '{
    "to_address": {
      "full_name": "John Doe",
      "company": "ACME",
      "email": "john@doe.io",
      "phone": "0901231234",
      "country": "PT",
      "address1": "Rua Maria Matos, 32",
      "address2": "",
      "province": "SETUBAL",
      "zip": "2820-344",
      "city": "CHARNECA DA CAPARICA"
    },
    "from_address": {
      "full_name": "Yamada Taro",
      "company": "World Company",
      "email": "ytaro@worldcompany.com",
      "phone": "08012341234",
      "country": "JP",
      "address1": "OSAKAFU",
      "address2": "OTECHO",
      "province": "OSAKA",
      "zip": "5670883",
      "city": "IBARAKI SHI"
    },
    "products": [
      {
        "name": "Basket ball",
        "quantity": 2,
        "price": 4850,
        "hs_code": "HS9988",
        "origin_country": "JP"
      }
    ],
    "parcels": [
      {
        "weight": 200,
        "amount": 1,
        "width": 10,
        "height": 10,
        "depth": 10
      }
    ],
    "customs": {
      "duty_paid": false,
      "content_type": "MERCHANDISE"
    },
    "setup": {
      "carrier": "japanpost",
      "currency": "JPY",
      "date": "2019-01-08",
      "insurance": 0,
      "ref_number": "",
      "delivery_note": "",
      "discount": 0,
      "signature": false
    }
}'

[
  {
    "carrier_id": "CFjQRubN5jhhT5hTb",
    "carrier": "japanpost",
    "service": "japanpost_ems",
    "currency": "JPY",
    "price": 2200,
    "surcharges": [
      {
        "type": "frozen",
        "amount": "324"
      }
    ]
  },
  {
    "carrier_id": "CFjQRubN5jhhT5hTb",
    "carrier": "japanpost",
    "service": "japanpost_registered_mail",
    "currency": "JPY",
    "price": 690,
    "surcharges": []
  },
  {
    "carrier_id": "CFjQRubN5jhhT5hTb",
    "carrier": "japanpost",
    "service": "japanpost_epacket",
    "currency": "JPY",
    "price": 785,
    "surcharges": []
  },
  {
    "carrier_id": "CFjQRubN5jhhT5hTb",
    "carrier": "japanpost",
    "service": "japanpost_epacket_light",
    "currency": "JPY",
    "price": 620,
    "surcharges": []
  },
  {
    "carrier_id": "CFjQRubN5jhhT5hTb",
    "carrier": "japanpost",
    "service": "airparcel",
    "currency": "JPY",
    "price": 2500,
    "surcharges": []
  },
  {
    "carrier_id": "CFjQRubN5jhhT5hTb",
    "carrier": "japanpost",
    "service": "salparcel",
    "currency": "JPY",
    "price": 2700,
    "surcharges": []
  },
  {
    "carrier_id": "CFjQRubN5jhhT5hTb",
    "carrier": "japanpost",
    "service": "seaparcel",
    "currency": "JPY",
    "price": 1800,
    "surcharges": []
  }
]

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

リクエスト

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

Rate

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

レスポンス

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

運送会社

運送会社の登録

curl -v -X POST "https://api.shipandco.com/v1/carriers" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "dhl",
    "credentials": {
      "account_number": "123456789"
    },
    "settings": {
      "label": {
        "hide_account": true,
        "extra_page":  true
      },
      "print": {
        "size": "PDF_4X8",
        "size_fallback": "PDF_A4"
      }
    }
  }'

{
  "id": "g3buDjYMCXaj6zNCv",
  "type": "dhl",
  "state": "active",
  "created_at": "2019-02-25T11:58:57.852Z",
  "updated_at": "2019-02-25T11:58:57.852Z",
  "credentials": {
    "account_number": "*********"
  }
}

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

リクエスト

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

項目	説明
type	登録したい運送会社の種類。指定可能は値は`japanpost`、`ups`、`fedex`、`dhl`、`sagawa`、`yamato`、`yuupack`、`yuupacket`、`pegasus`。
credentials	運送会社のシステム利用に必要な認証情報です。内部のパラメータは各運送会社ごとに異なります。詳細は以下を参照ください。
settings	運送会社の固有の設定です。内部のパラメータは各運送会社ごとに異なります。詳細は以下を参照ください。

運送会社ごとの認証情報

DHL

account_number: 文字列、必須 site_id: 文字列、必須 password: 文字列、必須

DHLからsite_idとpasswordを入手する手順はこちらのサポートページからご確認ください。

address.full_name: 文字列
address.company: 文字列
address.phone: 文字列
address.email: 文字列
address.address1: 文字列
address.address2: 文字列
address.zip: 文字列、必須
address.city: 文字列
address.country: 文字列、必須

UPS

account_number: 文字列、必須

user_name: 文字列、必須

password: 文字列、必須

access_key: 文字列、必須

FedEx

account_number: 文字列、必須

address.full_name: 文字列、必須
address.company: 文字列、必須
address.phone: 文字列、必須
address.email: 文字列、必須
address.address1: 文字列、必須
address.address2: 文字列
address.zip: 文字列、必須
address.city: 文字列、必須
address.country: 文字列、必須

日本郵便海外

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

佐川急便

account_number: 文字列、必須

key: 文字列、必須

password: 文字列、必須

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

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

user_id: 文字列、必須

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

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

上記と同じです。

ヤマト運輸

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"

ヤマト運輸

print.size: 文字列、必須。使用するラベルサイズ。指定可能な値: "PDF_A4", "PDF_A5", "PDF_A4_BW", "PDF_A5_BW", "PDF_4.5X7.8"

print.size_fallback: 文字列。"PDF_4.5X7.8"のための後方互換。指定可能な値: "PDF_A4", "PDF_A5", "PDF_A4_BW", "PDF_A5_BW"

※各運送会社の実際に動作するサンプルリクエストはPostmanをご参照ください。

レスポンス

登録された運送会社の情報をIDと共に表示します。

運送会社の一覧

curl -v -X GET "https://api.shipandco.com/v1/carriers" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

[
  {
    "id": "GZDZQNo7zyxr4sbXc",
    "type": "yuupacket",
    "state": "active",
    "created_at": "2019-01-07T14:24:13.045Z",
    "updated_at": "2019-01-07T14:24:13.045Z",
    "credentials": {
      "user_id": "***********"
    }
  },
  {
    "id": "FbqDPqcBL6AL7PwAo",
    "type": "yuupack",
    "state": "active",
    "created_at": "2019-01-07T14:24:13.042Z",
    "updated_at": "2019-01-07T14:24:13.042Z",
    "credentials": {
      "user_id": "***********"
    }
  },
  {
    "id": "7iuaQaEp8fasKCzgD",
    "type": "yamato",
    "state": "active",
    "created_at": "2019-01-07T14:06:13.197Z",
    "updated_at": "2019-01-07T14:06:13.197Z",
    "credentials": {
      "key": "*********************************************************",
      "freight_number": "**"
    }
  },
  {
    "id": "tbEuFScyfSQMx7bN8",
    "type": "sagawa",
    "state": "active",
    "created_at": "2019-01-07T14:06:39.627Z",
    "updated_at": "2019-01-07T14:08:45.817Z",
    "credentials": {
      "key": "********",
      "password": "************************",
      "account_number": "***********",
      "account_key_number": ""
    }
  },
  {
    "id": "CFjQRubN5jhhT5hTb",
    "type": "japanpost",
    "state": "active",
    "created_at": "2018-09-24T15:33:58.145Z",
    "updated_at": "2018-09-24T15:33:58.145Z",
    "credentials": {
      "customer_numbers": "****"
    }
  }
]

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

リクエスト

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

レスポンス

登録されている運送会社の情報の配列です。

運送会社の更新

curl -v -X PUT "https://api.shipandco.com/v1/carriers/g3buDjYMCXaj6zNCv" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json" \
  -d '{
    "settings": {
      "print": {
        "size": "PDF_4.2X8.3_BLUE"
      }
    }
  }'

{
  "id": "g3buDjYMCXaj6zNCv",
  "type": "sagawa",
  "state": "active",
  "created_at": "2019-02-25T11:58:57.852Z",
  "updated_at": "2019-02-25T11:58:57.852Z",
  "credentials": {
    "account_number": "*********",
    "key": "*********",
    "password": "*********"
  }
}

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

リクエスト

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

項目	説明
settings	更新する運送会社の固有の情報です。詳細は運送会社の登録を参照ください。

レスポンス

更新された運送会社の情報が表示されます。

運送会社の削除

curl -v -X DELETE "https://api.shipandco.com/v1/carriers/GZDZQNo7zyxr4sbXc" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

"Carrier GZDZQNo7zyxr4sbXc deleted."

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

リクエスト

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

レスポンス

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

追跡情報

追跡情報の取得

curl -v -X GET "https://api.shipandco.com/v1/tracking/japanpost/RN004792035JP" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

{
  "requested_at": "2019-05-22T14:52:35.155Z",
  "carrier": "japanpost",
  "tracking_number": "RN004792035JP",
  "service": "Registered Mail / Insured Mail",
  "from_address": {},
  "to_address": {},
  "current_status": {
    "date": "2019-05-20T17:30:00.000Z",
    "status": "Arrival at outward office of exchange",
    "details": "",
    "location": "OSAKA"
  },
  "history": [
    {
      "date": "2019-05-20T07:45:00.000Z",
      "status": "Posting/Collection",
      "details": "",
      "location": "OSAKA"
    },
    {
      "date": "2019-05-20T17:30:00.000Z",
      "status": "Arrival at outward office of exchange",
      "details": "",
      "location": "OSAKA"
    }
  ]
}

追跡情報を運送会社と追跡番号を指定して取得します。

リクエスト

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

レスポンス

運送会社の追跡情報です。

住所

住所の登録

curl -v -X POST "https://api.shipandco.com/v1/addresses" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json" \
  -d '{
   "full_name": "Ship Co",
   "company": "Ship&Co",
   "email": "shipco@shipandco.com",
   "phone": "0312345678",
   "country": "JP",
   "address1": "chukyo-ku",
   "address2": "",
   "extra": "",
   "province": "Kyoto-fu",
   "zip": "123-4567",
   "city": "Kyoto-shi"
}'

{
  "id": "kr54qe8YPdc5HZSBu",
  "created_at": "2019-01-12T09:04:43.619Z",
  "updated_at": "2019-01-12T09:04:43.619Z",
  "address": {
    "full_name": "Ship Co",
    "company": "Ship&Co",
    "address1": "chukyo-ku",
    "address2": "",
    "extra": "",
    "city": "Kyoto-shi",
    "province": "Kyoto-fu",
    "zip": "123-4567",
    "country": "JP",
    "phone": "0312345678",
    "email": "shipco@shipandco.com"
  }
}

荷受人住所を登録します。

リクエスト

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

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

レスポンス

登録された荷受人住所の情報をIDと共に表示します。

住所の一覧

curl -v -X GET "https://api.shipandco.com/v1/addresses" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

[
  {
    "id": "dC32vpNEja8W7WNwR",
    "created_at": "2019-01-12T08:32:55.411Z",
    "updated_at": "2019-01-12T08:32:55.411Z",
    "address": {
      "full_name": "John Doe",
      "company": "ACME",
      "address1": "Rua Maria Matos, 32",
      "address2": "",
      "extra": "",
      "city": "CHARNECA DA CAPARICA",
      "province": "SETUBAL",
      "zip": "2820-344",
      "country": "PT",
      "phone": "0901231234",
      "email": "john@doe.io"
    }
  },
  {
    "id": "kr54qe8YPdc5HZSBu",
    "created_at": "2019-01-12T09:04:43.619Z",
    "updated_at": "2019-01-12T09:04:43.619Z",
    "address": {
      "full_name": "Ship Co",
      "company": "Ship&Co",
      "address1": "chukyo-ku",
      "address2": "",
      "extra": "",
      "city": "Kyoto-shi",
      "province": "Kyoto-fu",
      "zip": "123-4567",
      "country": "JP",
      "phone": "0312345678",
      "email": "shipco@shipandco.com"
    }
  }
]

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

リクエスト

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

レスポンス

登録されている荷受人住所の情報の配列です。

倉庫

倉庫の登録

curl -v -X POST "https://api.shipandco.com/v1/warehouses" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json" \
  -d '{
   "full_name": "",
   "full_name_kanji": "",
   "company": "ACME",
   "company_kanji": "株式会社ACME",
   "email": "",
   "phone": "090-1234-5678",
   "country": "JP",
   "address1": "HIGASHIYAMA KU",
   "address2": "SAIKAISHICHO",
   "province": "KYOTO",
   "address1_kanji": "京都市東山区",
   "address2_kanji": "西海子町",
   "extra_kanji": "",
   "province_kanji": "京都府",
   "zip": "604-0012",
   "city": "KYOTO SHI"
}'

{
  "id": "cki5wYEHddBZuEtPv",
  "created_at": "2019-01-31T07:34:25.071Z",
  "updated_at": "2019-01-31T07:34:25.071Z",
  "address": {
    "full_name": "",
    "company": "ACME",
    "address1": "HIGASHIYAMA KU",
    "address2": "SAIKAISHICHO",
    "city": "KYOTO SHI",
    "province": "KYOTO",
    "zip": "604-0012",
    "country": "JP",
    "phone": "090-1234-5678",
    "email": "",
    "full_name_kanji": "",
    "company_kanji": "株式会社ACME",
    "address1_kanji": "京都市東山区",
    "address2_kanji": "西海子町",
    "extra_kanji": "",
    "province_kanji": "京都府"
  }
}

荷送人情報（倉庫）を登録します。

リクエスト

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

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

レスポンス

登録された荷送人情報をIDと共に表示します。

倉庫の一覧

curl -v -X GET "https://api.shipandco.com/v1/warehouses" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

[
  {
    "id": "cki5wYEHddBZuEtPv",
    "created_at": "2019-01-31T07:34:25.071Z",
    "updated_at": "2019-01-31T07:34:25.071Z",
    "address": {
      "full_name": "",
      "company": "ACME",
      "address1": "HIGASHIYAMA KU",
      "address2": "SAIKAISHICHO",
      "city": "KYOTO SHI",
      "province": "KYOTO",
      "zip": "604-0012",
      "country": "JP",
      "phone": "090-1234-5678",
      "email": "",
      "full_name_kanji": "",
      "company_kanji": "株式会社ACME",
      "address1_kanji": "京都市東山区",
      "address2_kanji": "西海子町",
      "extra_kanji": "",
      "province_kanji": "京都府"
    }
  },
  {
    "id": "phuAH6qFvoxdASoCr",
    "created_at": "2019-01-31T07:37:46.332Z",
    "updated_at": "2019-01-31T07:37:46.332Z",
    "address": {
      "full_name": "John Doe",
      "company": "ACME",
      "address1": "Rua Maria Matos, 32",
      "address2": "",
      "extra": "",
      "city": "CHARNECA DA CAPARICA",
      "province": "SETUBAL",
      "zip": "2820-344",
      "country": "PT",
      "phone": "0901231234",
      "email": "john@doe.io"
    }
  }
]

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

リクエスト

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

レスポンス

登録されている荷送人情報の配列です。

イメージファイル

ファイルのアップロード

curl -v -X POST "https://api.shipandco.com/v1/files" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json" \
  -d '{
   "type": "logo",
   "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAAAoCAMAAAA/pq9xAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyVpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDYuMC1jMDA2IDc5LjE2NDY0OCwgMjAyMS8wMS8xMi0xNTo1MjoyOSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIDIyLjIgKE1hY2ludG9zaCkiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MjMxNTMyODc2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MjMxNTMyODg2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoyMzE1MzI4NTY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoyMzE1MzI4NjY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PhUt+OUAAAAMUExURf38/C4pKv9WHreppVucDhcAAAHiSURBVHjatFfZtoQgDCvk//95pDvrwxxgPApcbUhaopfo2IBav4OetS94aw3mFUTNDQ9JMI/2e8oCz/RCJ9QbDA8OIfKiunKujcg9EHwtMEK5i3J1iYiw9WZx1aH1f3jCI8LeZDJiuFycdrzBSIm/VcCoGxRcNK56aHiPgWu1dYTAY4x/w2PuHyCAUprVtA7fzRcZfKd2IFuSd+Up7tqTdVldoKKtRWxnvsg0d7lxiAJHkaC2DkHayxZxOhA7l4SibMnPolNxbrvdwivm5ZBEdCYBAlvDAiTjudvOnw6mhVPgyIkJDJbXvAeJ7GPUSwTRR7mH4hwsumFZfk9MtF7XOVEQT8HIRCjO+g9M0us26xUogTEnnmcoannDZHJE54K0+JmJE42UbJkM75Bh6BmgzCHXt0Zr8MecYIGiQmMAyTnpJUI5V1eXiXHD2yafNuO40nKsLnSeeN7xWIAUNSreMpGbko0mvudqHhHcnGZbQQJh75L73McK9V3dJjBvT/npzW1l5St7GizZPAWiWTLKR//2+Cvw3tfcQQSjAbc8/slVBuRTVjrk9ggNpXeBzpKnQNCbYaDa0Xk7kCcNFIQjN8uhPuQkHNqQKeFlbOyY9KQkCkw0kxEwxDTnI12+r+EnwAA0EQvTI8JTUwAAAABJRU5ErkJggg=="
}'

{
  "id": "phuAH6qFvoxdASoCr",
  "type": "logo",
  "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAAAoCAMAAAA/pq9xAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyVpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDYuMC1jMDA2IDc5LjE2NDY0OCwgMjAyMS8wMS8xMi0xNTo1MjoyOSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIDIyLjIgKE1hY2ludG9zaCkiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MjMxNTMyODc2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MjMxNTMyODg2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoyMzE1MzI4NTY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoyMzE1MzI4NjY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PhUt+OUAAAAMUExURf38/C4pKv9WHreppVucDhcAAAHiSURBVHjatFfZtoQgDCvk//95pDvrwxxgPApcbUhaopfo2IBav4OetS94aw3mFUTNDQ9JMI/2e8oCz/RCJ9QbDA8OIfKiunKujcg9EHwtMEK5i3J1iYiw9WZx1aH1f3jCI8LeZDJiuFycdrzBSIm/VcCoGxRcNK56aHiPgWu1dYTAY4x/w2PuHyCAUprVtA7fzRcZfKd2IFuSd+Up7tqTdVldoKKtRWxnvsg0d7lxiAJHkaC2DkHayxZxOhA7l4SibMnPolNxbrvdwivm5ZBEdCYBAlvDAiTjudvOnw6mhVPgyIkJDJbXvAeJ7GPUSwTRR7mH4hwsumFZfk9MtF7XOVEQT8HIRCjO+g9M0us26xUogTEnnmcoannDZHJE54K0+JmJE42UbJkM75Bh6BmgzCHXt0Zr8MecYIGiQmMAyTnpJUI5V1eXiXHD2yafNuO40nKsLnSeeN7xWIAUNSreMpGbko0mvudqHhHcnGZbQQJh75L73McK9V3dJjBvT/npzW1l5St7GizZPAWiWTLKR//2+Cvw3tfcQQSjAbc8/slVBuRTVjrk9ggNpXeBzpKnQNCbYaDa0Xk7kCcNFIQjN8uhPuQkHNqQKeFlbOyY9KQkCkw0kxEwxDTnI12+r+EnwAA0EQvTI8JTUwAAAABJRU5ErkJggg=="
}

ファイルは、Base64フォーマットでエンコードされたJPEGまたはPNGに限ります。

リクエスト

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

アップロードするファイルデータです。

レスポンス

アップロードされたファイルのID情報です。

ファイルのリストアップ

curl -v -X GET "https://api.shipandco.com/v1/files" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

[
  {
    "id": "cki5wYEHddBZuEtPv",
    "type": "signature",
    "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAAAoCAMAAAA/pq9xAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyVpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDYuMC1jMDA2IDc5LjE2NDY0OCwgMjAyMS8wMS8xMi0xNTo1MjoyOSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIDIyLjIgKE1hY2ludG9zaCkiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MjMxNTMyODc2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MjMxNTMyODg2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoyMzE1MzI4NTY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoyMzE1MzI4NjY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PhUt+OUAAAAMUExURf38/C4pKv9WHreppVucDhcAAAHiSURBVHjatFfZtoQgDCvk//95pDvrwxxgPApcbUhaopfo2IBav4OetS94aw3mFUTNDQ9JMI/2e8oCz/RCJ9QbDA8OIfKiunKujcg9EHwtMEK5i3J1iYiw9WZx1aH1f3jCI8LeZDJiuFycdrzBSIm/VcCoGxRcNK56aHiPgWu1dYTAY4x/w2PuHyCAUprVtA7fzRcZfKd2IFuSd+Up7tqTdVldoKKtRWxnvsg0d7lxiAJHkaC2DkHayxZxOhA7l4SibMnPolNxbrvdwivm5ZBEdCYBAlvDAiTjudvOnw6mhVPgyIkJDJbXvAeJ7GPUSwTRR7mH4hwsumFZfk9MtF7XOVEQT8HIRCjO+g9M0us26xUogTEnnmcoannDZHJE54K0+JmJE42UbJkM75Bh6BmgzCHXt0Zr8MecYIGiQmMAyTnpJUI5V1eXiXHD2yafNuO40nKsLnSeeN7xWIAUNSreMpGbko0mvudqHhHcnGZbQQJh75L73McK9V3dJjBvT/npzW1l5St7GizZPAWiWTLKR//2+Cvw3tfcQQSjAbc8/slVBuRTVjrk9ggNpXeBzpKnQNCbYaDa0Xk7kCcNFIQjN8uhPuQkHNqQKeFlbOyY9KQkCkw0kxEwxDTnI12+r+EnwAA0EQvTI8JTUwAAAABJRU5ErkJggg=="
  },
  {
    "id": "phuAH6qFvoxdASoCr",
    "type": "logo",
    "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAAAoCAMAAAA/pq9xAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyVpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDYuMC1jMDA2IDc5LjE2NDY0OCwgMjAyMS8wMS8xMi0xNTo1MjoyOSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIDIyLjIgKE1hY2ludG9zaCkiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MjMxNTMyODc2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MjMxNTMyODg2ODU2MTFFQkE2NDFFODc1MTVGQUYyMzUiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoyMzE1MzI4NTY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoyMzE1MzI4NjY4NTYxMUVCQTY0MUU4NzUxNUZBRjIzNSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PhUt+OUAAAAMUExURf38/C4pKv9WHreppVucDhcAAAHiSURBVHjatFfZtoQgDCvk//95pDvrwxxgPApcbUhaopfo2IBav4OetS94aw3mFUTNDQ9JMI/2e8oCz/RCJ9QbDA8OIfKiunKujcg9EHwtMEK5i3J1iYiw9WZx1aH1f3jCI8LeZDJiuFycdrzBSIm/VcCoGxRcNK56aHiPgWu1dYTAY4x/w2PuHyCAUprVtA7fzRcZfKd2IFuSd+Up7tqTdVldoKKtRWxnvsg0d7lxiAJHkaC2DkHayxZxOhA7l4SibMnPolNxbrvdwivm5ZBEdCYBAlvDAiTjudvOnw6mhVPgyIkJDJbXvAeJ7GPUSwTRR7mH4hwsumFZfk9MtF7XOVEQT8HIRCjO+g9M0us26xUogTEnnmcoannDZHJE54K0+JmJE42UbJkM75Bh6BmgzCHXt0Zr8MecYIGiQmMAyTnpJUI5V1eXiXHD2yafNuO40nKsLnSeeN7xWIAUNSreMpGbko0mvudqHhHcnGZbQQJh75L73McK9V3dJjBvT/npzW1l5St7GizZPAWiWTLKR//2+Cvw3tfcQQSjAbc8/slVBuRTVjrk9ggNpXeBzpKnQNCbYaDa0Xk7kCcNFIQjN8uhPuQkHNqQKeFlbOyY9KQkCkw0kxEwxDTnI12+r+EnwAA0EQvTI8JTUwAAAABJRU5ErkJggg=="
  }
]

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

リクエスト

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

レスポンス

アップロードされたファイルの配列です。

サブユーザー

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

Diagram

サブユーザーの登録

curl -v -X POST "https://api.shipandco.com/v1/sub-users" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json" \
  -d '{
    "contact": {
      "first_name": "John",
      "last_name": "Doe",
      "company": "ACME"
    },
    "email": "email@test.com",
    "api_token": true
}'

{
  "id": "f1f97cfa813c828a73528989da671a81",
  "created_at": "2019-02-25T11:12:14.021Z",
  "email": "email@test.com",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
  "first_name": "John",
  "last_name": "Doe",
  "company": "ACME"
}

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

リクエスト

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

登録するサブユーザーの情報です。サブユーザーを作成するのはメールアドレスと最小限の連絡情報が必要です。

項目	説明
email	必須です。サブユーザーのキーとなります。
contact	first_name, last_name, full_name（任意）, company
api_token	トークンを生成するかどうかです。

※動作するサンプルリクエストはPostmanをご参照ください。

レスポンス

登録されたサブユーザーの情報をIDとAPIトークンと共に表示します。生成されたAPIトークンは他のAPIに利用できます。

サブユーザーの一覧

curl -v -X GET "https://api.shipandco.com/v1/sub-users" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

[
  {
    "id": "f1f97cfa813c828a73528989da671a81",
    "created_at": "2019-02-25T11:12:14.021Z",
    "email": "email@test.com",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
    "first_name": "John",
    "last_name": "Doe",
    "company": "ACME"
  },
  {
    "id": "929ab359ada3fa5c7bf53bff7ffcbe58",
    "created_at": "2019-02-26T11:08:13.749Z",
    "email": "email2@test.com",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjUzam9qand4ejlQdWZzRXp4IiwiaWF0IjoxNTUxMTc5MjkzfQ.RLb2jWjwo9FZwP3MSyyDYkbQZMTtmjMvTYql-dfgk1o",
    "first_name": "John 2",
    "last_name": "Doe 2",
    "company": "ACME 2"
  }
]

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

リクエスト

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

レスポンス

登録されているサブユーザー情報の配列です。

サブユーザーの取得

curl -v -X GET "https://api.shipandco.com/v1/sub-users/f1f97cfa813c828a73528989da671a81" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

{
  "id": "f1f97cfa813c828a73528989da671a81",
  "created_at": "2019-02-25T11:12:14.021Z",
  "email": "email@test.com",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
  "first_name": "John",
  "last_name": "Doe",
  "company": "ACME"
}

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

リクエスト

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

レスポンス

一つのサブユーザーを返します。

サブユーザーの最新化

curl -v -X POST "https://api.shipandco.com/v1/sub-users/f1f97cfa813c828a73528989da671a81" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMTc5OTgyfQ.sQChZ4DjIPyDbgOmJ2-jUgMe_xw9d52-TBGizg9lPjo"
}

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

リクエスト

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

レスポンス

再生成されたAPIトークン

サブユーザーの削除

curl -v -X DELETE "https://api.shipandco.com/v1/sub-users/f1f97cfa813c828a73528989da671a81" \
  -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
  -H "Content-Type: application/json"

"Child user f1f97cfa813c828a73528989da671a81:email@test.com deleted."

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

リクエスト

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

レスポンス

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

共通定義

運送会社とサービス

運送会社	値	サービスの値	海外 / 国内
日本郵便海外	`japanpost`	`japanpost_ems`, `japanpost_ems_document`, `japanpost_epacket`, `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`	海外
日本郵便国内（ゆうパック）	`yuupack`	`yuupack_regular`, `yuupack_fresh`, `yuupack_frozen`	国内
日本郵便国内（ゆうパケット）	`yuupacket`	`yuupacket_regular`	国内
UPS	`ups`	`ups_saver`, `ups_worldwide_express`, `ups_worldwide_express_plus`, `ups_worldwide_expedited`	海外
DHL	`dhl`	`dhl_express_worldwide`, `dhl_express_1200`, `dhl_express_0900`, `dhl_express_jumbo`	海外
FedEx	`fedex`	`fedex_international_economy`, `fedex_international_first`, `fedex_international_priority`, `fedex_international_priority_express`, `fedex_international_priority_eod`,`fedex_international_connect_plus`	海外
佐川急便	`sagawa`	`sagawa_fresh`, `sagawa_frozen`, `sagawa_plane`, `sagawa_regular`	国内
ヤマト運輸	`yamato`	`yamato_regular`, `yamato_collect`, `yamato_direct_mail`, `yamato_time`, `yamato_freight_on_delivery`, `yamato_nekopos`, `yamato_taqbin`, `yamato_taqbin_collect`	国内
ペガサス	`pegasus`	`pegasus_dhl`, `pegasus_ups`,`pegasus_ems`	海外
カスタム便（運送会社のアカウント設定無しの配送や、追跡情報を使わないメール便などの配送に使用可）	`custom`	`custom_standard`	国内

運送会社	荷物サイズの値	配達時間の値
佐川急便	`60`, `80`, `100`, `140`, `160`	`not-specified`, `before-noon`, `12-14`, `14-16`, `16-18`, `18-20`, `19-21`, `18-21`
日本郵便国内（ゆうパック）	`60`, `80`, `100`, `120`, `140`, `160`, `170`	`not-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` (`yamato_time`のサービスのみ有効), `before-five` (`yamato_time`のサービスのみ有効)

項目	説明	海外 / 国内
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`、`yamato_direct_mail`、`yamato_nekopos`にのみ有効。	国内
shipping_fee	数値。配送料金。PDF形式の出荷インボイス/納品書に反映されます。	海外, 国内
security_service	ブーリアン型。trueまた false。yuupack_regular にのみ有効。	国内

GETパラメータ

項目	説明
limit	初期値 `50`, 最大値 `250`
page	初期値 `1`
created_after	書式 `2018-09-20T00:00:00.000Z`
created_before	初期値 `today` 書式 `2018-09-20T00:00:00.000Z`

GETレスポンス

項目	説明
count	データ数
pages	レスポンスのページ数（GETパラメータで指定可能）
current_page	レスポンスの現在ページ（GETパラメータで指定可能）

呼び出し制限

単位時間内のAPI呼び出しの数には制限があります。それを超えた場合は、`リクエスト数が多すぎます`のエラーが発生します。それを避けるために以下のレスポンスヘッダーの項目で制限の詳細を確認することができます。

項目	説明
x-api-call-limit	APIの残りの呼び出し可能数/単位時間あたりの最大呼び出し可能数。呼び出し可能数が0になった後にAPIを呼び出すと上記のエラーが発生します
x-api-call-reset	上記の残りの呼び出し可能数が最大呼び出し可能数にリセットされる日時

エラー

エラーコード

Ship&Co APIには以下のエラーコードがあります。

正常時には200を返します。

エラーコード	説明
400	不正な入力または入力不足によるエラー
403	APIトークンが未指定か間違っています
404	指定されたデータが見つかりません
429	リクエスト数が多すぎます（詳細は呼び出し制限を参照してください)
500	内部エラー

エラーレスポンス

{
  "debug_id": "err_8953pxowmMt3YW2XQ",
  "message": "INVALID",
  "description": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "link": "https://developer.shipandco.com",
  "details": [
    {
      "field": "address1",
      "issue": "address1 is required"
    },
    {
      "field": "country",
      "issue": "country is required"
    }
  ],
}

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

項目	説明
debug_id	各APIのコール毎に一意のIDでShip&Coと連絡を取るために使います
message	エラーの短い説明です
description	エラーの長い説明です
link	エラー情報へのリンクです
details	各項目毎のエラー詳細です

概要

このドキュメントの想定読者

APIの処理概要

免責事項

認可

出荷

出荷情報の作成

リクエスト

レスポンス

出荷情報の一覧

リクエスト

レスポンス

出荷情報の取得

リクエスト

レスポンス

出荷情報の削除

リクエスト

レスポンス

料金

料金の一覧

リクエスト

レスポンス

運送会社

運送会社の登録

リクエスト

運送会社ごとの認証情報

DHL

UPS

FedEx

日本郵便 海外

佐川急便

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

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

ヤマト運輸

ペガサス

運送会社ごとの設定

DHL

UPS

FedEx

日本郵便 海外

佐川急便

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

ヤマト運輸

レスポンス

運送会社の一覧

リクエスト

レスポンス

運送会社の更新

リクエスト

レスポンス

運送会社の削除

リクエスト

レスポンス

追跡情報

追跡情報の取得

リクエスト

レスポンス

住所

住所の登録

リクエスト

レスポンス

住所の一覧

リクエスト

レスポンス

倉庫

倉庫の登録

リクエスト

レスポンス

倉庫の一覧

リクエスト

レスポンス

イメージファイル

ファイルのアップロード

リクエスト

レスポンス

ファイルのリストアップ

リクエスト

レスポンス

サブユーザー

サブユーザーの登録

日本郵便海外

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

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

日本郵便海外

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