Function InvoicesApiFactory

InvoicesApi - factory interface

Export

InvoicesApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    createInvoicesExport(
        requestParameters: InvoicesApiCreateInvoicesExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ExportInvoicesResponse>;
    getInvoice(
        requestParameters: InvoicesApiGetInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoiceResponse>;
    getInvoices(
        requestParameters: InvoicesApiGetInvoicesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesResponse>;
    getInvoicesAttributes(
        requestParameters: InvoicesApiGetInvoicesAttributesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesAttributesResponse>;
    getInvoicesDocument(
        requestParameters: InvoicesApiGetInvoicesDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesDocumentResponse>;
    getInvoicesExport(
        requestParameters: InvoicesApiGetInvoicesExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesExportResponse>;
    getInvoicesExports(
        requestParameters: InvoicesApiGetInvoicesExportsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesExportsResponse>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    createInvoicesExport(
        requestParameters: InvoicesApiCreateInvoicesExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ExportInvoicesResponse>;
    getInvoice(
        requestParameters: InvoicesApiGetInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoiceResponse>;
    getInvoices(
        requestParameters: InvoicesApiGetInvoicesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesResponse>;
    getInvoicesAttributes(
        requestParameters: InvoicesApiGetInvoicesAttributesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesAttributesResponse>;
    getInvoicesDocument(
        requestParameters: InvoicesApiGetInvoicesDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesDocumentResponse>;
    getInvoicesExport(
        requestParameters: InvoicesApiGetInvoicesExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesExportResponse>;
    getInvoicesExports(
        requestParameters: InvoicesApiGetInvoicesExportsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesExportsResponse>;
}
- createInvoicesExport:function
  - createInvoicesExport(
    requestParameters: InvoicesApiCreateInvoicesExportRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<ExportInvoicesResponse>
  - 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.
    Parameters
    - requestParameters: InvoicesApiCreateInvoicesExportRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ExportInvoicesResponse>
    Throws
    - Defined in api-model/api/invoices-api.ts:524
- getInvoice:function
  - getInvoice(
    requestParameters: InvoicesApiGetInvoiceRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoiceResponse>
  - 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.
    Parameters
    - requestParameters: InvoicesApiGetInvoiceRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetInvoiceResponse>
    Throws
    - Defined in api-model/api/invoices-api.ts:533
- getInvoices:function
  - getInvoices(
    requestParameters: InvoicesApiGetInvoicesRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesResponse>
  - 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.
    Parameters
    - requestParameters: InvoicesApiGetInvoicesRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetInvoicesResponse>
    Throws
    - Defined in api-model/api/invoices-api.ts:542
- getInvoicesAttributes:function
  - getInvoicesAttributes(
    requestParameters: InvoicesApiGetInvoicesAttributesRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesAttributesResponse>
  - 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.
    Parameters
    - requestParameters: InvoicesApiGetInvoicesAttributesRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetInvoicesAttributesResponse>
    Throws
    - Defined in api-model/api/invoices-api.ts:551
- getInvoicesDocument:function
  - getInvoicesDocument(
    requestParameters: InvoicesApiGetInvoicesDocumentRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesDocumentResponse>
  - 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.
    Parameters
    - requestParameters: InvoicesApiGetInvoicesDocumentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetInvoicesDocumentResponse>
    Throws
    - Defined in api-model/api/invoices-api.ts:560
- getInvoicesExport:function
  - getInvoicesExport(
    requestParameters: InvoicesApiGetInvoicesExportRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesExportResponse>
  - 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.
    Parameters
    - requestParameters: InvoicesApiGetInvoicesExportRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetInvoicesExportResponse>
    Throws
    - Defined in api-model/api/invoices-api.ts:569
- getInvoicesExports:function
  - getInvoicesExports(
    requestParameters: InvoicesApiGetInvoicesExportsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetInvoicesExportsResponse>
  - 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.
    Parameters
    - requestParameters: InvoicesApiGetInvoicesExportsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetInvoicesExportsResponse>
    Throws
    - Defined in api-model/api/invoices-api.ts:578
- Defined in api-model/api/invoices-api.ts:515

Function InvoicesApiFactory

Export

Parameters

createInvoicesExport:function

Parameters

Returns AxiosPromise<ExportInvoicesResponse>

Throws

getInvoice:function

Parameters

Returns AxiosPromise<GetInvoiceResponse>

Throws

getInvoices:function

Parameters

Returns AxiosPromise<GetInvoicesResponse>

Throws

getInvoicesAttributes:function

Parameters

Returns AxiosPromise<GetInvoicesAttributesResponse>

Throws

getInvoicesDocument:function

Parameters

Returns AxiosPromise<GetInvoicesDocumentResponse>

Throws

getInvoicesExport:function

Parameters

Returns AxiosPromise<GetInvoicesExportResponse>

Throws

getInvoicesExports:function

Parameters

Returns AxiosPromise<GetInvoicesExportsResponse>

Throws

Settings