自社システムに導入可能なAPIのご紹介

開発ドキュメントリンク(2024.11.11)

https://app.shippsys.com/develop.v.last

APIで自社システムに送り状発行機能を実装できます。

SHIPPSYS_APIを連携すれば、各運送会社の送り状発行に必要な機能が組み込まれているため、開発コストを抑え、短期間で導入が可能です。コスト削減と効率向上に最適!

リアルタイムで送り状を発行し、作業時間とミスを大幅に減らします。

SHIPPSYS_APIを導入すれば、自社システムから直接送り状を発行でき、追跡番号も自動的に取得できるため、出荷作業の効率を大きく向上させることが可能です。

送り状データアップ

/put/

複数の送り状情報をアップすることができます。

リクエストデータ構造
[
{"deli_code_type":"〇","deli_code":"〇","deli_phone":"〇","deli_postcode":"〇","deli_address1":"〇",...},
{"deli_code_type":"〇","deli_code":"〇","deli_phone":"〇","deli_postcode":"〇","deli_address1":"〇",...},
...
]

送り状データ変更

/update/

複数の送り状情報を変更することができます。

リクエストデータ構造
[
{"deli_code_type":"〇","deli_code":"〇","deli_phone":"〇","deli_postcode":"〇","deli_address1":"〇",...},
{"deli_code_type":"〇","deli_code":"〇","deli_phone":"〇","deli_postcode":"〇","deli_address1":"〇",...},
...
]

送り状ファイル取得

/{client_key}/{service_type}/pdfs4print/{customer_number}.pdf

お客様管理番号で送り状ファイル(PDF)を取得することができます。

送り状ステータス取得

/get_status/

追跡番号などを含め送り状の最新情報を取得することができます。
作成失敗の場合、エラーメッセージが返されます。

リクエストデータ構造
[
"customer_number1",
"customer_number2",
"customer_number3",
...
]

レスポンスデータ構造
{
"result":1,(1:成功;0:失敗)
"message":"some message",
"data":
[
{"customer_number":"〇","tracking_number":"〇","status":"〇","error_message":"〇"},
{"customer_number":"〇","tracking_number":"〇","status":"〇","error_message":"〇"},
{"customer_number":"〇","tracking_number":"〇","status":"〇","error_message":"〇"},
...
]
}

輸送状況取得

/get_delivery_status/

荷物の輸送状況を取得することができます。

運賃情報取得

/get_billing_info/

荷物の運賃情報を取得することができます。

リクエストデータ構造
[
"customer_number1",
"customer_number2",
"customer_number3",
...
]

レスポンスデータ構造
{
"result":1,(1:成功;0:失敗)
"message":"some message",
"data":
[
{"customer_number":"〇","tracking_number":"〇","billing_fee_total":"〇"},
{"customer_number":"〇","tracking_number":"〇","billing_fee_total":"〇"},
{"customer_number":"〇","tracking_number":"〇","billing_fee_total":"〇"},
...
]
}

WebHook機能

/endpoint/

指定したURLに結果を送信する。
成功した場合は追跡番号が返され、失敗した場合は失敗の理由が返されます。

リクエストデータ構造
{
"result":1,(1:成功;0:失敗)
"data":{
"client_key":"○○○○",
"channel_id":"○○○○",
"customer_number":"○○○○",
"tracking_number":"○○○○"(成功)
"error_message":"○○○○"(失敗)
}
}

上部へスクロール