NAV Navbar
cURL
  • 概要
  • 認可
  • 出荷
  • 料金
  • 共通定義
  • エラー
  • 概要

    Ship&Co APIドキュメントへようこそ!このドキュメントではShip&CoのAPIの使い方について説明します。

    Ship&Coのアカウント登録はこちら

    APIの使い方はとても簡単です。以下の2ステップで完了です。

    1. 認可
    2. API コール

    認可

    全てのAPIコールに以下のHTTPヘッダーを追加してください

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

    `YOUR_API_TOKEN_FROM_DASHBOARD`を取得したAPIトークンで置き換えてください

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

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

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

    Dashboard

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

    x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD

    出荷

    出荷情報の作成

    curl -v -X POST "https://app.shipandco.com/api/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",
          "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"
        },
        "parcels": [
          {
            "weight": 200,
            "amount": 1,
            "width": 10,
            "height": 10,
            "depth": 10
          }
        ],
        "products": [
          {
            "name": "Basket ball",
            "quantity": 2,
            "price": 4850,
            "hs_code": "HS9988",
            "hs_description": "Sports ball",
            "origin_country": "JP"
          }
        ],
        "setup": {
          "carrier": "japanpost",
          "service": "ems",
          "currency": "JPY",
          "date": "2018-07-12",
          "insurance": 0,
          "ref_number": "",
          "delivery_note": "",
          "discount": 0,
          "signature": false,
          "duty_paid": false,
          "content_type": "MERCHANDISE"
        }
      }'
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "carrier": "japanpost",
      "tracking": ["EN017194107JP"],
      "label": "https://storage.googleapis.com/dev-shipandco/labels/201807/PwsgMY4BnQPeQG65k/zkiqJYrPfQYRHbhEq.pdf"
    }
    

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

    リクエスト

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

    項目 説明
    to_address 荷受人住所です。
    from_address 発送人住所です。
    parcels 荷物情報です。
    products 製品情報です。
    setup 設定情報です。
    詳細は運送業者とサービスを参照してください。
    料金の一覧を利用して最適な`service`を探すこともできます。

    レスポンス

    項目 説明
    carrier 指定した運送会社の名称です。
    tracking 出荷の追跡番号です。
    label 作成されたラベルのイメージ情報です。

    出荷情報の一覧

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

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "count": 1,
      "shipments": [
        {
          "id": "API-A1B2C3D4E5",
          "state": "active",
          "created_at": "2018-09-17T22:55:03.308Z",
          "updated_at": "2018-09-17T22:54:50.086Z",
          "to_address": {
            "full_name": "Stephane SALEMA",
            "company": "Ship",
            "email": "stephane@bentoandco.com",
            "phone": "0901231234",
            "country": "PT",
            "address1": "Rua Quintinha da Foz, 32",
            "address2": "",
            "province": "SETUBAL",
            "zip": "2820-307",
            "city": "CHARNECA DA CAPARICA"
          },
          "from_address": {
            "full_name": "World Company",
            "company": "World Company",
            "email": "mike@worldcompany.com",
            "phone": "08012341234",
            "country": "JP",
            "address1": "OSAKAFU",
            "address2": "OTECHO",
            "province": "OSAKA",
            "zip": "5670883",
            "city": "IBARAKI SHI"
          },
          "parcels": [
            {
              "weight": 200,
              "amount": 1,
              "width": 10,
              "height": 10,
              "depth": 10
            }
          ],
          "options": {
            "common": {
              "insurance": 0,
              "ref_number": "",
              "delivery_note": "",
              "discount": 0
            },
            "international": {
              "return_label": false,
              "signature": false,
              "duty_paid": false,
              "content_type": "MERCHANDISE"
            }
          },
          "products": [
            {
              "name": "Basket ball",
              "quantity": 2,
              "price": 4850,
              "hs_code": "HS9988",
              "hs_description": "Sports ball",
              "origin_country": "JP",
              "selected": false,
              "state": "unfulfilled",
              "declared_price": 4850
            }
          ],
          "delivery": {
            "carrier": "japanpost",
            "method": "ems",
            "tracking_numbers": ["EN015672904JP"]
          }
        }
      ]
    }
    

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

    リクエスト

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

    レスポンス

    項目 説明
    shipments 作成した出荷情報の配列です。

    Get Shipment

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

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "id": "API-A1B2C3D4E5",
      "state": "active",
      "created_at": "2018-09-17T22:55:03.308Z",
      "updated_at": "2018-09-17T22:54:50.086Z",
      "to_address": {
        "full_name": "Stephane SALEMA",
        "company": "Ship",
        "email": "stephane@bentoandco.com",
        "phone": "0901231234",
        "country": "PT",
        "address1": "Rua Quintinha da Foz, 32",
        "address2": "",
        "province": "SETUBAL",
        "zip": "2820-307",
        "city": "CHARNECA DA CAPARICA"
      },
      "from_address": {
        "full_name": "World Company",
        "company": "World Company",
        "email": "mike@worldcompany.com",
        "phone": "08012341234",
        "country": "JP",
        "address1": "OSAKAFU",
        "address2": "OTECHO",
        "province": "OSAKA",
        "zip": "5670883",
        "city": "IBARAKI SHI"
      },
      "parcels": [
        {
          "weight": 200,
          "amount": 1,
          "width": 10,
          "height": 10,
          "depth": 10
        }
      ],
      "options": {
        "common": {
          "insurance": 0,
          "ref_number": "",
          "delivery_note": "",
          "discount": 0
        },
        "international": {
          "return_label": false,
          "signature": false,
          "duty_paid": false,
          "content_type": "MERCHANDISE"
        }
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": 2,
          "price": 4850,
          "hs_code": "HS9988",
          "hs_description": "Sports ball",
          "origin_country": "JP",
          "selected": false,
          "state": "unfulfilled",
          "declared_price": 4850
        }
      ],
      "delivery": {
        "carrier": "japanpost",
        "method": "ems",
        "tracking_numbers": ["EN015672904JP"]
      }
    }
    

    Find a Shipment with ID

    リクエスト

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

    レスポンス

    項目 説明
    shipments Returns only one Shipment

    料金

    料金の一覧

    curl -v -X POST "https://app.shipandco.com/api/v1/rates" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json" \
      -d '{
        "to_address": {
          "full_name": "Stephane SALEMA",
          "company": "Ship",
          "email": "stephane@bentoandco.com",
          "phone": "0901231234",
          "country": "PT",
          "address1": "Rua Quintinha da Foz, 32",
          "address2": "",
          "province": "SETUBAL",
          "zip": "2820-307",
          "city": "CHARNECA DA CAPARICA"
        },
        "from_address": {
          "full_name": "World Company",
          "company": "World Company",
          "email": "mike@worldcompany.com",
          "phone": "08012341234",
          "country": "JP",
          "address1": "OSAKAFU",
          "address2": "OTECHO",
          "province": "OSAKA",
          "zip": "5670883",
          "city": "IBARAKI SHI"
        },
        "parcels": [
          {
            "weight": 200,
            "amount": 1,
            "width": 10,
            "height": 10,
            "depth": 10
          }
        ],
        "products": [
          {
            "name": "Basket ball",
            "quantity": 2,
            "price": 4850,
            "hs_code": "HS9988",
            "hs_description": "Sports ball",
            "origin_country": "JP"
          }
        ],
        "setup": {
          "carrier": "jnpost",
          "currency": "JPY",
          "date": "2018-07-12",
          "insurance": 0,
          "ref_number": "",
          "delivery_note": "",
          "discount": 0,
          "signature": false,
          "duty_paid": false,
          "content_type": "MERCHANDISE"
        }
      }'
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "rates": [
        {
          "carrier": "japanpost",
          "service": "ems",
          "currency": "JPY",
          "price": 2200,
          "surcharges": []
        },
        {
          "carrier": "japanpost",
          "service": "kakitome",
          "currency": "JPY",
          "price": 690,
          "surcharges": []
        },
        {
          "carrier": "japanpost",
          "service": "epacket",
          "currency": "JPY",
          "price": 785,
          "surcharges": []
        },
        {
          "carrier": "japanpost",
          "service": "sal",
          "currency": "JPY",
          "price": 280,
          "surcharges": []
        },
        {
          "carrier": "japanpost",
          "service": "epacketlight",
          "currency": "JPY",
          "price": 620,
          "surcharges": []
        },
        {
          "carrier": "japanpost",
          "service": "airmail",
          "currency": "JPY",
          "price": 420,
          "surcharges": []
        }
      ]
    }
    

    作成する出荷情報を元に指定した運送業者のサービスごとの料金を一覧表示します。

    リクエスト

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

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

    レスポンス

    項目 説明
    rates 各サービスの料金の配列です。

    共通定義

    運送業者とサービス

    運送業者 サービスの値 国際 / 国内
    日本郵便 japanpost ems, epacket, epacketlight, kakitome, airparcel, salparcel, seaparcel 国際
    UPS ups Saver, Worldwide Express, Worldwide Expedited, Worldwide Express Plus 国際
    DHL dhl EXPRESS WORLDWIDE, EXPRESS 12:00, EXPRESS 9:00, EXPRESS JUMBO 国際
    FedEx fedex International Economy, International First, International Priority 国際
    佐川急便 sagawa fresh, frozen, plane, regular 国内

    エラー

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

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

    エラーコード 説明
    403 APIトークンが未指定か間違っています
    400 その他制御可能なエラー
    500 内部エラー