Class ShipmentInvoiceApi

ShipmentInvoiceApi - object-oriented interface

Export

ShipmentInvoiceApi

Hierarchy (View Summary)

BaseAPI
- ShipmentInvoiceApi
  - ShipmentInvoicingApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getInvoiceStatus getShipmentDetails submitInvoice

Constructors

constructor

new ShipmentInvoiceApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): ShipmentInvoiceApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ShipmentInvoiceApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getInvoiceStatus

getInvoiceStatus(
requestParameters: ShipmentInvoiceApiGetInvoiceStatusRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoiceStatusResponse, any>>
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.
Parameters
- requestParameters: ShipmentInvoiceApiGetInvoiceStatusRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoiceStatusResponse, any>>
Throws
Memberof
ShipmentInvoiceApi
- Defined in api-model/api/shipment-invoice-api.ts:293

getShipmentDetails

getShipmentDetails(
requestParameters: ShipmentInvoiceApiGetShipmentDetailsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetShipmentDetailsResponse, 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.
Parameters
- requestParameters: ShipmentInvoiceApiGetShipmentDetailsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetShipmentDetailsResponse, any>>
Throws
Memberof
ShipmentInvoiceApi
- Defined in api-model/api/shipment-invoice-api.ts:304

submitInvoice

submitInvoice(
requestParameters: ShipmentInvoiceApiSubmitInvoiceRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SubmitInvoiceResponse, 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.
Parameters
- requestParameters: ShipmentInvoiceApiSubmitInvoiceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SubmitInvoiceResponse, any>>
Throws
Memberof
ShipmentInvoiceApi
- Defined in api-model/api/shipment-invoice-api.ts:315