※LinkPrint CLOUD Web APIの概要や本記事内に記載されている用語についての説明はこちらをご確認ください。
送り状発⾏
「送り状発行API③：ファイルアップロード＆確認」で取得した「ファイル管理用ID」を使用し、送り状を発行します。
| URL |
https://www.lpcloud.jp/okr_api/issue_shipping_label/ |
| POST情報 |
＜API認証情報＞
| キー |
値 |
| *api_key_info |
利用する運送会社のAPI認証情報を指定します。指定可能なキーは以下のとおりです。
佐川急便：sagawa
ヤマト運輸：yamato
西濃運輸：seinou
※json⽂字列で指定
| キー |
値 |
| sagawa |
| キー |
値 |
| customerId |
カスタマーID |
| loginPassword |
ログインパスワード |
|
| yamato |
| キー |
値 |
| ymtAccessToken |
APIアクセス認証キー（認証トークン） |
|
| seinou |
|
|
| キー |
値 |
| *user_id |
ログインID |
| *access_token |
ログイン時に取得した「access_token」 |
| *api_key |
APIキー |
| *receipt_file_id |
ファイル管理⽤ID |
| company_ids |
利⽤する運送会社ID
※json⽂字列で指定
指定なし：全運送会社が対象、 佐川だけ、ヤマトだけの場合は対象の運送会社IDを指定
例：”[“1″]”
運送会社IDは「Web API導入について」をご確認ください。
|
| yamato_print_param |
ヤマト用 送り状発⾏時のパラメータを指定。指定が無い場合は標準の値となります。
※json⽂字列で指定
| print_type |
印刷する送り状種類を指定 標準 : m5 |
| print_position |
印刷位置を指定 標準 : 0 |
| sort1 |
印刷の順序を指定 標準 : 指定なし |
| sort2 |
印刷の順序を指定 標準 : 指定なし |
| sort3 |
印刷の順序を指定 標準 : 指定なし |
※印刷順序を指定する場合、sort1、sort2、sort3 必ず全てを指定してください。 |
| file_extension |
西濃運輸用 発行する送り状のファイル形式を指定。指定が無い場合は0（PDF）が設定されます。
（PDF：0、WBP：1）
※「WBP」は西濃運輸の印刷システムで使用される専用の印刷用ファイル形式です。
|
|
| 戻り値 |
json⽂字列で返します。
| キー |
値 |
| issue_result |
送り状発行結果を運送会社ごとに返します。
| キー |
値 |
| (運送会社ID) |
|
| ⇒ result |
“success” or “error” |
| ⇒ error_infos |
エラーメッセージ |
|
| msg |
システムエラー等、上記以外のエラーが発生した際にエラーメッセージを返します。 |
| is_expired |
「access_token」の有効期限切れの際に「1」を返します。
※「is_expired」が「1」の場合は、システム内に保管されている「access_token」の有効期限が過ぎている状態になっています。システム内に保管されている「access_token」の値を空にし、再度ログインを実施してください。
|
|
「*」 このマークが付いている項目は必須項目です。
＜ヤマトB2クラウドAPI＞
毎日25時から7時までメンテナンス時間となっていますため、この間にアクセスされた場合は上記「msg」にメンテナンス中であることのメッセージを返します。
