Ship&Coの追跡情報APIをつかって、配送状況を取得する

この記事では、Ship&CoのAPIを使って、荷物が発送された後の追跡情報をAPIを使ってシステム連携する方法について説明します。

1. tracking APIを呼び出す準備をする

こちらの記事を参考にして、https://app.shipandco.com/api/v1/tracking/:carrier/:trackingNumberにGETするURLを作成します。

• :carrerは、運送会社とサービスで定義されているcarrierを指定します。

• :trackingNumberは、上記で指定した運送会社から発行された追跡番号を指定します。

https://app.shipandco.com/api/v1/tracking/japanpost/RN00*********JP

2. APIを実行する

上記で作成したURLをもとに、APIを実行します。成功すると、下記のような追跡情報のレスポンスが返されます。

{
    "requested_at": "2020-10-26T15:54:40.711Z",
    "carrier": "japanpost",
    "tracking_number": "RX068331915JP",
    "service": "国際書留・保険付書状",
    "from_address": {},
    "to_address": {},
    "current_status": {
        "date": "2020-10-23T21:20:00.000Z",
        "status": "transit",
        "details": "国際交換局から発送",
        "location": "東京都 138-8799"
    },
    "history": [
        {
            "date": "2020-10-22T07:09:00.000Z",
            "status": "collected",
            "details": "引受",
            "location": "岐阜県 501-3299"
        },
        {
            "date": "2020-10-22T19:49:00.000Z",
            "status": "transit",
            "details": "国際交換局に到着",
            "location": "東京都 138-8799"
        },
        {
            "date": "2020-10-23T21:20:00.000Z",
            "status": "transit",
            "details": "国際交換局から発送",
            "location": "東京都 138-8799"
        }
    ]
}

3. 追跡情報を使ったユースケース

このAPIを使ったユースケースとして以下のようなことが考えられます。

• 自社サービスやシステムに配送状況の表示機能を組み込む
• 配送ステータスが配達済み（"delivered"）になった場合や何日も変化しない場合に通知を出す

その他の注意点や情報

• 追跡情報のAPIは現在無料で利用できますが、Ship&Coの主な利用用途は送り状の作成です。追跡情報の取得のみのご利用はご遠慮いただいております。