Package software.amazon.spapi.api.invoicing.v0

Class ShipmentInvoiceApi

java.lang.Object

software.amazon.spapi.api.invoicing.v0.ShipmentInvoiceApi

public class ShipmentInvoiceApi
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShipmentInvoiceApi.Builder

Field Summary

Fields

Modifier and Type	Field	Description
io.github.bucket4j.Bucket	getInvoiceStatusBucket
io.github.bucket4j.Bucket	getShipmentDetailsBucket
io.github.bucket4j.Bucket	submitInvoiceBucket

Constructor Summary

Constructors

Constructor	Description
ShipmentInvoiceApi(ApiClient apiClient, java.lang.Boolean disableRateLimiting)

Method Summary

Modifier and Type	Method	Description
GetInvoiceStatusResponse	getInvoiceStatus(java.lang.String shipmentId)	Returns the invoice status for the shipment you specify.
okhttp3.Call	getInvoiceStatusAsync(java.lang.String shipmentId, ApiCallback<GetInvoiceStatusResponse> callback)	(asynchronously) Returns the invoice status for the shipment you specify.
ApiResponse<GetInvoiceStatusResponse>	getInvoiceStatusWithHttpInfo(java.lang.String shipmentId)	Returns the invoice status for the shipment you specify.
GetShipmentDetailsResponse	getShipmentDetails(java.lang.String shipmentId)	Returns the shipment details required to issue an invoice for the specified shipment.
okhttp3.Call	getShipmentDetailsAsync(java.lang.String shipmentId, ApiCallback<GetShipmentDetailsResponse> callback)	(asynchronously) Returns the shipment details required to issue an invoice for the specified shipment.
ApiResponse<GetShipmentDetailsResponse>	getShipmentDetailsWithHttpInfo(java.lang.String shipmentId)	Returns the shipment details required to issue an invoice for the specified shipment.
SubmitInvoiceResponse	submitInvoice(SubmitInvoiceRequest body, java.lang.String shipmentId)	Submits a shipment invoice document for a given shipment.
okhttp3.Call	submitInvoiceAsync(SubmitInvoiceRequest body, java.lang.String shipmentId, ApiCallback<SubmitInvoiceResponse> callback)	(asynchronously) Submits a shipment invoice document for a given shipment.
ApiResponse<SubmitInvoiceResponse>	submitInvoiceWithHttpInfo(SubmitInvoiceRequest body, java.lang.String shipmentId)	Submits a shipment invoice document for a given shipment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

getInvoiceStatusBucket

public final io.github.bucket4j.Bucket getInvoiceStatusBucket

getShipmentDetailsBucket

public final io.github.bucket4j.Bucket getShipmentDetailsBucket

submitInvoiceBucket

public final io.github.bucket4j.Bucket submitInvoiceBucket

Constructor Detail

ShipmentInvoiceApi

public ShipmentInvoiceApi(ApiClient apiClient,
                          java.lang.Boolean disableRateLimiting)

Method Detail

getInvoiceStatus

public GetInvoiceStatusResponse getInvoiceStatus(java.lang.String shipmentId)
                                          throws ApiException,
                                                 LWAException

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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

shipmentId - The shipment identifier for the shipment. (required)

Returns:

GetInvoiceStatusResponse

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

getInvoiceStatusWithHttpInfo

public ApiResponse<GetInvoiceStatusResponse> getInvoiceStatusWithHttpInfo(java.lang.String shipmentId)
                                                                   throws ApiException,
                                                                          LWAException

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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

shipmentId - The shipment identifier for the shipment. (required)

Returns:

ApiResponse<GetInvoiceStatusResponse>

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

getInvoiceStatusAsync

public okhttp3.Call getInvoiceStatusAsync(java.lang.String shipmentId,
                                          ApiCallback<GetInvoiceStatusResponse> callback)
                                   throws ApiException,
                                          LWAException

(asynchronously) 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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

shipmentId - The shipment identifier for the shipment. (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

getShipmentDetails

public GetShipmentDetailsResponse getShipmentDetails(java.lang.String shipmentId)
                                              throws ApiException,
                                                     LWAException

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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

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](doc:notifications-api-v1-use-case-guide). (required)

Returns:

GetShipmentDetailsResponse

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

getShipmentDetailsWithHttpInfo

public ApiResponse<GetShipmentDetailsResponse> getShipmentDetailsWithHttpInfo(java.lang.String shipmentId)
                                                                       throws ApiException,
                                                                              LWAException

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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

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](doc:notifications-api-v1-use-case-guide). (required)

Returns:

ApiResponse<GetShipmentDetailsResponse>

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

getShipmentDetailsAsync

public okhttp3.Call getShipmentDetailsAsync(java.lang.String shipmentId,
                                            ApiCallback<GetShipmentDetailsResponse> callback)
                                     throws ApiException,
                                            LWAException

(asynchronously) 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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

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](doc:notifications-api-v1-use-case-guide). (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

submitInvoice

public SubmitInvoiceResponse submitInvoice(SubmitInvoiceRequest body,
                                           java.lang.String shipmentId)
                                    throws ApiException,
                                           LWAException

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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

body - (required)

shipmentId - The identifier for the shipment. (required)

Returns:

SubmitInvoiceResponse

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

submitInvoiceWithHttpInfo

public ApiResponse<SubmitInvoiceResponse> submitInvoiceWithHttpInfo(SubmitInvoiceRequest body,
                                                                    java.lang.String shipmentId)
                                                             throws ApiException,
                                                                    LWAException

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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

body - (required)

shipmentId - The identifier for the shipment. (required)

Returns:

ApiResponse<SubmitInvoiceResponse>

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

submitInvoiceAsync

public okhttp3.Call submitInvoiceAsync(SubmitInvoiceRequest body,
                                       java.lang.String shipmentId,
                                       ApiCallback<SubmitInvoiceResponse> callback)
                                throws ApiException,
                                       LWAException

(asynchronously) 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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

body - (required)

shipmentId - The identifier for the shipment. (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