Open Ship API
はじめに
このAPIは、「未処理出荷」を作成し、全ての出荷およびパッケージ情報を一度に入力するのではなく、一定期間にわたってパッケージを出荷に追加します。出荷は5日間未処理のままで維持することたできます。また、その期間、パッケージの追加と修正が可能で、出荷の確定後、ラベル、AWB、レポートなどの出荷書類を生成できます。尚、5日目の終わりに、出荷を確定するか、削除しなければなりません。
注意:「未処理出荷」は、「未処理出荷」から5日以内に確定されない場合は削除されます。
未処理出荷APIの詳細
未処理出荷APIは、複数個口貨物を一定期間出荷に追加する必要があり、追加する予定のパッケージの数や、出荷がいつ完了するかわからない場合に使用し、出荷の準備が整うまで、1日を通して柔軟に出荷を準備することができます。
未処理出荷貨物は、多くの場合、複数個口貨物ですが、一個口貨物と呼ばれる1つのパッケージの出荷もあります。
複数個口貨物(MPS)を一名の荷受人に出荷するには、未処理出荷APIを使用して個々のパッケージを出荷に追加するか、同じ荷受人に配送する場合は複数個口貨物を追加してください。
「未処理出荷」に関連するサービス:
- FedEx Express®米国内およびカナダ内
- FedEx Ground®米国内およびカナダ内
- FedEx Home Delivery®
- フェデックス・インターナショナル・プライオリティ®
- フェデックス・インターナショナル・プライオリティ®Express(IPE)
- フェデックス・インターナショナル・エコノミー ®
- FedEx Priority OvernightTM
- FedEx® Regional Economy
- FedEx® Regional Economy Freight
- FedEx International Connect Plus®
- FedEx® First
- FedEx Priority Express
- FedEx Priority
- FedEx Priority Express Freight
- FedEx Priority Freight
- FedEx Economy(英国のみ)
未処理出荷APIに関連する機能:
「未処理出荷」の管理
この機能により、荷送人は「未処理出荷」を作成、修正、削除でき、レビューまたは検証の目的で、作成済みの「未処理出荷」を取得できます。また、完了した出荷を確定して、出荷データをフェデックスに転送し、適切な出荷書類を生成することができます。尚、取引にエラーがあればそれを識別して報告し、適切な状態を提供することもできます。
この機能の重要な情報は、accountNumber、出荷データ、groupPackageCount、および出荷のマスターパッケージを示すインデックスです。この機能がもたらす結果により、出荷データがフェデックスシステムにアップロードされ、適切な追跡番号、ラベル、および出荷レポートが生成されます。
「未処理出荷」パッケージの管理
この機能は、作成済みの「未処理出荷」内のパッケージを追加、修正、および削除します。既存の「未処理出荷」の既存のパッケージを取得することもできます。
「未処理出荷」結果の取得(非同期)
この機能により、確定済みの出荷結果を非同期で取得できます。40個以上のパッケージを含む「未処理出荷」の確定後、APIは出荷を非同期処理します。
出荷の非同期処理後、貨物が正常に処理される場合とされない場合があります。このリクエストの応答では、正常に貨物がキューに入れられたことだけを確認することができます。尚、結果を取得するためのjobIdも返します。この機能は、jobIdを使用して、ラベル、出荷レポートなどのOpenShipment(未出荷貨物)結果(CREATE(作成)、MODIFY(変更)、およびCONFIRM(確定))を取得します。尚、貨物にエラーがあればそれを識別して報告し、適切な処理状況を提示します。
注意:非同期出荷応答にエラーが生じた場合は、エラーを修正して、新しい出荷リクエストを送信してください。
未処理出荷APIワークフロー
本章では、未処理出荷APIのワークフローについて詳しく説明します。未処理出荷ワークフローは、2つの方法または2つの処理オプションで管理されます。
40個以下のパッケージのワークフロー
- エンドポイント「「未処理出荷」の作成」を使用して、必要な全ての出荷、梱包情報、accountNumber、およびインデックスを含む「未処理出荷」を作成します。
- エンドポイント「「未処理出荷」パッケージの追加」を使用して、作成済みの「未処理出荷」に1個以上(40個以下)のパッケージを追加します。重要な入力は、パッケージが追加された「未処理出荷」のインデックスとaccountNumberです。
- エンドポイント「「未処理出荷」の確定」を使用して、全てのパッケージが追加され、出荷が完了したことを最終的に確定します。重要な入力は、インデックス、および確定する出荷のaccountNumberです。
エンドポイント「「未処理出荷」の確定」は、フローの最後のエンドポイントであり、出荷およびパッケージ情報を検証し、出荷のラベルおよびその他全てのレポートを正常に生成します。また、検証中に返されるエラーの詳細も提供します。エラーは、エンドポイント「「未処理出荷」の修正」または「「未処理出荷」パッケージの修正」を使用して修正し、リクエストが成功するかどうか出荷を再度確定できます。
40個以上のパッケージのワークフロー
- エンドポイント「「未処理出荷」の作成」を使用して、必要な全ての出荷、梱包情報、accountNumber、およびインデックスを含む「未処理出荷」を作成します。
- エンドポイント「「未処理出荷」パッケージの追加」を使用して、作成済みの「未処理出荷」に1個以上(40個以下)のパッケージを追加します。重要な入力は、パッケージが追加される「未処理出荷」のインデックスとaccountNumberです。
- エンドポイント「「未処理出荷」の確定」を使用して、全てのパッケージが追加され、出荷が完了したことを確定します。重要な入力は、インデックス、および確定する出荷のaccountNumberです。この場合、パッケージが40個を超えるため、APIは出荷を非同期処理し、jobIdを返します。これは、後ほど出荷結果を取得する際に使用します。応答にエラーが生じた場合は、エンドポイント「「未処理出荷」の修正」または「「未処理出荷」パッケージの修正」を使用してこれらのエラーを修正し、エンドポイント「「未処理出荷」の確定」を使用して出荷を確定しなければなりません。
- エンドポイント「Get Open Shipment Result(未出荷貨物の取得)」を使用して、未出荷貨物のラベルや出荷書類などの結果(作成、変更、確定)を取得してください。重要な入力項目は、確定済み貨物のjobIdとaccountNumberです。
エンドポイント「「未処理出荷」結果の取得」は、このフローの最後のエンドポイントであり、確定済みの「未処理出荷」のラベルやその他全てのレポートなど、確定済みの「未処理出荷」の結果を取得します。エラーの詳細が応答で返される場合、これらのエラーは、エンドポイント「「未処理出荷」の修正」または「「未処理出荷」パッケージの修正」を使用して修正できます。次に、エンドポイント「「未処理出荷」の確定」を使用して出荷を確定し、最後にエンドポイント「「未処理出荷」結果の取得」を使用して成功したリクエストの確定済みの「未処理出荷」を取得します。
未処理出荷APIのしくみ
未処理出荷APIに関連する機能:
「未処理出荷」の作成
このエンドポイントを使用して、必要な出荷情報を含む「未処理出荷」を作成し、出荷に少なくとも1つのパッケージを定義します。
「未処理出荷」を作成するために必要な入力情報:
- 「未処理出荷」アクション – これは「未処理出荷」アクションであり、この場合、CREATE_PACKAGEとして値を使用します。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
- requestedShipment –「未処理出荷」の出荷詳細。
- index –「未処理出荷」の一意の値。この値は、出荷またはパッケージを修正するのに役立ちます。これはオプションです。提供されていない場合は、マスター追跡番号を使用して出荷を一意に識別できます。
このリクエストへの正常な応答は、出荷を処理し、最初のパッケージのマスター追跡番号である追跡番号を生成します。応答では、ラベルが生成されていませんのでご注意ください。
「未処理出荷」パッケージの追加
このエンドポイントを使用して、出荷が確定される前に、既存の「未処理出荷」リクエストに1個以上のパッケージを追加します。1日を通して出荷を準備する際、パッケージごとに個別のパッケージ追加リクエストを送信できます。パッケージの追加リクエスト内で複数個口貨物を送信することもできます。
注意:出荷のパッケージの総数は、Open Shippingパッケージの制限を超えてはなりません。
「未処理出荷」にパッケージを追加するために必要な入力情報:
- index – 作成済みの「未処理出荷」に割り当てられた一意の値です。但し、この値が利用できない場合はマスター追跡番号を入力してください。
- requestedPackageLineItem – 追加される詳細なパッケージ情報。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
このリクエストの正常な応答は、新しく追加されたパッケージの追跡番号が生成します。
「未処理出荷」パッケージの修正
このエンドポイントを使用して、出荷が確定される前に、既存のオープンシップ出荷から1個以上のパッケージの詳細を修正します。これには、「未処理出荷」に追加された最初のパッケージであるマスターパッケージも含まれます。
このリクエストに関連する必要な入力情報は次のとおりです。
- index – 作成済みの「未処理出荷」に割り当てられた一意の値です。これが利用できない場合は、マスター追跡番号を入力してください。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
- TrackingId – 修正するパッケージの1個以上のオープンシップパッケージ追跡ID。
- requestedPackageLineItem – 修正する詳細なパッケージ情報。
リクエストが成功すると、目的のパッケージが更新され、更新された出荷の詳細が返されます。
「未処理出荷」パッケージの削除
このエンドポイントを使用して、出荷が確定される前に、作成済みの「未処理出荷」から1個以上のパッケージを削除します。
このリクエストに関連する必要な入力情報は次のとおりです。
- index – 作成済みの「未処理出荷」に割り当てられた一意の値です。但し、この値が利用できない場合はマスター追跡番号を入力してください。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
- TrackingId – 削除リクエストを受信した1個以上のオープンシップパッケージ追跡ID。
リクエストが成功すると、目的のパッケージが削除され、項目deletedPackagesFromOpenshipmentのステータスがtrueとして出力に返されます。
注意:出荷時にマスターパッケージが削除された場合、次のパッケージがマスターパッケージになり、マスター追跡番号が再割り当てられ、削除されたパッケージの数だけ番号の順序が減ります。
「未処理出荷」パッケージの取得
このエンドポイントを使用して、作成済みの「未処理出荷」から1個以上のパッケージを取得し、確認または検証します。
このリクエストに関連する必要な入力情報は次のとおりです。
- index – 作成済みの「未処理出荷」に割り当てられた一意の値です。但し、この値が利用できない場合はマスター追跡番号を入力してください。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
- TrackingId – 詳細を取得する1個以上の未処理出荷パッケージの追跡ID。
リクエストが成功すると、目的のパッケージを取得できます。
「未処理出荷」の修正
このエンドポイントを使用して、出荷が確定される前に、必要な出荷情報で「未処理出荷」リクエストを修正します。
このリクエストに関連する必要な入力情報は次のとおりです。
- index – 作成済みの「未処理出荷」に割り当てられた一意の値です。但し、この値が利用できない場合はマスター追跡番号を入力してください。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
- requestedShipment –「未処理出荷」が修正された出荷の詳細。
リクエストが成功すると、出荷の詳細が作成済みの「未処理出荷」に更新され、修正されたパッケージの追跡番号と更新された取引の出荷の詳細が出力として返されます。
「未処理出荷」の取得
このエンドポイントを使用して、作成済みの「未処理出荷」を取得し、確認または検証します。
このリクエストに関連する必要な入力情報は次のとおりです。
- index – 作成済みの「未処理出荷」に割り当てられた一意の値です。これが利用できない場合は、マスター追跡番号を入力してください。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
リクエストが成功すると、目的の「未処理出荷」の詳細を取得できます。
「未処理出荷」の削除
このエンドポイントを使用して、出荷が確定される前に「未処理出荷」リクエストを削除します。
このリクエストに関連する必要な入力情報は次のとおりです。
- index – 作成済みの「未処理出荷」に割り当てられた一意の値です。これが利用できない場合は、マスター追跡番号を入力してください。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
リクエストが成功すると、「未処理出荷」と関連する全てのパッケージが削除され、要素 deletedOpenshipment「未処理出荷」のステータスがtrueとして出力に返されます。
「未処理出荷」の確定
このエンドポイントを使用して、全てのパッケージが出荷リクエストに追加されたら、オープンシップの出荷データを検証してFedExSystemsにアップロードします。
このリクエストに関連する必要な入力情報は次のとおりです。
- index – 作成済みの「未処理出荷」に割り当てられた一意の値です。但し、この値が利用できない場合はマスター追跡番号を入力してください。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
- labelResponseOptions – エンコードされたバイトコードまたはラベルURLのどちらを応答で返すかを指定します。
注意:labelResponseOptions要素は、「未処理の運送状の確定リクエスト」および運送状の確認後にラベルが生成される場合にのみ使用できます。
40個以下のパッケージの確定応答が成功すると、出荷データがフェデックスシステムにアップロードされ、パッケージラベルと他の全ての出荷レポートが生成されます。
40個を超えるパッケージの確定応答が成功すると、リクエストが正常にキューに入れられたことを確定し、後で結果を取得するためにjobIdを返します。
注:運送状を確定する前に、少なくとも1個のパッケージが「未処理の運送状」に含まれていなければなりません。
「未処理出荷」結果の取得
このエンドポイントを使用して、確定済みのオープンシップ出荷データを取得します。このエンドポイントは、出荷に40個を超えるパッケージがあり、JobIdが「未処理出荷」確定で返される場合にのみ使用しなければなりません。
このリクエストに関連する必要な入力情報は次のとおりです。
- resultMethodType – 値をCREATEとして指定します。
- accountNumber – これはフェデックス・アカウント・ナンバーです。
- jobId –これは「未処理出荷」の確定中に受信したjobIdです。
このリクエストに正常に応答すると、パッケージラベルや確定済みの「未処理出荷」に関する他の全ての出荷レポートなど、確定済みの「未処理出荷」の結果が返されます。エラーの詳細が応答で返される場合、これらのエラーは、エンドポイント「「未処理出荷」の修正」または「「未処理出荷」の修正」を使用して修正できます。次に、エンドポイント「「未処理出荷」の確定」を使用して出荷を確定し、最後にエンドポイント「「未処理出荷」結果の取得」を使用して成功したリクエストの確定済みの「未処理出荷」を取得します。
複数個口貨物(MPS)の出荷
複数個口貨物(MPS)は、同じ荷受人の住所に出荷される2個以上のパッケージで構成されます。出荷リクエストの最初のパッケージをマスターパッケージと見なします。
複数個口貨物を作成するには:
- マスターパッケージのserviceType、packagingType、totalWeight、totalPackageCount、requestedPackageLineItemsの詳細などの出荷レベル情報を含めてください。
注意:マスターパッケージのsequenceNumberは1でなければなりません。 - 全てのパッケージを出荷に追加します。
- 出荷を確定します。
出荷確定後、以下の処理オプションのいずれかを使用します。
同期出荷処理
同期処理は最適な処理方法の1つであり、出荷の商品数が限られている40個以下のパッケージ(合計パッケージ数/グループパッケージ数<= 40個)の場合に内部で使用します。
40個以下のパッケージの出荷リクエストは確定後に同期的に処理され、ラベルやその他の出荷書類/レポートが即座に生成します。このプロセスは、時間の制約があり、出荷の確定後、ラベルを直ちに印刷しなければならない荷送人に最適です。
注意:パッケージの制限(最大40個)あくまで目安であり、必ずしもそうである訳ではありません。制限は、出荷時のパッケージと品目の組み合わせにも依存します。詳細については、フェデックスサポートチームにお問い合わせください。
例:「未処理出荷」リクエストは、10個のパッケージで構成されています。10個全てのパッケージを追加して出荷を確定すると、出荷は同期的に処理されます。応答では10個のラベルが作成され、リクエストに応じてラベルURLまたはエンコードされたラベルのいずれかが返って来ます。
次の高度ワークフローは、同期出荷作成処理について説明しています。
- エンドポイント「「未処理出荷」の作成」を使用します。
- エンドポイント「未処理出荷」パッケージを使用して1〜40個のパッケージを追加します。
- エンドポイント「「未処理出荷」の確定」を使用して、「未処理出荷」を確定します。
- リクエストが成功するとラベルが生成され、出力応答にはリクエストに応じてラベルURLまたはエンコードされたラベルが含まれます。
- 出荷にエラーが生じた場合、エラーの詳細が応答に示されます。
- 全てのエラーを修正した後、エンドポイントの「「未処理出荷」の確定」を使用して正常に応答します。
注意:
- この方法では、既存のパッケージにさらにパッケージを追加する必要がある場合、合計40個までのパッケージしか追加できません。
非同期出荷処理
パッケージの総数が40個を超えると(つまり、totalPackageCount> 40個)、APIは内部で出荷を非同期的に処理します。これは、出荷の量が多く、定期的に一括出荷する場合に非常に便利な方法です。この一括出荷を一度に提出されますと、様々な高価なフェデックスのリソースが使用され、操作が実行されます。この処理オプションを使用しますと、フェデックスはこれらの出荷の簡易一括処理を内部的に保証し、お客様はラベルデータを定期的に取得することができます。
出荷が非同期処理される場合、このリクエストは、リクエストが正常にキューに入ったことを返します。また後ほど結果を取得するためのjobIdも返します。尚、出荷自体は正常に処理されない可能性があります。
注意:このプロセスでは、結果を取得できる前に、出荷が正常に処理されるまでに時間がかかります。
非同期出荷の結果を取得するには、エンドポイントのGet Open Shipment Resultsを使用して、リクエストでjobIdとaccountNumberの詳細を指定します。このリクエストは、ラベルの詳細または出荷エラーの詳細を含む出荷結果データを返します。
例:パッケージは45個のパッケージで構成されており、確定されると非同期処理されます。jobIdが返され、お客様はエンドポイントのGet Open Shipment Resultsを使用して出荷結果を取得し、ラベルデータを取得しなければなりません。
次の高度ワークフローは、非同期出荷処理について説明しています。
- エンドポイント「「未処理出荷」の作成」を使用します。
- エンドポイント「「未処理出荷」パッケージの追加」を使用して40個以上のパッケージを追加します。
- エンドポイント「「未処理出荷」の確定」を使用して、出荷を確定します。
- 送信が成功すると、jobIdが付与されます。
- jobIdとaccountNumberを使用して、「「未処理出荷」結果の取得」エンドポイントを使用して出力結果を取得します。
- 正常に出力されると、出荷結果データにラベルの詳細が表示されます。
- 結果にエラーが生じた場合、エラーの詳細が応答に示されます。
注意:
- この方法では、1回の依頼で許可される最大合計パッケージ数は300個、または最大999個の品目です。
- この方法では、依頼の送信後、元の依頼のパッケージに新規パッケージを追加する、または元の依頼のパッケージを修正する、あるいは削除することはできません。応答にエラーが生じた場合は、エンドポイント「「未処理出荷」の修正」パッケージを使用してエラーを修正し、エンドポイント「「未処理出荷」の確定」を使用して出荷を確定し、エンドポイント「「未処理出荷」結果の取得」を使用して正常な出力結果を取得します。
フェデックス出荷ラベル
FedEx APIは、様々なラベルをサポートしています。FedEx APIは、感熱式、普通紙、カスタマイズ可能なラベルなど、3種類のラベルオプションをサポートしています。出荷作成APIエンドポイントを使用することで、様々なラベルを作成できます。
フェデックスは、配達サービスをサポートするために2つのラベル形式を提供しています。
- 感熱式ラベル
- レーザーラベル
感熱式ラベル
FedEx APIは、様々な感熱式ラベルプリンターを使用して、FedEx Express®、FedEx Ground®、FedEx International Ground®などのすべての出荷種類の出荷ラベルを印刷できます。
FedEx APIは、次の感熱式ラベルサイズをサポートしています。
- 4" x 6" – 構成可能なDoc-Tabなし(Doc-Tab)
- 4" x 6.75" – Doc-Tabありまたはなし
- 4" x 8" – 選択されたグラフィックファイルまたはテキストファイルを含めるためのスペースを提供します
- 10.2 cm x 21.6 cm (4'' x 8.5'') – 設定可能なDoc-Tab付き(タイヤ識別ラベル用)
- 4" x 9" – グラフィックまたはテキスト、およびDoc-Tab用のスペースを提供します
- 10.2 cm x 26.7 cm(4'' x 10.5'') – 設定可能なDoc-Tab付き(タイヤ識別ラベル用)
印刷用粘着シートタイプ 10.2 cm x 21.6 cm (4'' x 8.5'')および 10.2 cm x 26.7 cm(4'' x 10.5'')にはラベルと同じバーコードが記されたDoc-Tabが付いています。尚、同じバーコードがメインラベルとDoc-Tabに記されます。この印刷用粘着シートタイプは、ラベルをタイヤのトレッド(溝)に、また、ラベルのバーコードと操作手順が記されたDoc-Tabラベルをタイヤのサイドウォール(側面)に貼り付けることができるため、タイヤパッケージに便利です。この印刷用粘着シートタイプを使用すると、再度ラベル付けする作業を減らすことができ、寸法スキャンの増加によってリカバリが容易くなります。印刷用粘着シートタイプをクリックして、印刷用粘着シートタイプの詳細をご確認ください。
注:Doc-Tabは、感熱式プリンターで出荷ラベルを印刷するときに、ラベルストック用に選択可能な追加出荷情報が示された取り外し可能な粘着性のあるタブです。
感熱式ラベル項目
感熱式出荷ラベルには、次の3つの基本項目が含まれています。
- 判読可能なコンテンツ:ラベルのこの部分には、配送情報が含まれています。
- Ground 判読可能バーコードは既定で暗号化されます。
- 2次元(2D)バーコード:次元英数字バーコードは、米国規格協会(ANSI)MH10.8.3標準を基に、FedEx ExpressとFedEx Groundの両方の出荷のデータを格納しています。2Dバーコードは、Portable Data File(PDF)417シンボルを使用して作成されます。
- FedEx固有のバーコード:
- FDX 1Dバーコードが完全に段階的に導入されるまでの、FedEx Express貨物用のASTRA(高度な並べ替え追跡ルーティングアシスタンス)。(FedEx GroundおよびFedEx Home Delivery貨物のバーコード「96」)FedEx Groundのバーコード「96」ではSSCC-18「00」バーコードを使用することもできます。
- FedEx Express出荷用のFedEx1D(FDX1D)バーコードは、ANSI/AIM BC4-1995(Uniform Symbology Specification C.O.D.E-128C)を使用して作成されます。
感熱式ラベルを生成するための重要な情報
感熱式ラベルを生成するために必要な重要な情報は次のとおりです。
- LabelFormatType:未処理出荷作成返信APIで正しいラベル画像を受け取るために必要です:
- COMMON2D:ラベルを受け取るためのラベル形式の種類。
- LABEL_DATA_ONLY:カスタムラベルを作成する場合にバーコードデータを受信するために使用する値。
ImageType:使用するプリンターの感熱式ラベルを形式化するために必要です。返されるデータストリームまたはビットマップの種類を提供します。
- EPL2 - Eltron(ラベルストック種類)
- ZPLII - Zebra(ラベルストック種類)
有効値:
有効値:
注意:出荷に必要なすべてのラベルが生成され、単一のバッファに返されます。
サポートする感熱式プリンター
FedEx APIでは、次の感熱式プリンターをお勧めします。
- Unimark
- Eltron
- Orion (EPL2)
- Eclipse (EPL2)
- Zebra
- LP2443 (EPL2)
- LP2844 (EPL2)
- Gk420 (ZPL)
- LP2348 Plus (EPL2/ZPL)
- Z4M Plus (ZPL or EPL)
- ZP500/ZP505 (EPL2/ZPL)
- Z4M/Z4M+ (EPL2/ZPL)
- ZM400 (EPL2/ZPL)
- ZT410 (EPL2/ZPL)
- その他のZT4xxシリーズプリンター(EPL2/ZPL)
注意:これらのプリンタはすべて、ASCII Eltronプログラミング言語(EPL2)ページモードと互換性があります。感熱式プリンターは、システムシリアルポートに接続されたプリンターへの直接書き込みとしても、LPT、シリアル、またはUSB接続用のネイティブWindowsインストールプリンターとしてもサポートされています。フェデックスが提供するプリンタのファームウェアバージョンは、地域によって異なる場合があります。
サービスごとに印刷される感熱式ラベル数
次の表は、特定の特別サービスに必要な各種類のラベル番号を示しています。必要なすべてのラベルは、FedEx Common Label Server(CLS)の呼び出しによって生成され、CLSはC.O.D.を除いて単一のバッファーを返します。返送ラベル
米国のサービスごとに印刷された感熱式ラベル数
サービスの種類 |
感熱式ラベル(FedEx CLSは応答で適切な数のラベルを返します) |
FedEx Express U.S. |
1 出荷ラベル |
FedEx Ground U.S./FedEx Home Delivery |
1 出荷ラベル |
米国の輸出国際サービスごとに印刷された感熱式ラベル数
サービスの種類 |
感熱式ラベル(FedEx CLSは応答で適切な数のラベルを返します) |
FedEx Express U.S. エキスポート・インターナショナル |
1 出荷ラベル 2荷受人ラベル |
FedEx Express U.S. エキスポート・インターナショナル 通関業者指定オプション |
1 出荷ラベル 2荷受人ラベル |
FedEx Ground U.S. エキスポート・インターナショナル |
1 出荷ラベル |
FedEx Ground U.S. エキスポート・インターナショナル C.O.D. |
1 出荷ラベル 2 C.O.D.返送ラベル |
カナダ内サービスごとに印刷された感熱式ラベル数
サービスの種類 |
感熱式ラベル(FedEx CLSは応答で適切な数のラベルを返します) |
FedEx Express カナダ国内 |
非DG(危険物)/ドライアイス輸送: 1 出荷ラベル |
FedEx Ground カナダ国内 |
1 出荷ラベル |
FedEx Ground カナダ国内 C.O.D. |
1 出荷ラベル 2 C.O.D.返送ラベル |
カナダ輸出国際サービスごとに印刷された感熱式ラベル数
サービスの種類 |
感熱式ラベル(FedEx CLSは応答で適切な数のラベルを返します) |
FedEx Express Canada エキスポート・インターナショナル |
非DG /ドライアイス輸送: 1 出荷ラベル 2荷受人ラベル |
FedEx Express Canada エキスポート・インターナショナル Broker Select |
非DG /ドライアイス輸送: 1 出荷ラベル 2荷受人ラベル |
FedEx Ground Canada(CA)エキスポート・インターナショナル |
1 出荷ラベル |
フィリピンおよびタイの輸入出荷ごとに印刷された感熱式ラベル数
サービスの種類 |
感熱式ラベル(FedEx CLSは応答で適切な数のラベルを返します) |
フィリピンのインバウンド出荷 |
2 アカウント・ナンバーが印刷された出荷ラベル 1 アカウント・ナンバーが印刷されていない荷受人ラベル 3 コマーシャル・インボイスコピー |
タイの輸入品目貨物 |
2 アカウント・ナンバーが印刷された出荷ラベル 1 アカウント・ナンバーが印刷されていない荷受人ラベル |
タイの輸入書類の貨物 |
2 アカウント・ナンバーが印刷された出荷ラベル 1 アカウント・ナンバーが印刷されていない荷受人ラベル |
Doc-Tab
感熱式プリンターを使用して出荷ラベルを印刷する場合は、追加の出荷情報が記載された取り外し可能な粘着タブであるDoc-Tabを含むラベルストックを選択できます。出荷データからこの出荷情報を構成することも、出荷ニーズに固有の構成可能なデータを印刷することを選択することもできます。
レーザーラベル
FedEx APIは、レーザープリンターによるラベル印刷をサポートしています。これらのラベルは通常、U.S.レターまたはA4用紙に印刷され、標準のフェデックスラベルポーチに収まるように半分に折りたたまれます。レーザープリンターで印刷されるラベルはPDF形式で生成されるため、拡大縮小やサイズ変更は必要ありません。ラベルストックの詳細については、ラベルストック種類を参照してください。
前提条件
次の要件がPDFラベルに適用されます。
- ラベルを処理するにはAdobe Reader6.0以降が必要です。
- プリンタードライバーの構成では、プリンターのスケーリングを「none」に設定しなければなりません。
- ブラウザで普通紙のPDFラベルを表示する場合、HTMLラッパーを使用する必要はありません。
- Acrobatは、PDF書類を表示するために次のブラウザを推奨しています。
- Microsoft Internet Explorer10以降
- Firefox 1.0以降
- Mozilla 1.7以降
PDFラベルオプションを使用しますと、ブラウザにラベルを正しく表示するために、画像の向きのパラメータ(幅と高さ)や画面の解像度を指定する必要がありません。
レーザーラベル項目
レーザー出荷ラベルには、次の3つの基本項目が含まれています。
- 人間が読めるコンテンツ – ラベルのこの部分には、配送情報が含まれています。
- Ground 判読可能バーコードは既定で暗号化されます。
- 2次元(2D)バーコード:次元英数字バーコードは、米国規格協会(ANSI)MH10.8.3標準を基に、FedEx ExpressとFedEx Groundの両方の出荷のデータを格納しています。2Dバーコードは、Portable Data File(PDF)417形式を基に作成されます。
- FedEx固有のバーコード:
- FDX 1Dバーコードが完全に段階的に導入されるまでの、FedEx Express貨物用のASTRA(高度な並べ替え追跡ルーティングアシスタンス)。(FedEx GroundおよびFedEx Home Delivery貨物のバーコード「96」)FedEx Groundのバーコード「96」では、該当する場合、SSCC-18「00」バーコードを使用することもできます。
- FedEx Express出荷用のFedEx1D(FDX1D)バーコードは、ANSI/AIM BC4-1995(Uniform Symbology Specification C.O.D.E-128C)を使用して作成されます。
レザーラベルを生成するための重要な情報
レーザーラベルを生成するには、次のFedEx API項目が必要です。
- LabelSpecification/LabelFormatType:未処理出荷作成返信 APIで正しいラベル画像を受け取るために必要です:有効値は:
- COMMON2D – ラベルを受け取るためのラベル形式種類。
- LABEL_DATA_ONLY – カスタムラベルを作成する場合にバーコードデータを受信するために使用する値。
- LabelSpecification/ImageType: ラベルの形式を示すために必要です。返されるデータストリームまたはビットマップの種類:
有効な値は次のとおりです。
- PDF – 普通紙
- PNG – 普通紙
- LabelSpecification/LabelStockType:すべてのラベルの種類に必要です。ラベルストックのラベルの先頭または末尾にDoc-Tabがあるか、Doc-Tabがないかを指定します。PDFまたはPNGのImageTypeを使用する場合、これらの値はレーザー形式のラベルを表示します。
- PAPER_4X6
- PAPER_4X8
- PAPER_4X9
- PAPER_4X675
これらの値は、普通紙形式の出荷ラベルを表示します。 - PAPER_7X47
- PAPER_85X11_BOTTOM_HALF_LABEL
- PAPER_85X11_TOP_HALF_LABEL
- PAPER_LETTER
注意:普通紙のラベルをリクエストされた場合、返されるデータはBase64でエンコードされたラベル画像です。ラベルファイルを表示する前に、Base64でデコードしなければなりません。
サポートされているレーザープリンター
ほとんどのレーザープリンタは、このラベルの種類でサポートされています。但し、インクジェットプリンターで印刷したラベルは受け付けません。
注意:カラーレーザープリンタを使用している場合は、プリンタに黒のカートリッジしか取り付けられていない場合でも、色の定義を黒に設定しなければなりません。
サービスごとに必要なレーザーラベルの数
次の表は、特定の特別サービスに必要な各種類のラベル番号を示しています。必要なすべてのラベルは、FedEx Common Label Server(CLS)の呼び出しによって生成され、CLSはC.O.D.を除いて単一のバッファーを返します。返送ラベル
米国のサービスごとに印刷されたレーザーラベル数
サービスの種類 |
レーザーラベル - PDF形式 |
FedEx Ground/FedEx Home Delivery U.S. |
1 出荷ラベル |
米国の輸出国際サービスごとに印刷されたレーザーラベル数
サービスの種類 |
レーザーラベル - PDF形式 |
FedEx Express U.S. エキスポート・インターナショナル |
1 返信の出荷ラベル。少なくとも3つのラベルを印刷しなければなりません – 貨物に1つのラベル、書類ポーチに2つのラベル。 |
FedEx Express U.S. エキスポート・インターナショナル ブローカーセレクト |
1 返信の出荷ラベル。少なくとも3つのラベルを印刷しなければなりません – 貨物に1つのラベル、書類ポーチに2つのラベル。 |
FedEx Ground U.S. エキスポート・インターナショナル |
1 出荷ラベル |
FedEx Ground U.S. エキスポート・インターナショナル C.O.D. |
1 出荷ラベル 2 C.O.D.返送ラベル |
メキシコ内サービスごとに印刷されたレーザーラベル数
サービスの種類 |
レーザーラベル - PDF形式 |
FedEx Expressメキシコ国内 |
FedEx Expressメキシコ国内 非DG(危険物)/ドライアイス輸送: 1 出荷ラベル |
カナダ内サービスごとに印刷されたレーザーラベル数
サービスの種類 |
レーザーラベル - PDF形式 |
FedEx Express カナダ国内 |
FedEx Express カナダ国内 非DG(危険物)/ドライアイス輸送: 1 出荷ラベル |
FedEx Ground カナダ国内 |
1 出荷ラベル |
FedEx Ground カナダ国内 C.O.D. |
1 出荷ラベル 2 C.O.D.返送ラベル |
カナダ輸出国際サービスごとに印刷されたレーザーラベル数
サービスの種類 |
レーザーラベル - PDF形式 |
FedEx Express Canada エキスポート・インターナショナル |
FedEx Express Canada エキスポート・インターナショナル 非DG /ドライアイス輸送: 1 出荷ラベル 2荷受人ラベル |
FedEx Express Canada エキスポート・インターナショナル Broker Select |
FedEx Express Canada エキスポート・インターナショナル Broker Select 非DG /ドライアイス輸送: 1 出荷ラベル 2荷受人ラベル |
FedEx Ground Canada(CA)エキスポート・インターナショナル |
1 出荷ラベル |
カナダ輸出国際サービスごとに印刷されたレーザーラベル数
サービスの種類 |
レーザーラベル - PDF形式 |
FedEx Express Canada エキスポート・インターナショナル |
FedEx Express Canada エキスポート・インターナショナル 非DG /ドライアイス輸送: 1 出荷ラベル 2荷受人ラベル |
FedEx Express Canada エキスポート・インターナショナル Broker Select |
FedEx Express Canada エキスポート・インターナショナル Broker Select 非DG /ドライアイス輸送: 1 出荷ラベル 2荷受人ラベル |
FedEx Ground Canada(CA)エキスポート・インターナショナル |
1 出荷ラベル |
フィリピンおよびタイの輸入出荷ごとに印刷されたレーザーラベル数
サービスの種類 |
感熱式ラベル(FedEx CLSは応答で適切な数のラベルを返します) |
フィリピンのインバウンド出荷 |
2 アカウント・ナンバーが印刷された出荷ラベル 1 アカウント・ナンバーが印刷されていない荷受人ラベル 3 コマーシャル・インボイスコピー |
タイの輸入品目貨物 |
2 アカウント・ナンバーが印刷された出荷ラベル 1 アカウント・ナンバーが印刷されていない荷受人ラベル |
タイの輸入書類の貨物 |
2 アカウント・ナンバーが印刷された出荷ラベル 1 アカウント・ナンバーが印刷されていない荷受人ラベル |
カスタムラベル
フェデックスでは、フェデックスで生成されたラベルをカスタマイズできます。ビジネスに関連するテキストを追加し、フェデックス書類および感熱式ラベルのカスタム部分のラベルで使用されるバーコード(シンボロジー)の種類を選択できます。
出荷アプリケーションをサポートするために、FedExオープンシップAPIには、出荷ラベルをカスタマイズするための2つのオプションがあります。
- PNG PAPER 7" x 4.75"グラフィックをラベルストックに配置します。例えば、A4 用紙でパッキングリストを作成することができます。専用カスタムラベルを作成する代わりに、この用紙の一部に7'' x 4.75'' PNG PAPERグラフィックを配置することもできます。
- グラフィックまたはテキストファイルを4" x 8"または4" x 9"感熱式ラベルに追加します。このラベルサイズですと、グラフィックまたはテキスト用に5cm(2インチ)のスペースが設けられます。
注意:ラベルの共通部分にあるラベルの判読可能なコンテンツとバーコードは変更できません。
カスタムバリデーターラベル
必要なカスタム情報、その情報の形式方法、およびカスタムラベルのどこに配置するかを指定することにより、貨物レベルと出荷レベルの両方で非出荷カスタムラベルを作成できます。カスタムラベルは、感熱式ラベル形式のみでご利用いただけます。
感熱式ラベルのカスタマイズ
FedEx APIは、カスタムラベルを作成する必要をなくすために、グラフィックファイルまたはテキストファイルのいずれかでカスタマイズ可能な2つの感熱式ラベル形式を提供します。これらのラベルは、すべてのフェデックス出荷サービスをサポートしています。形式は次のとおりです。
- Doc-Tabなしの4" x 8"感熱式ラベル
- Doc-Tab付きの4" x 9"感熱式ラベル
これらのラベルにはカスタマイズ可能な2インチのセクションが設けられており、感熱式プリンターで印刷する203 DPIまたは300 DPIの解像度に設定された感熱式ラベルでご利用いただけます。
カスタムラベルの規則
ラベル形式の使用規則は次のとおりです。
- カスタマイズ可能なのは出荷ラベルのみです。例えば、ロゴ付きの4" x 8" Express出荷ラベルを印刷された場合、2次荷受人ラベルには表示されません。
- カスタマイズ可能なグラフィックまたはテキストは、高さ2インチ、幅4-1/2インチを超えてはなりません。
- フェデックスによる修正はありません。グラフィックおよび/またはテキストは、出荷サービスで送信されるときに印刷されます。
- グラフィックやテキストの印刷に必要なすべてのデータが提供されていない場合(例:X座標とY座標)、カスタマイズされたデータなしで有効な出荷ラベルが返されます。グラフィックやテキストを使用して別のラベルを再作成する場合は、このラベルに示されている出荷をキャンセルしなければなりません。
- プリンター解像度203DPI(8ドット/mm)の場合、XおよびY座標上の配置に関して、挿入点の座標の基準は、4.00” x 6.75”の感熱式ラベルの上端と左端の交点(底部Doc Tab付き)です。上部Doc Tabが付いた4.00 "x 6.75"の感熱式ラベルの場合、挿入ポイントの座標Y値を164ドット増やします。但しDoc Tabのない4.00” x 6.00”ラベルの場合、挿入点の座標Y値を8ドット増やします。感熱式ラベル項目の属性は、203 DPI(8ドット/ mm)のプリンター解像度に基づいています。
- プリンター解像度300DPI(12ドット/mm)の場合、XおよびY座標上の配置に関して、挿入点の座標の基準は、4.00” x 6.75”の感熱式ラベルの上端と左端の交点(底部Doc Tab付き)です。上部Doc Tabが付いた4.00 "x 6.75"の感熱式ラベルの場合、挿入ポイントの座標Y値を246ドット増やします。但しDoc Tabのない4.00” x 6.00”ラベルの場合、挿入点の座標Y値を12ドット増やします。感熱式ラベル項目の属性は、300 DPI(12ドット/ mm)のプリンター解像度に基づいています。
注:- FXD1Dバーコードの場合、X寸法(シンボル内の最も狭いバーの幅)は、203 DPIプリンターでは15 mil(3ドット)、300 DPIプリンターでは13.3 mil(4ドット)です。
- 2D PDF-417バーコードの場合、X寸法は203DPIプリンターで10ミル(2ドット)です。300DPIプリンターに最も近いX寸法を得るには、9.99ミル(3ドット)を使用しなければなりません。
- ラベル上部の「荷送人/その他」ブロックと、非常に小さなフォントが使用されている荷受人情報の下の「荷送人の参照番号」ブロックについては、ラベル開発者はZPLプログラミングガイドをチェックして、フォントセットの特性を相互参照し、他のさまざまなプリントヘッドの解像度に対応する同等のフォントセットを選択する必要があります。
- 文字挿入ポイントは、文字列の最初の文字のキャップラインの左上隅です。
- プリンタの制限により、正面の左上の象限に原点がなければなりません。したがって、データはラベルのカスタマイズ可能なセクションから開始し、ラベルのフェデックス部分に書き留めることができます(実際の感熱式ラベルデータ)。カスタマイズ可能なセクションから開始した場合、ロゴまたはテキストはフェデックスラベル情報で上書きされます。出荷ラベルをご利用いただくには、この位置を修正しなければなりません。
- 4" x 9"ラベルにDoc-Tab情報を追加される際は、標準の4" x 6" Doc-Tab感熱式ラベルと同様のプロセスで構成しなければなりません。
注意:ラベルは白黒で印刷されるため、シングルビットカラー画像のみを追加しなければなりません。
カスタムラベルグラフィックエントリ項目
APIは、FedEx ExpressおよびFedEx Groundラベル用のPNG(Portable Network Graphic)画像を提供します。PNGラベルのグラフィックは、APIでサポートされている感熱式ラベルまたは普通紙ラベルのレプリカです。このラベルオプションを使用しますと、PNGラベルグラフィックをラベルストックに配置して、カスタムラベルを作成する必要がなくなります。
出荷書類に組み込まれた4" x 6" PNGグラフィックをご利用になられる場合は、次の要件が適用されます。
- ラベルストック
- 印刷
- スケーリング
ラベルストック
4" x 6"PNGラベルは、ピールアンドスティックラベルストックでのみご利用いただけます。FedEx GroundおよびFedEx Expressラベル認証チームは、普通紙に印刷されたラベルを含め、ピールアンドスティックラベルストックにない4" x 6" PNGラベルを拒否いたします。
印刷
ラベルの印刷にはレーザープリンタをお勧めします。インクジェットプリンタは、スキャン可能なバーコードを一貫して作成できないため、使用しないでください。4" x 6" PNGラベルは、カラープリンタに黒のカートリッジしか取り付けられていない場合でも、色を黒に設定されない限り、カラープリンタで印刷することはできません。この設定は、フェデックスのハブでスキャンするバーコードを正しく定義するために必要です。
スケーリング
出荷トランザクションで返される画像は200ドット/インチ(DPI)で、サイズは4"(幅)x 6"(高さ)または800 x 1200ピクセルです。このラベルは縦向きで、4" x 6"のラベル範囲に印刷されます。印刷される際のラベルのサイズは4" x 6"でなければなりません。
ラベルとバーコードを必須DPIで作成するには、印刷前に画像を拡大縮小(またはサイズ変更)しなければなりません。画像の拡大縮小方法は、ラベルの表示および印刷にご利用になられるアプリケーションによって異なります。4" x 6"ラベルのPNG画像をインチ単位で拡大縮小するには幅4"、高さ6 "をご利用ください。
ラベルレビューチェックリスト
すべてのバーコード
検証に必要:
- 余白:バーコードの上下両方に常に少なくとも0.2cm(0.1インチ)の空白が必要です。
- 余白:バーコードの左右両方に常に少なくとも0.5cm(0.2インチ)の空白が必要です。
- すべてのバーコードが最小の高さの要件を満たしていることを確認します。
印刷品質
ラベルが拒否される原因となる一般的な問題:
- バーの分割
- 色あせたプリント/白いボイド
- ホワイトボイドの繰り返し(ローラーの問題)
- 汚れ(熱転写)
- フレーキング(レーザー)はトナーフュージョンの問題を示します
- 印刷にシワ(熱転写)
- 直接感熱式ラベルの印刷コントラストは、少なくとも90%でなければなりません
Groundラベルの判読可能な形式の詳細
FedEx Groundラベルの判読可能な形式の場合、検証には以下が必要です。
- データがバーコードと一致
- FedEx Groundのロゴ:ロゴは、FedEx Identityのウェブサイトfedex.comからダウンロードできます。
- FedEx Home Deliveryのロゴ:ラベルには、住所の2.5cm(1インチ)以内のボックスに大きな「H」を付ける必要があります。「H」は少なくとも0.25"x .70"でなければなりません。
- サービスの内容
- 荷送人情報
- 荷受人の情報
- 郵便番号とルーティング
- 出荷日
- 実重量
- カスタマーオートメーションデバイス情報(メーター、アプリケーション/システム、バージョン)
- 寸法
- その他の参考情報
- 追跡番号とフォームID(追跡番号は14桁でなければなりません)
- 空港ランプID
- 郵便番号
Expressラベルの判読可能な形式の詳細
承認されるには、次の項目をラベルに印刷しなければなりません。
- FedEx Expressのロゴ:ロゴは、FedEx Identityのウェブサイトfedex.comからダウンロードできます。
- サービスの内容
- 貨物の種類(国際的な場合)
- 配達曜日(例:月曜日にはMON)
- 日付で配達
- メーター番号
- 出荷日
- すべての複数個口貨物でのピース数の形式、マスターラベルの詳細、CRNラベルの詳細
- 空港ランプID
- 郵便番号とルーティング
- URSAルーティングプレフィックスとサフィックス
- 取扱いコード
- サービス提供地域の取り組み
- 荷受人と荷送人の電話番号
- 重量
- 該当する場合は調光
- アルコール輸送の参照フィールド
- 追跡番号とフォームID(追跡番号は14桁でなければなりません)
- ASTRAラベルでは、12桁の追跡番号は32文字のバーコードの17から28の位置にあります。新しいFDX 1Dバーコードでは、追跡番号は21から34の位置にあります。FedEx Expressの追跡番号は引き続き12桁です。先頭の2つはゼロです。
ビジネス規則
未処理出荷APIには次のルールが適用されます。
- 「未処理出荷」は、1個のパッケージで作成および確定することもできます。
- 「未処理出荷」は、「未処理出荷」が5日以内に確定されない場合は削除されます。
- 出荷の確定後、「未処理出荷」にパッケージを追加することはできなくなります。
JSON APIコレクション
Response