@sp-api-sdk/shipment-invoicing-api-v0/dist/types/api-model/api/shipment-invoice-api.d.ts

The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in the Brazil marketplace for a selling partner’s Fulfillment by Amazon (FBA) orders.

/**
 * Selling Partner API for Shipment Invoicing
 * The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in the Brazil marketplace for a selling partner’s Fulfillment by Amazon (FBA) orders.
 *
 * The version of the OpenAPI document: v0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { GetInvoiceStatusResponse } from '../models';
import type { GetShipmentDetailsResponse } from '../models';
import type { SubmitInvoiceRequest } from '../models';
import type { SubmitInvoiceResponse } from '../models';
/**
 * ShipmentInvoiceApi - axios parameter creator
 * @export
 */
export declare const ShipmentInvoiceApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Returns the invoice status for the shipment you specify.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {string} shipmentId The shipment identifier for the shipment.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvoiceStatus: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns the shipment details required to issue an invoice for the specified shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {string} shipmentId The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getShipmentDetails: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Submits a shipment invoice document for a given shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {string} shipmentId The identifier for the shipment.
     * @param {SubmitInvoiceRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitInvoice: (shipmentId: string, body: SubmitInvoiceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ShipmentInvoiceApi - functional programming interface
 * @export
 */
export declare const ShipmentInvoiceApiFp: (configuration?: Configuration) => {
    /**
     * Returns the invoice status for the shipment you specify.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {string} shipmentId The shipment identifier for the shipment.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvoiceStatus(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoiceStatusResponse>>;
    /**
     * Returns the shipment details required to issue an invoice for the specified shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {string} shipmentId The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getShipmentDetails(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentDetailsResponse>>;
    /**
     * Submits a shipment invoice document for a given shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {string} shipmentId The identifier for the shipment.
     * @param {SubmitInvoiceRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitInvoice(shipmentId: string, body: SubmitInvoiceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitInvoiceResponse>>;
};
/**
 * ShipmentInvoiceApi - factory interface
 * @export
 */
export declare const ShipmentInvoiceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Returns the invoice status for the shipment you specify.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {ShipmentInvoiceApiGetInvoiceStatusRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvoiceStatus(requestParameters: ShipmentInvoiceApiGetInvoiceStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInvoiceStatusResponse>;
    /**
     * Returns the shipment details required to issue an invoice for the specified shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {ShipmentInvoiceApiGetShipmentDetailsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getShipmentDetails(requestParameters: ShipmentInvoiceApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentDetailsResponse>;
    /**
     * Submits a shipment invoice document for a given shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {ShipmentInvoiceApiSubmitInvoiceRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitInvoice(requestParameters: ShipmentInvoiceApiSubmitInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitInvoiceResponse>;
};
/**
 * Request parameters for getInvoiceStatus operation in ShipmentInvoiceApi.
 * @export
 * @interface ShipmentInvoiceApiGetInvoiceStatusRequest
 */
export interface ShipmentInvoiceApiGetInvoiceStatusRequest {
    /**
     * The shipment identifier for the shipment.
     * @type {string}
     * @memberof ShipmentInvoiceApiGetInvoiceStatus
     */
    readonly shipmentId: string;
}
/**
 * Request parameters for getShipmentDetails operation in ShipmentInvoiceApi.
 * @export
 * @interface ShipmentInvoiceApiGetShipmentDetailsRequest
 */
export interface ShipmentInvoiceApiGetShipmentDetailsRequest {
    /**
     * The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
     * @type {string}
     * @memberof ShipmentInvoiceApiGetShipmentDetails
     */
    readonly shipmentId: string;
}
/**
 * Request parameters for submitInvoice operation in ShipmentInvoiceApi.
 * @export
 * @interface ShipmentInvoiceApiSubmitInvoiceRequest
 */
export interface ShipmentInvoiceApiSubmitInvoiceRequest {
    /**
     * The identifier for the shipment.
     * @type {string}
     * @memberof ShipmentInvoiceApiSubmitInvoice
     */
    readonly shipmentId: string;
    /**
     *
     * @type {SubmitInvoiceRequest}
     * @memberof ShipmentInvoiceApiSubmitInvoice
     */
    readonly body: SubmitInvoiceRequest;
}
/**
 * ShipmentInvoiceApi - object-oriented interface
 * @export
 * @class ShipmentInvoiceApi
 * @extends {BaseAPI}
 */
export declare class ShipmentInvoiceApi extends BaseAPI {
    /**
     * Returns the invoice status for the shipment you specify.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {ShipmentInvoiceApiGetInvoiceStatusRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShipmentInvoiceApi
     */
    getInvoiceStatus(requestParameters: ShipmentInvoiceApiGetInvoiceStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoiceStatusResponse, any>>;
    /**
     * Returns the shipment details required to issue an invoice for the specified shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {ShipmentInvoiceApiGetShipmentDetailsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShipmentInvoiceApi
     */
    getShipmentDetails(requestParameters: ShipmentInvoiceApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentDetailsResponse, any>>;
    /**
     * Submits a shipment invoice document for a given shipment.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
     * @param {ShipmentInvoiceApiSubmitInvoiceRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShipmentInvoiceApi
     */
    submitInvoice(requestParameters: ShipmentInvoiceApiSubmitInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitInvoiceResponse, any>>;
}