※LinkPrint CLOUD Web APIの概要や本記事内に記載されている用語についての説明はこちらをご確認ください。
ファイルアップロード＆確認
送り状発行に使用するデータをアップロードします。CSV、Excel、jsonデータの3種類の形式に対応しています。データの整合性チェック・各運送会社APIとの連携チェックを⾏います。
| URL |
https://www.lpcloud.jp/okr_api/uploadfile_check/ |
| POST情報 |
＜API認証情報＞
| キー |
値 |
| *api_key_info |
利用する運送会社のAPI認証情報を指定します。指定可能なキーは以下のとおりです。
佐川急便：sagawa
ヤマト運輸：yamato
西濃運輸：seinou
※json⽂字列で指定
| キー |
値 |
| sagawa |
| キー |
値 |
| customerId |
カスタマーID |
| loginPassword |
ログインパスワード |
| kokyakuCode |
顧客コード（佐川急便との契約コード。チェックデジットを含む） |
|
| yamato |
| キー |
値 |
| ymtApiUserId |
API連携会社コード |
| ymtAccessToken |
APIアクセス認証キー（認証トークン） |
| invoice_code |
請求先・顧客コード |
| invoice_code_ext |
請求先・分類コード |
| invoice_freight_no |
請求先・運賃管理番号 |
|
| seinou |
|
|
＜共通項目＞
| キー |
値 |
| *user_id |
ログインID |
| *access_token |
ログイン時に取得した「access_token」 |
| *api_key |
APIキー |
| *userfile_id |
連携ファイルID（例︓O45151） |
| sagawa_add_item |
佐川の項目に対する値を指定
※json⽂字列で指定
| backLayerFlg |
帳票の背景画像をPDFに表⽰させるかのフラグ 0/null/空⽩ ︓ 非表⽰、 1 ︓ 表⽰ |
例：”{“backLayerFlg”:”1″}” |
| company_ids |
利⽤する運送会社ID
※json⽂字列で指定
指定なし：全運送会社が対象、 佐川だけ、ヤマトだけの場合は対象の運送会社IDを指定
例：”[“1″]”
運送会社IDは「Web API導入について」をご確認ください。
|
| pre_receipt_file_id |
仮ファイル管理用ID
西濃運輸データのアップロード時にエラーが発生した場合に「戻り値」として返却される管理用ID。このIDを指定することで、エラーとなったデータを修正して再アップロードできます。
詳細は「Web API導入について」をご確認ください。 |
＜CSVを利用する場合＞
| キー |
値 |
| *print_data |
CSVファイル
[ファイルタイプ]
●カンマ区切り、タブ区切りのテキストファイル
1回のアップロードでは1ファイルのみアップロード可 |
| *print_text_info |
以下の情報を指定
| delimiter |
区切り文字の指定
カンマ区切り：comma
タブ区切り：tab
「comma」もしくは「tab」をご指定ください。 |
| title_row_no |
項目名（各列のタイトル）の開始行の番号
（テキストファイルの場合は、「1」を指定する場合が多いと推測します）
※項目名が無い場合は「0」を指定してください。
|
| title_col_no |
項目名（各列のタイトル）の開始列の番号
（テキストファイルの場合は、「1」を指定する場合が多いと推測します） |
上記情報をjson文字列にし、POSTします。
例：{“delimiter”:”comma”,”title_row_no”:”1″,”title_col_no”:”1″}
|
＜Excelファイルを利用する場合＞
| *print_data |
Excelファイル
1回のアップロードでは1ファイルのみアップロード可 |
| *print_excel_info |
以下の情報を指定
| sheetName |
シート名を指定ください。 |
| title_row_no |
項目名（各列のタイトル）の開始行の番号を指定してください。 |
| title_col_no |
項目名（各列のタイトル）の開始列の番号を指定してください。 |
上記情報をjson文字列にし、POSTします。
例：{“sheetName”:”Sheet1″,”title_row_no”:”1″,”title_col_no”:”1″}
|
＜jsonデータを利用する場合＞
| キー |
値 |
| *print_data_json |
jsonデータ
以下のように「title」と「data」部分に分けて形成してください。
{
"title":[
"住所","会社名","担当者名"
],
"data":[
["愛知県東区葵3ｰ14ｰ12","AA株式会社","山田太郎"],
["愛知県東区葵3ｰ14ｰ13","BB株式会社","山田次郎"]
]
}
|
|
| 戻り値 |
json⽂字列で返します。
| キー |
値 |
| receipt_file_id |
ファイル管理用ID（アップロードファイルのID）。他のAPIで使用します。
※エラーがない場合のみ返します。 |
| pre_receipt_file_id |
仮ファイル管理用ID。このIDが返却された場合は、エラーが発生した西濃運輸データが存在します。
該当データを修正のうえ、次回の再アップロード時にこのIDをあわせて指定してください。
詳細は「Web API導入について」をご確認ください。 |
| msg |
エラーが発生した際のエラーメッセージを返します。 |
| upload_data_msg |
アップロードされたデータに不備があれば、⾏列の情報やメッセージを返します。 |
| is_expired |
「access_token」の有効期限切れの際に「1」を返します。
※「is_expired」が「1」の場合は、システム内に保管されている「access_token」の有効期限が過ぎている状態になっています。システム内に保管されている「access_token」の値を空にし、再度ログインを実施してください。
|
|
「*」 このマークが付いている項目は必須項目です。
＜データ管理⽤ID＞
各運送会社の送り状番号（伝票番号）と紐づけるために、アップロードしていただくデータの1行ごとに一意の情報を指定していただく必要があります。送り状発行APIでは、この一意の情報のことを「データ管理用ID」と呼びます。
なお、データ管理⽤IDは各運送会社の以下の項目と対応付けを⾏った項目の値になります。
ヤマトB2クラウドAPI︓「お客様管理番号」
カンガルー・マジックⅡAPI：「お客さまの管理番号」
＜ヤマトB2クラウドAPI＞
毎日25時から7時までメンテナンス時間となっていますため、この間にアクセスされた場合は上記「msg」にメンテナンス中であることのメッセージを返します。
