船荷を扱う

MonCargo に船荷を登録することで、コンテナの ETA などの情報を自動的にトラッキングすることが可能になります。

船荷を登録する

次のリクエストを送信して、船荷を登録します。

curl -XPOST https://api.moncargo.io/v1/shipments \
    -u api:YOUR_API_KEY \
    -H 'Content-Type: application/json' \
    -d '{
      "trackingNumber": "ONEU9123614",
      "trackingType": "CONTAINER_NUMBER",
      "shippingLine": "ONE",
      "title": "My First Shipment Tracking from API"
    }'

このようなレスポンスが返ってくると、リクエストは成功しています。

{
  "id": "da97e525-fa5f-475d-9387-b1fde4dbfff0",
  "userId": "0f3eaf51-f43f-42fa-89bc-535fff59cd7d",
  "trackingNumber": "ONEU9123614",
  "trackingType": "CONTAINER_NUMBER",
  "shippingLine": "ONE"
  // ...
}

詳細な入出力に関しては、 APIリファレンスを参照してください。

船荷一覧を表示する

次のリクエストを送信して、登録された船荷を一覧で表示できます。

curl -XGET 'https://api.moncargo.io/v1/shipments?page=1' \
    -u api:YOUR_API_KEY

このようなレスポンスが返ってくると、リクエストは成功しています。

{
  "data": [
    {
      "id": "da97e525-fa5f-475d-9387-b1fde4dbfff0",
      "trackingNumber": "ONEU9123614",
      "trackingType": "CONTAINER_NUMBER"
      // ...
    }
  ],
  "pagination": {
    "totalCount": 1,
    "totalPages": 1,
    "perPage": 20,
    "currentPage": 1
  }
}

現在追跡中の船荷だけ取得する方法

クエリに isArchived=false を設定してください。

curl -XGET 'https://api.moncargo.io/v1/shipments?page=1&isArchived=false' \
    -u api:YOUR_API_KEY

ページネーションについて

一度に表示できるのは20件です。それ以降を読み込む場合は、 page パラメーターを変更してください。

例: 2ページ目を取得する

curl -XGET 'https://api.moncargo.io/v1/shipments?page=2' \
    -u api:YOUR_API_KEY

他にも、多様な条件で絞り込むことができます。詳細な入出力に関しては、 APIリファレンスを参照してください。

船荷を表示する

次のリクエストを送信して、登録された船荷の詳細情報を表示できます。

curl -XGET https://api.moncargo.io/v1/shipments/da97e525-fa5f-475d-9387-b1fde4dbfff0 \
    -u api:YOUR_API_KEY

このようなレスポンスが返ってくると、リクエストは成功しています。

{
  "id": "da97e525-fa5f-475d-9387-b1fde4dbfff0",
  "trackingNumber": "ONEU9123614"
  // 以下省略
}

船荷の更新履歴を表示する

次のリクエストを送信して、登録された船荷の詳細情報及び更新履歴を表示できます。

curl -XGET 'https://api.moncargo.io/v1/shipments/da97e525-fa5f-475d-9387-b1fde4dbfff0/shipment_histories?page=1' \
    -u api:YOUR_API_KEY

このようなレスポンスが返ってくると、リクエストは成功しています。

{
  "data": [
    {
      "id": "9f3c41f9-b917-4f08-a69f-adea79c7e2e6",
      "status": "success",
      "createdAt": "2023-04-17T15:23:24.599Z",
      "pol": "Nouakchott",
      "pod": "Fangcheng",
      "etd": "2023/02/27 11:40:00",
      "eta": "2023/04/15 00:00:00",
      "currentVesselName": "YONG SHI FENG 183 / 0413"
    }
  ],
  "pagination": {
    "totalCount": 1,
    "totalPages": 1,
    "perPage": 20,
    "currentPage": 1
  }
}

船荷を更新する

次のリクエストを送信して、登録された船荷を更新できます。

curl -XPATCH https://api.moncargo.io/v1/shipments/da97e525-fa5f-475d-9387-b1fde4dbfff0 \
    -u api:YOUR_API_KEY \
    -H 'Content-Type: application/json' \
    -d '{
      "title": "My Shipment",
      "remark": "My Comment, any text here"
    }'

このようなレスポンスが返ってくると、リクエストは成功しています。

{
  "id": "da97e525-fa5f-475d-9387-b1fde4dbfff0",
  "trackingNumber": "ONEU9123614"
  // 以下省略
}

詳細な入出力に関しては、 APIリファレンスを参照してください。

船荷を削除する

次のリクエストを送信して、登録された船荷を削除できます。

curl -XDELETE https://api.moncargo.io/v1/shipments/da97e525-fa5f-475d-9387-b1fde4dbfff0 \
    -u api:YOUR_API_KEY

このようなレスポンスが返ってくると、リクエストは成功しています。

{
  "id": "da97e525-fa5f-475d-9387-b1fde4dbfff0",
  "trackingNumber": "ONEU9123614"
  // 以下省略
}