請求書API v2024-06-19ユースケースガイド

請求書APIの使用方法を学びましょう。

API バージョン:2024-06-19

請求書APIとは何ですか?

次のものを使用できます 請求書用の販売パートナー API 販売パートナーの簿記管理に役立つさまざまな請求書関連の操作を検索して管理すること。

重要

この API は取得のみ可能です ブラジルの FBA 請求書。この API は他の種類の請求書には使用できません。

主な機能

  • 請求書を属性で検索
  • 請求書のエクスポートとダウンロード

用語

  • セファズ:ブラジル州税務局(セクレタリア・ダ・ファゼンダ)。

チュートリアル:請求書ファイルのエクスポート

請求書ファイルをエクスポートおよびダウンロードする方法をご覧ください。

前提条件

このチュートリアルを完了するには、以下の前提条件を満たす必要があります。

  • 呼び出し先の出品パートナーからの承認。詳細については、Selling Partner APIアプリケーションの認証を参照してください。
  • 開発者プロファイルに割り当てられたタックスインボイスの役割。
  • アプリケーションのアプリ登録ページで選択したタックスインボイスの役割。

ステップ 1:インボイスのエクスポートを作成する

に電話してください createInvoicesExport マーケットプレイス、日付範囲、および含めたいオプションパラメータを操作して指定します。

リクエストが成功すると、レスポンスには以下が含まれます exportId 価値。

ボディのパラメーター

名前説明必須
marketplaceId返送された請求書は、指定したマーケットプレイスと一致します。
タイプ:文字列
はい
dateStart回答に含めたい請求書の最も早い請求書作成日。日付が入力されました ISO 8601 フォーマット。
タイプ:文字列 (日付)
いいえ
dateEnd回答に含めたい請求書の最新の請求書作成日。日付が入力されました ISO 8601 フォーマット。
タイプ:文字列 (日付)
いいえ

ヒント

エクスポート処理時間を短縮するには、日付間隔を短くしてください。 dateStart そして dateEnd。最適な範囲は1日です。

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/invoices/v1/exports?marketplaceId=A2Q3Y263D00KWC&dateStart=2024-07-09T00:00:00Z&dateEnd=2024-07-10T00:00:00Z

レスポンス

名前説明
exportIdエクスポート識別子。
タイプ:文字列

レスポンスの例

{ "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef" }

ステップ 2:エクスポート処理が完了したことを確認する。

定期的に電話してください getInvoicesExport オペレーション--の受け渡し exportId 受け取った価値 ステップ 1--処理が完了するまで (processingStatus です CANCELLEDDONE、または FATAL)。この時点で、レスポンスには以下が含まれます。 exportDocumentId 請求書データがある場合の値。

パスのパラメーター

名前説明必須
exportIdエクスポートの識別子。
タイプ:文字列
はい

リクエストの例

GET https://sellingpartnerapi-na.amazon.com/invoices/v1/exports/4bdd8293-0cd7-4208-bed5-78b2c6ecefef

レスポンス

名前説明
errorMessageエクスポートの生成に失敗した場合、この属性にはエラーの説明が含まれます。
タイプ:文字列
exportDocumentIds各エクスポート文書の識別子を含むリスト。
タイプ:アレイ
exportIdエクスポート識別子。
タイプ:文字列
generateExportFinishedエクスポート生成が終了した日付と時刻 (ISO 8601 日付/時間形式)。
タイプ:文字列
generateExportStartedエクスポート生成が開始された日付と時刻 (ISO 8601 日付/時間形式)。
タイプ:文字列
status処理ステータス。
タイプ:列挙型 (REQUESTEDPROCESSINGDONEERROR)

レスポンスの例

{ "export": { "errorMessage": "", "exportDocumentIds": [ "18c598f5-75db-4c1a-bd3e-4c64b36781c5" ], "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef", "generateExportFinished": "2024-07-10T16:00:00.000Z", "generateExportStarted": "2024-07-10T15:00:00.000Z", "status": "DONE" } }

ステップ 3:請求書文書 URL を取得

に電話してください getInvoicesDocument オペレーション、渡し exportDocumentId からの値 ステップ 2

応答には、請求書のエクスポートにアクセスするために使用できる署名済み URL が含まれています。コンテンツが圧縮されている場合は、圧縮アルゴリズムが提供されます。URL は 30 秒後に期限切れになります。

パスのパラメーター

名前説明必須
invoicesDocumentIdエクスポート文書の識別子。
タイプ:文字列
はい

リクエストの例

GET https://sellingpartnerapi-na.amazon.com/invoices/v1/documents/18c598f5-75db-4c1a-bd3e-4c64b36781c5

レスポンス

名前説明
invoicesDocumentIdエクスポートドキュメント識別子。
タイプ:文字列
invoicesDocumentUrl請求書のダウンロードに使用できる署名済み URL (ZIP 形式)。
タイプ:文字列

レスポンスの例

{ "exportDocumentId": "18c598f5-75db-4c1a-bd3e-4c64b36781c5", "url": "https://d34o8swod1owfl.cloudfront.net/SampleResult%2BKey%3DSample%2BINITVEC%3D58+fa+bf+a7+08+11+95+0f+c1+a8+c6+e0+d5+6f+ae+c8" }

このページは役に立ちましたか?