Package software.amazon.spapi.api.invoices.v2024_06_19

Class InvoicesApi

  • public class InvoicesApi
extends java.lang.Object

    • Constructor Detail

      • InvoicesApi

        public InvoicesApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createInvoicesExport

        public ExportInvoicesResponse createInvoicesExport​(ExportInvoicesRequest body)
                                            throws ApiException,
                                                   LWAException
        Creates an invoice export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - Information required to create the export request. (required)
        Returns:
        ExportInvoicesResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • createInvoicesExportWithHttpInfo

        public ApiResponse<ExportInvoicesResponse> createInvoicesExportWithHttpInfo​(ExportInvoicesRequest body)
                                                                     throws ApiException,
                                                                            LWAException
        Creates an invoice export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - Information required to create the export request. (required)
        Returns:
        ApiResponse<ExportInvoicesResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • createInvoicesExportAsync

        public okhttp3.Call createInvoicesExportAsync​(ExportInvoicesRequest body,
                                              ApiCallback<ExportInvoicesResponse> callback)
                                       throws ApiException,
                                              LWAException
        (asynchronously) Creates an invoice export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - Information required to create the export request. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoiceCall

        public okhttp3.Call getInvoiceCall​(java.lang.String marketplaceId,
                                   java.lang.String invoiceId,
                                   ProgressResponseBody.ProgressListener progressListener,
                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                            throws ApiException,
                                   LWAException
        Build call for getInvoice
        Parameters:
        marketplaceId - The marketplace from which you want the invoice. (required)
        invoiceId - The invoice identifier. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoice

        public GetInvoiceResponse getInvoice​(java.lang.String marketplaceId,
                                     java.lang.String invoiceId)
                              throws ApiException,
                                     LWAException
        Returns invoice data for the specified invoice. This operation returns only a subset of the invoices data; refer to the response definition to get all the possible attributes. To get the full invoice, use the `createInvoicesExport` operation to start an export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The marketplace from which you want the invoice. (required)
        invoiceId - The invoice identifier. (required)
        Returns:
        GetInvoiceResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoiceWithHttpInfo

        public ApiResponse<GetInvoiceResponse> getInvoiceWithHttpInfo​(java.lang.String marketplaceId,
                                                              java.lang.String invoiceId)
                                                       throws ApiException,
                                                              LWAException
        Returns invoice data for the specified invoice. This operation returns only a subset of the invoices data; refer to the response definition to get all the possible attributes. To get the full invoice, use the `createInvoicesExport` operation to start an export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The marketplace from which you want the invoice. (required)
        invoiceId - The invoice identifier. (required)
        Returns:
        ApiResponse<GetInvoiceResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoiceAsync

        public okhttp3.Call getInvoiceAsync​(java.lang.String marketplaceId,
                                    java.lang.String invoiceId,
                                    ApiCallback<GetInvoiceResponse> callback)
                             throws ApiException,
                                    LWAException
        (asynchronously) Returns invoice data for the specified invoice. This operation returns only a subset of the invoices data; refer to the response definition to get all the possible attributes. To get the full invoice, use the `createInvoicesExport` operation to start an export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The marketplace from which you want the invoice. (required)
        invoiceId - The invoice identifier. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesCall

        public okhttp3.Call getInvoicesCall​(java.lang.String marketplaceId,
                                    java.lang.String transactionIdentifierName,
                                    java.lang.Integer pageSize,
                                    org.threeten.bp.OffsetDateTime dateEnd,
                                    java.lang.String transactionType,
                                    java.lang.String transactionIdentifierId,
                                    org.threeten.bp.OffsetDateTime dateStart,
                                    java.lang.String series,
                                    java.lang.String nextToken,
                                    java.lang.String sortOrder,
                                    java.lang.String invoiceType,
                                    java.util.List<java.lang.String> statuses,
                                    java.lang.String externalInvoiceId,
                                    java.lang.String sortBy,
                                    ProgressResponseBody.ProgressListener progressListener,
                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                             throws ApiException,
                                    LWAException
        Build call for getInvoices
        Parameters:
        marketplaceId - The response includes only the invoices that match the specified marketplace. (required)
        transactionIdentifierName - The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options. (optional)
        pageSize - The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200 (optional)
        dateEnd - The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time. (optional)
        transactionType - The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options. (optional)
        transactionIdentifierId - The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field. (optional)
        dateStart - The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request. (optional)
        series - Return invoices with the specified series number. (optional)
        nextToken - The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        sortOrder - Sort the invoices in the response in ascending or descending order. (optional)
        invoiceType - The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options. (optional)
        statuses - A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1 (optional)
        externalInvoiceId - Return invoices that match this external ID. This is typically the Government Invoice ID. (optional)
        sortBy - The attribute by which you want to sort the invoices in the response. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoices

        public GetInvoicesResponse getInvoices​(java.lang.String marketplaceId,
                                       java.lang.String transactionIdentifierName,
                                       java.lang.Integer pageSize,
                                       org.threeten.bp.OffsetDateTime dateEnd,
                                       java.lang.String transactionType,
                                       java.lang.String transactionIdentifierId,
                                       org.threeten.bp.OffsetDateTime dateStart,
                                       java.lang.String series,
                                       java.lang.String nextToken,
                                       java.lang.String sortOrder,
                                       java.lang.String invoiceType,
                                       java.util.List<java.lang.String> statuses,
                                       java.lang.String externalInvoiceId,
                                       java.lang.String sortBy)
                                throws ApiException,
                                       LWAException
        Returns invoice details for the invoices that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The response includes only the invoices that match the specified marketplace. (required)
        transactionIdentifierName - The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options. (optional)
        pageSize - The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200 (optional)
        dateEnd - The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time. (optional)
        transactionType - The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options. (optional)
        transactionIdentifierId - The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field. (optional)
        dateStart - The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request. (optional)
        series - Return invoices with the specified series number. (optional)
        nextToken - The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        sortOrder - Sort the invoices in the response in ascending or descending order. (optional)
        invoiceType - The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options. (optional)
        statuses - A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1 (optional)
        externalInvoiceId - Return invoices that match this external ID. This is typically the Government Invoice ID. (optional)
        sortBy - The attribute by which you want to sort the invoices in the response. (optional)
        Returns:
        GetInvoicesResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesWithHttpInfo

        public ApiResponse<GetInvoicesResponse> getInvoicesWithHttpInfo​(java.lang.String marketplaceId,
                                                                java.lang.String transactionIdentifierName,
                                                                java.lang.Integer pageSize,
                                                                org.threeten.bp.OffsetDateTime dateEnd,
                                                                java.lang.String transactionType,
                                                                java.lang.String transactionIdentifierId,
                                                                org.threeten.bp.OffsetDateTime dateStart,
                                                                java.lang.String series,
                                                                java.lang.String nextToken,
                                                                java.lang.String sortOrder,
                                                                java.lang.String invoiceType,
                                                                java.util.List<java.lang.String> statuses,
                                                                java.lang.String externalInvoiceId,
                                                                java.lang.String sortBy)
                                                         throws ApiException,
                                                                LWAException
        Returns invoice details for the invoices that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The response includes only the invoices that match the specified marketplace. (required)
        transactionIdentifierName - The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options. (optional)
        pageSize - The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200 (optional)
        dateEnd - The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time. (optional)
        transactionType - The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options. (optional)
        transactionIdentifierId - The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field. (optional)
        dateStart - The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request. (optional)
        series - Return invoices with the specified series number. (optional)
        nextToken - The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        sortOrder - Sort the invoices in the response in ascending or descending order. (optional)
        invoiceType - The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options. (optional)
        statuses - A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1 (optional)
        externalInvoiceId - Return invoices that match this external ID. This is typically the Government Invoice ID. (optional)
        sortBy - The attribute by which you want to sort the invoices in the response. (optional)
        Returns:
        ApiResponse<GetInvoicesResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesAsync

        public okhttp3.Call getInvoicesAsync​(java.lang.String marketplaceId,
                                     java.lang.String transactionIdentifierName,
                                     java.lang.Integer pageSize,
                                     org.threeten.bp.OffsetDateTime dateEnd,
                                     java.lang.String transactionType,
                                     java.lang.String transactionIdentifierId,
                                     org.threeten.bp.OffsetDateTime dateStart,
                                     java.lang.String series,
                                     java.lang.String nextToken,
                                     java.lang.String sortOrder,
                                     java.lang.String invoiceType,
                                     java.util.List<java.lang.String> statuses,
                                     java.lang.String externalInvoiceId,
                                     java.lang.String sortBy,
                                     ApiCallback<GetInvoicesResponse> callback)
                              throws ApiException,
                                     LWAException
        (asynchronously) Returns invoice details for the invoices that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The response includes only the invoices that match the specified marketplace. (required)
        transactionIdentifierName - The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options. (optional)
        pageSize - The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200 (optional)
        dateEnd - The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time. (optional)
        transactionType - The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options. (optional)
        transactionIdentifierId - The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field. (optional)
        dateStart - The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request. (optional)
        series - Return invoices with the specified series number. (optional)
        nextToken - The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        sortOrder - Sort the invoices in the response in ascending or descending order. (optional)
        invoiceType - The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options. (optional)
        statuses - A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1 (optional)
        externalInvoiceId - Return invoices that match this external ID. This is typically the Government Invoice ID. (optional)
        sortBy - The attribute by which you want to sort the invoices in the response. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesAttributes

        public GetInvoicesAttributesResponse getInvoicesAttributes​(java.lang.String marketplaceId)
                                                    throws ApiException,
                                                           LWAException
        Returns marketplace-dependent schemas and their respective set of possible values. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The marketplace identifier. (required)
        Returns:
        GetInvoicesAttributesResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesAttributesWithHttpInfo

        public ApiResponse<GetInvoicesAttributesResponse> getInvoicesAttributesWithHttpInfo​(java.lang.String marketplaceId)
                                                                             throws ApiException,
                                                                                    LWAException
        Returns marketplace-dependent schemas and their respective set of possible values. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The marketplace identifier. (required)
        Returns:
        ApiResponse<GetInvoicesAttributesResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesAttributesAsync

        public okhttp3.Call getInvoicesAttributesAsync​(java.lang.String marketplaceId,
                                               ApiCallback<GetInvoicesAttributesResponse> callback)
                                        throws ApiException,
                                               LWAException
        (asynchronously) Returns marketplace-dependent schemas and their respective set of possible values. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The marketplace identifier. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesDocument

        public GetInvoicesDocumentResponse getInvoicesDocument​(java.lang.String invoicesDocumentId)
                                                throws ApiException,
                                                       LWAException
        Returns the invoice document's ID and URL. Use the URL to download the ZIP file, which contains the invoices from the corresponding `createInvoicesExport` request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        invoicesDocumentId - The export document identifier. (required)
        Returns:
        GetInvoicesDocumentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesDocumentWithHttpInfo

        public ApiResponse<GetInvoicesDocumentResponse> getInvoicesDocumentWithHttpInfo​(java.lang.String invoicesDocumentId)
                                                                         throws ApiException,
                                                                                LWAException
        Returns the invoice document's ID and URL. Use the URL to download the ZIP file, which contains the invoices from the corresponding `createInvoicesExport` request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        invoicesDocumentId - The export document identifier. (required)
        Returns:
        ApiResponse<GetInvoicesDocumentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesDocumentAsync

        public okhttp3.Call getInvoicesDocumentAsync​(java.lang.String invoicesDocumentId,
                                             ApiCallback<GetInvoicesDocumentResponse> callback)
                                      throws ApiException,
                                             LWAException
        (asynchronously) Returns the invoice document's ID and URL. Use the URL to download the ZIP file, which contains the invoices from the corresponding `createInvoicesExport` request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        invoicesDocumentId - The export document identifier. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesExport

        public GetInvoicesExportResponse getInvoicesExport​(java.lang.String exportId)
                                            throws ApiException,
                                                   LWAException
        Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        exportId - The unique identifier for the export. (required)
        Returns:
        GetInvoicesExportResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesExportWithHttpInfo

        public ApiResponse<GetInvoicesExportResponse> getInvoicesExportWithHttpInfo​(java.lang.String exportId)
                                                                     throws ApiException,
                                                                            LWAException
        Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        exportId - The unique identifier for the export. (required)
        Returns:
        ApiResponse<GetInvoicesExportResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesExportAsync

        public okhttp3.Call getInvoicesExportAsync​(java.lang.String exportId,
                                           ApiCallback<GetInvoicesExportResponse> callback)
                                    throws ApiException,
                                           LWAException
        (asynchronously) Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        exportId - The unique identifier for the export. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesExportsCall

        public okhttp3.Call getInvoicesExportsCall​(java.lang.String marketplaceId,
                                           org.threeten.bp.OffsetDateTime dateStart,
                                           java.lang.String nextToken,
                                           java.lang.Integer pageSize,
                                           org.threeten.bp.OffsetDateTime dateEnd,
                                           java.lang.String status,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException,
                                           LWAException
        Build call for getInvoicesExports
        Parameters:
        marketplaceId - The returned exports match the specified marketplace. (required)
        dateStart - The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago. (optional)
        nextToken - The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        pageSize - The maximum number of invoices to return in a single call. Minimum: 1 Maximum: 100 (optional)
        dateEnd - The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request. (optional)
        status - Return exports matching the status specified. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesExports

        public GetInvoicesExportsResponse getInvoicesExports​(java.lang.String marketplaceId,
                                                     org.threeten.bp.OffsetDateTime dateStart,
                                                     java.lang.String nextToken,
                                                     java.lang.Integer pageSize,
                                                     org.threeten.bp.OffsetDateTime dateEnd,
                                                     java.lang.String status)
                                              throws ApiException,
                                                     LWAException
        Returns invoice exports details for exports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The returned exports match the specified marketplace. (required)
        dateStart - The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago. (optional)
        nextToken - The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        pageSize - The maximum number of invoices to return in a single call. Minimum: 1 Maximum: 100 (optional)
        dateEnd - The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request. (optional)
        status - Return exports matching the status specified. (optional)
        Returns:
        GetInvoicesExportsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesExportsWithHttpInfo

        public ApiResponse<GetInvoicesExportsResponse> getInvoicesExportsWithHttpInfo​(java.lang.String marketplaceId,
                                                                              org.threeten.bp.OffsetDateTime dateStart,
                                                                              java.lang.String nextToken,
                                                                              java.lang.Integer pageSize,
                                                                              org.threeten.bp.OffsetDateTime dateEnd,
                                                                              java.lang.String status)
                                                                       throws ApiException,
                                                                              LWAException
        Returns invoice exports details for exports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The returned exports match the specified marketplace. (required)
        dateStart - The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago. (optional)
        nextToken - The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        pageSize - The maximum number of invoices to return in a single call. Minimum: 1 Maximum: 100 (optional)
        dateEnd - The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request. (optional)
        status - Return exports matching the status specified. (optional)
        Returns:
        ApiResponse<GetInvoicesExportsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getInvoicesExportsAsync

        public okhttp3.Call getInvoicesExportsAsync​(java.lang.String marketplaceId,
                                            org.threeten.bp.OffsetDateTime dateStart,
                                            java.lang.String nextToken,
                                            java.lang.Integer pageSize,
                                            org.threeten.bp.OffsetDateTime dateEnd,
                                            java.lang.String status,
                                            ApiCallback<GetInvoicesExportsResponse> callback)
                                     throws ApiException,
                                            LWAException
        (asynchronously) Returns invoice exports details for exports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The returned exports match the specified marketplace. (required)
        dateStart - The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago. (optional)
        nextToken - The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        pageSize - The maximum number of invoices to return in a single call. Minimum: 1 Maximum: 100 (optional)
        dateEnd - The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request. (optional)
        status - Return exports matching the status specified. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails