Class ShippingApi
- java.lang.Object
-
- software.amazon.spapi.api.shipping.v2.ShippingApi
-
public class ShippingApi extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ShippingApi.Builder
-
Field Summary
Fields Modifier and Type Field Description io.github.bucket4j.Bucket
cancelShipmentBucket
io.github.bucket4j.Bucket
createClaimBucket
io.github.bucket4j.Bucket
directPurchaseShipmentBucket
io.github.bucket4j.Bucket
generateCollectionFormBucket
io.github.bucket4j.Bucket
getAccessPointsBucket
io.github.bucket4j.Bucket
getAdditionalInputsBucket
io.github.bucket4j.Bucket
getCarrierAccountFormInputsBucket
io.github.bucket4j.Bucket
getCarrierAccountsBucket
io.github.bucket4j.Bucket
getCollectionFormBucket
io.github.bucket4j.Bucket
getCollectionFormHistoryBucket
io.github.bucket4j.Bucket
getRatesBucket
io.github.bucket4j.Bucket
getShipmentDocumentsBucket
io.github.bucket4j.Bucket
getTrackingBucket
io.github.bucket4j.Bucket
getUnmanifestedShipmentsBucket
io.github.bucket4j.Bucket
linkCarrierAccount_0Bucket
io.github.bucket4j.Bucket
linkCarrierAccountBucket
io.github.bucket4j.Bucket
oneClickShipmentBucket
io.github.bucket4j.Bucket
purchaseShipmentBucket
io.github.bucket4j.Bucket
submitNdrFeedbackBucket
io.github.bucket4j.Bucket
unlinkCarrierAccountBucket
-
Constructor Summary
Constructors Constructor Description ShippingApi(ApiClient apiClient, java.lang.Boolean disableRateLimiting)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CancelShipmentResponse
cancelShipment(java.lang.String shipmentId, java.lang.String xAmznShippingBusinessId)
Cancels a purchased shipment.okhttp3.Call
cancelShipmentAsync(java.lang.String shipmentId, java.lang.String xAmznShippingBusinessId, ApiCallback<CancelShipmentResponse> callback)
(asynchronously) Cancels a purchased shipment.ApiResponse<CancelShipmentResponse>
cancelShipmentWithHttpInfo(java.lang.String shipmentId, java.lang.String xAmznShippingBusinessId)
Cancels a purchased shipment.CreateClaimResponse
createClaim(CreateClaimRequest body, java.lang.String xAmznShippingBusinessId)
This API will be used to create claim for single eligible shipment.okhttp3.Call
createClaimAsync(CreateClaimRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<CreateClaimResponse> callback)
(asynchronously) This API will be used to create claim for single eligible shipment.ApiResponse<CreateClaimResponse>
createClaimWithHttpInfo(CreateClaimRequest body, java.lang.String xAmznShippingBusinessId)
This API will be used to create claim for single eligible shipment.DirectPurchaseResponse
directPurchaseShipment(DirectPurchaseRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String locale, java.lang.String xAmznShippingBusinessId)
Purchases the shipping service for a shipment using the best fit service offering.okhttp3.Call
directPurchaseShipmentAsync(DirectPurchaseRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String locale, java.lang.String xAmznShippingBusinessId, ApiCallback<DirectPurchaseResponse> callback)
(asynchronously) Purchases the shipping service for a shipment using the best fit service offering.ApiResponse<DirectPurchaseResponse>
directPurchaseShipmentWithHttpInfo(DirectPurchaseRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String locale, java.lang.String xAmznShippingBusinessId)
Purchases the shipping service for a shipment using the best fit service offering.GenerateCollectionFormResponse
generateCollectionForm(GenerateCollectionFormRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId)
This API Call to generate the collection form.okhttp3.Call
generateCollectionFormAsync(GenerateCollectionFormRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId, ApiCallback<GenerateCollectionFormResponse> callback)
(asynchronously) This API Call to generate the collection form.ApiResponse<GenerateCollectionFormResponse>
generateCollectionFormWithHttpInfo(GenerateCollectionFormRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId)
This API Call to generate the collection form.GetAccessPointsResponse
getAccessPoints(java.util.List<java.lang.String> accessPointTypes, java.lang.String countryCode, java.lang.String postalCode, java.lang.String xAmznShippingBusinessId)
Returns a list of access points in proximity of input postal code.okhttp3.Call
getAccessPointsAsync(java.util.List<java.lang.String> accessPointTypes, java.lang.String countryCode, java.lang.String postalCode, java.lang.String xAmznShippingBusinessId, ApiCallback<GetAccessPointsResponse> callback)
(asynchronously) Returns a list of access points in proximity of input postal code.ApiResponse<GetAccessPointsResponse>
getAccessPointsWithHttpInfo(java.util.List<java.lang.String> accessPointTypes, java.lang.String countryCode, java.lang.String postalCode, java.lang.String xAmznShippingBusinessId)
Returns a list of access points in proximity of input postal code.GetAdditionalInputsResponse
getAdditionalInputs(java.lang.String requestToken, java.lang.String rateId, java.lang.String xAmznShippingBusinessId)
Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering.okhttp3.Call
getAdditionalInputsAsync(java.lang.String requestToken, java.lang.String rateId, java.lang.String xAmznShippingBusinessId, ApiCallback<GetAdditionalInputsResponse> callback)
(asynchronously) Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering.ApiResponse<GetAdditionalInputsResponse>
getAdditionalInputsWithHttpInfo(java.lang.String requestToken, java.lang.String rateId, java.lang.String xAmznShippingBusinessId)
Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering.GetCarrierAccountFormInputsResponse
getCarrierAccountFormInputs(java.lang.String xAmznShippingBusinessId)
This API will return a list of input schema required to register a shipper account with the carrier.okhttp3.Call
getCarrierAccountFormInputsAsync(java.lang.String xAmznShippingBusinessId, ApiCallback<GetCarrierAccountFormInputsResponse> callback)
(asynchronously) This API will return a list of input schema required to register a shipper account with the carrier.ApiResponse<GetCarrierAccountFormInputsResponse>
getCarrierAccountFormInputsWithHttpInfo(java.lang.String xAmznShippingBusinessId)
This API will return a list of input schema required to register a shipper account with the carrier.GetCarrierAccountsResponse
getCarrierAccounts(GetCarrierAccountsRequest body, java.lang.String xAmznShippingBusinessId)
This API will return Get all carrier accounts for a merchant.okhttp3.Call
getCarrierAccountsAsync(GetCarrierAccountsRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<GetCarrierAccountsResponse> callback)
(asynchronously) This API will return Get all carrier accounts for a merchant.ApiResponse<GetCarrierAccountsResponse>
getCarrierAccountsWithHttpInfo(GetCarrierAccountsRequest body, java.lang.String xAmznShippingBusinessId)
This API will return Get all carrier accounts for a merchant.GetCollectionFormResponse
getCollectionForm(java.lang.String collectionFormId, java.lang.String xAmznShippingBusinessId)
This API reprint a collection form.okhttp3.Call
getCollectionFormAsync(java.lang.String collectionFormId, java.lang.String xAmznShippingBusinessId, ApiCallback<GetCollectionFormResponse> callback)
(asynchronously) This API reprint a collection form.GetCollectionFormHistoryResponse
getCollectionFormHistory(GetCollectionFormHistoryRequest body, java.lang.String xAmznShippingBusinessId)
This API Call to get the history of the previously generated collection forms.okhttp3.Call
getCollectionFormHistoryAsync(GetCollectionFormHistoryRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<GetCollectionFormHistoryResponse> callback)
(asynchronously) This API Call to get the history of the previously generated collection forms.ApiResponse<GetCollectionFormHistoryResponse>
getCollectionFormHistoryWithHttpInfo(GetCollectionFormHistoryRequest body, java.lang.String xAmznShippingBusinessId)
This API Call to get the history of the previously generated collection forms.ApiResponse<GetCollectionFormResponse>
getCollectionFormWithHttpInfo(java.lang.String collectionFormId, java.lang.String xAmznShippingBusinessId)
This API reprint a collection form.GetRatesResponse
getRates(GetRatesRequest body, java.lang.String xAmznShippingBusinessId)
Returns the available shipping service offerings.okhttp3.Call
getRatesAsync(GetRatesRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<GetRatesResponse> callback)
(asynchronously) Returns the available shipping service offerings.ApiResponse<GetRatesResponse>
getRatesWithHttpInfo(GetRatesRequest body, java.lang.String xAmznShippingBusinessId)
Returns the available shipping service offerings.GetShipmentDocumentsResponse
getShipmentDocuments(java.lang.String shipmentId, java.lang.String packageClientReferenceId, java.lang.String format, java.math.BigDecimal dpi, java.lang.String xAmznShippingBusinessId)
Returns the shipping documents associated with a package in a shipment.okhttp3.Call
getShipmentDocumentsAsync(java.lang.String shipmentId, java.lang.String packageClientReferenceId, java.lang.String format, java.math.BigDecimal dpi, java.lang.String xAmznShippingBusinessId, ApiCallback<GetShipmentDocumentsResponse> callback)
(asynchronously) Returns the shipping documents associated with a package in a shipment.ApiResponse<GetShipmentDocumentsResponse>
getShipmentDocumentsWithHttpInfo(java.lang.String shipmentId, java.lang.String packageClientReferenceId, java.lang.String format, java.math.BigDecimal dpi, java.lang.String xAmznShippingBusinessId)
Returns the shipping documents associated with a package in a shipment.GetTrackingResponse
getTracking(java.lang.String trackingId, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId)
Returns tracking information for a purchased shipment.okhttp3.Call
getTrackingAsync(java.lang.String trackingId, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId, ApiCallback<GetTrackingResponse> callback)
(asynchronously) Returns tracking information for a purchased shipment.ApiResponse<GetTrackingResponse>
getTrackingWithHttpInfo(java.lang.String trackingId, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId)
Returns tracking information for a purchased shipment.GetUnmanifestedShipmentsResponse
getUnmanifestedShipments(GetUnmanifestedShipmentsRequest body, java.lang.String xAmznShippingBusinessId)
This API Get all unmanifested carriers with shipment locations.okhttp3.Call
getUnmanifestedShipmentsAsync(GetUnmanifestedShipmentsRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<GetUnmanifestedShipmentsResponse> callback)
(asynchronously) This API Get all unmanifested carriers with shipment locations.ApiResponse<GetUnmanifestedShipmentsResponse>
getUnmanifestedShipmentsWithHttpInfo(GetUnmanifestedShipmentsRequest body, java.lang.String xAmznShippingBusinessId)
This API Get all unmanifested carriers with shipment locations.LinkCarrierAccountResponse
linkCarrierAccount(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId)
This API associates/links the specified carrier account with the merchant.LinkCarrierAccountResponse
linkCarrierAccount_0(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId)
This API associates/links the specified carrier account with the merchant.okhttp3.Call
linkCarrierAccount_0Async(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId, ApiCallback<LinkCarrierAccountResponse> callback)
(asynchronously) This API associates/links the specified carrier account with the merchant.ApiResponse<LinkCarrierAccountResponse>
linkCarrierAccount_0WithHttpInfo(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId)
This API associates/links the specified carrier account with the merchant.okhttp3.Call
linkCarrierAccountAsync(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId, ApiCallback<LinkCarrierAccountResponse> callback)
(asynchronously) This API associates/links the specified carrier account with the merchant.ApiResponse<LinkCarrierAccountResponse>
linkCarrierAccountWithHttpInfo(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId)
This API associates/links the specified carrier account with the merchant.OneClickShipmentResponse
oneClickShipment(OneClickShipmentRequest body, java.lang.String xAmznShippingBusinessId)
Purchases a shipping service identifier and returns purchase-related details and documents.okhttp3.Call
oneClickShipmentAsync(OneClickShipmentRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<OneClickShipmentResponse> callback)
(asynchronously) Purchases a shipping service identifier and returns purchase-related details and documents.ApiResponse<OneClickShipmentResponse>
oneClickShipmentWithHttpInfo(OneClickShipmentRequest body, java.lang.String xAmznShippingBusinessId)
Purchases a shipping service identifier and returns purchase-related details and documents.PurchaseShipmentResponse
purchaseShipment(PurchaseShipmentRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId)
Purchases a shipping service and returns purchase related details and documents.okhttp3.Call
purchaseShipmentAsync(PurchaseShipmentRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId, ApiCallback<PurchaseShipmentResponse> callback)
(asynchronously) Purchases a shipping service and returns purchase related details and documents.ApiResponse<PurchaseShipmentResponse>
purchaseShipmentWithHttpInfo(PurchaseShipmentRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId)
Purchases a shipping service and returns purchase related details and documents.void
submitNdrFeedback(SubmitNdrFeedbackRequest body, java.lang.String xAmznShippingBusinessId)
This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment.okhttp3.Call
submitNdrFeedbackAsync(SubmitNdrFeedbackRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<java.lang.Void> callback)
(asynchronously) This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment.ApiResponse<java.lang.Void>
submitNdrFeedbackWithHttpInfo(SubmitNdrFeedbackRequest body, java.lang.String xAmznShippingBusinessId)
This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment.UnlinkCarrierAccountResponse
unlinkCarrierAccount(UnlinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId)
This API Unlink the specified carrier account with the merchant.okhttp3.Call
unlinkCarrierAccountAsync(UnlinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId, ApiCallback<UnlinkCarrierAccountResponse> callback)
(asynchronously) This API Unlink the specified carrier account with the merchant.ApiResponse<UnlinkCarrierAccountResponse>
unlinkCarrierAccountWithHttpInfo(UnlinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId)
This API Unlink the specified carrier account with the merchant.
-
-
-
Field Detail
-
cancelShipmentBucket
public final io.github.bucket4j.Bucket cancelShipmentBucket
-
createClaimBucket
public final io.github.bucket4j.Bucket createClaimBucket
-
directPurchaseShipmentBucket
public final io.github.bucket4j.Bucket directPurchaseShipmentBucket
-
generateCollectionFormBucket
public final io.github.bucket4j.Bucket generateCollectionFormBucket
-
getAccessPointsBucket
public final io.github.bucket4j.Bucket getAccessPointsBucket
-
getAdditionalInputsBucket
public final io.github.bucket4j.Bucket getAdditionalInputsBucket
-
getCarrierAccountFormInputsBucket
public final io.github.bucket4j.Bucket getCarrierAccountFormInputsBucket
-
getCarrierAccountsBucket
public final io.github.bucket4j.Bucket getCarrierAccountsBucket
-
getCollectionFormBucket
public final io.github.bucket4j.Bucket getCollectionFormBucket
-
getCollectionFormHistoryBucket
public final io.github.bucket4j.Bucket getCollectionFormHistoryBucket
-
getRatesBucket
public final io.github.bucket4j.Bucket getRatesBucket
-
getShipmentDocumentsBucket
public final io.github.bucket4j.Bucket getShipmentDocumentsBucket
-
getTrackingBucket
public final io.github.bucket4j.Bucket getTrackingBucket
-
getUnmanifestedShipmentsBucket
public final io.github.bucket4j.Bucket getUnmanifestedShipmentsBucket
-
linkCarrierAccountBucket
public final io.github.bucket4j.Bucket linkCarrierAccountBucket
-
linkCarrierAccount_0Bucket
public final io.github.bucket4j.Bucket linkCarrierAccount_0Bucket
-
oneClickShipmentBucket
public final io.github.bucket4j.Bucket oneClickShipmentBucket
-
purchaseShipmentBucket
public final io.github.bucket4j.Bucket purchaseShipmentBucket
-
submitNdrFeedbackBucket
public final io.github.bucket4j.Bucket submitNdrFeedbackBucket
-
unlinkCarrierAccountBucket
public final io.github.bucket4j.Bucket unlinkCarrierAccountBucket
-
-
Constructor Detail
-
ShippingApi
public ShippingApi(ApiClient apiClient, java.lang.Boolean disableRateLimiting)
-
-
Method Detail
-
cancelShipment
public CancelShipmentResponse cancelShipment(java.lang.String shipmentId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
shipmentId
- The shipment identifier originally returned by the purchaseShipment operation. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- CancelShipmentResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
cancelShipmentWithHttpInfo
public ApiResponse<CancelShipmentResponse> cancelShipmentWithHttpInfo(java.lang.String shipmentId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
shipmentId
- The shipment identifier originally returned by the purchaseShipment operation. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<CancelShipmentResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
cancelShipmentAsync
public okhttp3.Call cancelShipmentAsync(java.lang.String shipmentId, java.lang.String xAmznShippingBusinessId, ApiCallback<CancelShipmentResponse> callback) throws ApiException, LWAException
(asynchronously) Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
shipmentId
- The shipment identifier originally returned by the purchaseShipment operation. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
createClaim
public CreateClaimResponse createClaim(CreateClaimRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API will be used to create claim for single eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
- Request body for the createClaim operation (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- CreateClaimResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
createClaimWithHttpInfo
public ApiResponse<CreateClaimResponse> createClaimWithHttpInfo(CreateClaimRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API will be used to create claim for single eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
- Request body for the createClaim operation (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<CreateClaimResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
createClaimAsync
public okhttp3.Call createClaimAsync(CreateClaimRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<CreateClaimResponse> callback) throws ApiException, LWAException
(asynchronously) This API will be used to create claim for single eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
- Request body for the createClaim operation (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
directPurchaseShipment
public DirectPurchaseResponse directPurchaseShipment(DirectPurchaseRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String locale, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- DirectPurchaseRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)locale
- The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- DirectPurchaseResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
directPurchaseShipmentWithHttpInfo
public ApiResponse<DirectPurchaseResponse> directPurchaseShipmentWithHttpInfo(DirectPurchaseRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String locale, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- DirectPurchaseRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)locale
- The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<DirectPurchaseResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
directPurchaseShipmentAsync
public okhttp3.Call directPurchaseShipmentAsync(DirectPurchaseRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String locale, java.lang.String xAmznShippingBusinessId, ApiCallback<DirectPurchaseResponse> callback) throws ApiException, LWAException
(asynchronously) Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- DirectPurchaseRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)locale
- The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
generateCollectionForm
public GenerateCollectionFormResponse generateCollectionForm(GenerateCollectionFormRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GenerateCollectionFormRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GenerateCollectionFormResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
generateCollectionFormWithHttpInfo
public ApiResponse<GenerateCollectionFormResponse> generateCollectionFormWithHttpInfo(GenerateCollectionFormRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GenerateCollectionFormRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GenerateCollectionFormResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
generateCollectionFormAsync
public okhttp3.Call generateCollectionFormAsync(GenerateCollectionFormRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId, ApiCallback<GenerateCollectionFormResponse> callback) throws ApiException, LWAException
(asynchronously) This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GenerateCollectionFormRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getAccessPoints
public GetAccessPointsResponse getAccessPoints(java.util.List<java.lang.String> accessPointTypes, java.lang.String countryCode, java.lang.String postalCode, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
accessPointTypes
- Access point types (required)countryCode
- Country code for access point (required)postalCode
- postal code for access point (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetAccessPointsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getAccessPointsWithHttpInfo
public ApiResponse<GetAccessPointsResponse> getAccessPointsWithHttpInfo(java.util.List<java.lang.String> accessPointTypes, java.lang.String countryCode, java.lang.String postalCode, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
accessPointTypes
- Access point types (required)countryCode
- Country code for access point (required)postalCode
- postal code for access point (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetAccessPointsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getAccessPointsAsync
public okhttp3.Call getAccessPointsAsync(java.util.List<java.lang.String> accessPointTypes, java.lang.String countryCode, java.lang.String postalCode, java.lang.String xAmznShippingBusinessId, ApiCallback<GetAccessPointsResponse> callback) throws ApiException, LWAException
(asynchronously) Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
accessPointTypes
- Access point types (required)countryCode
- Country code for access point (required)postalCode
- postal code for access point (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getAdditionalInputs
public GetAdditionalInputsResponse getAdditionalInputs(java.lang.String requestToken, java.lang.String rateId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
requestToken
- The request token returned in the response to the getRates operation. (required)rateId
- The rate identifier for the shipping offering (rate) returned in the response to the getRates operation. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetAdditionalInputsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getAdditionalInputsWithHttpInfo
public ApiResponse<GetAdditionalInputsResponse> getAdditionalInputsWithHttpInfo(java.lang.String requestToken, java.lang.String rateId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
requestToken
- The request token returned in the response to the getRates operation. (required)rateId
- The rate identifier for the shipping offering (rate) returned in the response to the getRates operation. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetAdditionalInputsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getAdditionalInputsAsync
public okhttp3.Call getAdditionalInputsAsync(java.lang.String requestToken, java.lang.String rateId, java.lang.String xAmznShippingBusinessId, ApiCallback<GetAdditionalInputsResponse> callback) throws ApiException, LWAException
(asynchronously) Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
requestToken
- The request token returned in the response to the getRates operation. (required)rateId
- The rate identifier for the shipping offering (rate) returned in the response to the getRates operation. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getCarrierAccountFormInputs
public GetCarrierAccountFormInputsResponse getCarrierAccountFormInputs(java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API will return a list of input schema required to register a shipper account with the carrier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetCarrierAccountFormInputsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getCarrierAccountFormInputsWithHttpInfo
public ApiResponse<GetCarrierAccountFormInputsResponse> getCarrierAccountFormInputsWithHttpInfo(java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API will return a list of input schema required to register a shipper account with the carrier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetCarrierAccountFormInputsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getCarrierAccountFormInputsAsync
public okhttp3.Call getCarrierAccountFormInputsAsync(java.lang.String xAmznShippingBusinessId, ApiCallback<GetCarrierAccountFormInputsResponse> callback) throws ApiException, LWAException
(asynchronously) This API will return a list of input schema required to register a shipper account with the carrier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getCarrierAccounts
public GetCarrierAccountsResponse getCarrierAccounts(GetCarrierAccountsRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetCarrierAccountsRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetCarrierAccountsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getCarrierAccountsWithHttpInfo
public ApiResponse<GetCarrierAccountsResponse> getCarrierAccountsWithHttpInfo(GetCarrierAccountsRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetCarrierAccountsRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetCarrierAccountsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getCarrierAccountsAsync
public okhttp3.Call getCarrierAccountsAsync(GetCarrierAccountsRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<GetCarrierAccountsResponse> callback) throws ApiException, LWAException
(asynchronously) This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetCarrierAccountsRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getCollectionForm
public GetCollectionFormResponse getCollectionForm(java.lang.String collectionFormId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API reprint a collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
collectionFormId
- collection form Id to reprint a collection. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetCollectionFormResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getCollectionFormWithHttpInfo
public ApiResponse<GetCollectionFormResponse> getCollectionFormWithHttpInfo(java.lang.String collectionFormId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API reprint a collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
collectionFormId
- collection form Id to reprint a collection. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetCollectionFormResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getCollectionFormAsync
public okhttp3.Call getCollectionFormAsync(java.lang.String collectionFormId, java.lang.String xAmznShippingBusinessId, ApiCallback<GetCollectionFormResponse> callback) throws ApiException, LWAException
(asynchronously) This API reprint a collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
collectionFormId
- collection form Id to reprint a collection. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getCollectionFormHistory
public GetCollectionFormHistoryResponse getCollectionFormHistory(GetCollectionFormHistoryRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetCollectionFormHistoryRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetCollectionFormHistoryResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getCollectionFormHistoryWithHttpInfo
public ApiResponse<GetCollectionFormHistoryResponse> getCollectionFormHistoryWithHttpInfo(GetCollectionFormHistoryRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetCollectionFormHistoryRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetCollectionFormHistoryResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getCollectionFormHistoryAsync
public okhttp3.Call getCollectionFormHistoryAsync(GetCollectionFormHistoryRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<GetCollectionFormHistoryResponse> callback) throws ApiException, LWAException
(asynchronously) This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetCollectionFormHistoryRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getRates
public GetRatesResponse getRates(GetRatesRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetRatesRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetRatesResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getRatesWithHttpInfo
public ApiResponse<GetRatesResponse> getRatesWithHttpInfo(GetRatesRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetRatesRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetRatesResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getRatesAsync
public okhttp3.Call getRatesAsync(GetRatesRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<GetRatesResponse> callback) throws ApiException, LWAException
(asynchronously) Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetRatesRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getShipmentDocuments
public GetShipmentDocumentsResponse getShipmentDocuments(java.lang.String shipmentId, java.lang.String packageClientReferenceId, java.lang.String format, java.math.BigDecimal dpi, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns the shipping documents associated with a package in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
shipmentId
- The shipment identifier originally returned by the purchaseShipment operation. (required)packageClientReferenceId
- The package client reference identifier originally provided in the request body parameter for the getRates operation. (required)format
- The file format of the document. Must be one of the supported formats returned by the getRates operation. (optional)dpi
- The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetShipmentDocumentsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getShipmentDocumentsWithHttpInfo
public ApiResponse<GetShipmentDocumentsResponse> getShipmentDocumentsWithHttpInfo(java.lang.String shipmentId, java.lang.String packageClientReferenceId, java.lang.String format, java.math.BigDecimal dpi, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns the shipping documents associated with a package in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
shipmentId
- The shipment identifier originally returned by the purchaseShipment operation. (required)packageClientReferenceId
- The package client reference identifier originally provided in the request body parameter for the getRates operation. (required)format
- The file format of the document. Must be one of the supported formats returned by the getRates operation. (optional)dpi
- The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetShipmentDocumentsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getShipmentDocumentsAsync
public okhttp3.Call getShipmentDocumentsAsync(java.lang.String shipmentId, java.lang.String packageClientReferenceId, java.lang.String format, java.math.BigDecimal dpi, java.lang.String xAmznShippingBusinessId, ApiCallback<GetShipmentDocumentsResponse> callback) throws ApiException, LWAException
(asynchronously) Returns the shipping documents associated with a package in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
shipmentId
- The shipment identifier originally returned by the purchaseShipment operation. (required)packageClientReferenceId
- The package client reference identifier originally provided in the request body parameter for the getRates operation. (required)format
- The file format of the document. Must be one of the supported formats returned by the getRates operation. (optional)dpi
- The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getTracking
public GetTrackingResponse getTracking(java.lang.String trackingId, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns tracking information for a purchased shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
trackingId
- A carrier-generated tracking identifier originally returned by the purchaseShipment operation. (required)carrierId
- A carrier identifier originally returned by the getRates operation for the selected rate. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetTrackingResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getTrackingWithHttpInfo
public ApiResponse<GetTrackingResponse> getTrackingWithHttpInfo(java.lang.String trackingId, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Returns tracking information for a purchased shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
trackingId
- A carrier-generated tracking identifier originally returned by the purchaseShipment operation. (required)carrierId
- A carrier identifier originally returned by the getRates operation for the selected rate. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetTrackingResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getTrackingAsync
public okhttp3.Call getTrackingAsync(java.lang.String trackingId, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId, ApiCallback<GetTrackingResponse> callback) throws ApiException, LWAException
(asynchronously) Returns tracking information for a purchased shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
trackingId
- A carrier-generated tracking identifier originally returned by the purchaseShipment operation. (required)carrierId
- A carrier identifier originally returned by the getRates operation for the selected rate. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
getUnmanifestedShipments
public GetUnmanifestedShipmentsResponse getUnmanifestedShipments(GetUnmanifestedShipmentsRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetUmanifestedShipmentsRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- GetUnmanifestedShipmentsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getUnmanifestedShipmentsWithHttpInfo
public ApiResponse<GetUnmanifestedShipmentsResponse> getUnmanifestedShipmentsWithHttpInfo(GetUnmanifestedShipmentsRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetUmanifestedShipmentsRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<GetUnmanifestedShipmentsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
getUnmanifestedShipmentsAsync
public okhttp3.Call getUnmanifestedShipmentsAsync(GetUnmanifestedShipmentsRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<GetUnmanifestedShipmentsResponse> callback) throws ApiException, LWAException
(asynchronously) This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- GetUmanifestedShipmentsRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
linkCarrierAccount
public LinkCarrierAccountResponse linkCarrierAccount(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- LinkCarrierAccountRequest body (required)carrierId
- An identifier for the carrier with which the seller's account is being linked. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- LinkCarrierAccountResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
linkCarrierAccountWithHttpInfo
public ApiResponse<LinkCarrierAccountResponse> linkCarrierAccountWithHttpInfo(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- LinkCarrierAccountRequest body (required)carrierId
- An identifier for the carrier with which the seller's account is being linked. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<LinkCarrierAccountResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
linkCarrierAccountAsync
public okhttp3.Call linkCarrierAccountAsync(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId, ApiCallback<LinkCarrierAccountResponse> callback) throws ApiException, LWAException
(asynchronously) This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- LinkCarrierAccountRequest body (required)carrierId
- An identifier for the carrier with which the seller's account is being linked. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
linkCarrierAccount_0
public LinkCarrierAccountResponse linkCarrierAccount_0(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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 then 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
- LinkCarrierAccountRequest body (required)carrierId
- An identifier for the carrier with which the seller's account is being linked. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- LinkCarrierAccountResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
linkCarrierAccount_0WithHttpInfo
public ApiResponse<LinkCarrierAccountResponse> linkCarrierAccount_0WithHttpInfo(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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 then 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
- LinkCarrierAccountRequest body (required)carrierId
- An identifier for the carrier with which the seller's account is being linked. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<LinkCarrierAccountResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
linkCarrierAccount_0Async
public okhttp3.Call linkCarrierAccount_0Async(LinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId, ApiCallback<LinkCarrierAccountResponse> callback) throws ApiException, LWAException
(asynchronously) This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 10 | 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 then 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
- LinkCarrierAccountRequest body (required)carrierId
- An identifier for the carrier with which the seller's account is being linked. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
oneClickShipment
public OneClickShipmentResponse oneClickShipment(OneClickShipmentRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- OneClickShipmentRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- OneClickShipmentResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
oneClickShipmentWithHttpInfo
public ApiResponse<OneClickShipmentResponse> oneClickShipmentWithHttpInfo(OneClickShipmentRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- OneClickShipmentRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<OneClickShipmentResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
oneClickShipmentAsync
public okhttp3.Call oneClickShipmentAsync(OneClickShipmentRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<OneClickShipmentResponse> callback) throws ApiException, LWAException
(asynchronously) Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- OneClickShipmentRequest body (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
purchaseShipment
public PurchaseShipmentResponse purchaseShipment(PurchaseShipmentRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- PurchaseShipmentRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- PurchaseShipmentResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
purchaseShipmentWithHttpInfo
public ApiResponse<PurchaseShipmentResponse> purchaseShipmentWithHttpInfo(PurchaseShipmentRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- PurchaseShipmentRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<PurchaseShipmentResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
purchaseShipmentAsync
public okhttp3.Call purchaseShipmentAsync(PurchaseShipmentRequest body, java.lang.String xAmznIdempotencyKey, java.lang.String xAmznShippingBusinessId, ApiCallback<PurchaseShipmentResponse> callback) throws ApiException, LWAException
(asynchronously) Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- PurchaseShipmentRequest body (required)xAmznIdempotencyKey
- A unique value which the server uses to recognize subsequent retries of the same request. (optional)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
submitNdrFeedback
public void submitNdrFeedback(SubmitNdrFeedbackRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
- Request body for ndrFeedback operation (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
submitNdrFeedbackWithHttpInfo
public ApiResponse<java.lang.Void> submitNdrFeedbackWithHttpInfo(SubmitNdrFeedbackRequest body, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
- Request body for ndrFeedback operation (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
submitNdrFeedbackAsync
public okhttp3.Call submitNdrFeedbackAsync(SubmitNdrFeedbackRequest body, java.lang.String xAmznShippingBusinessId, ApiCallback<java.lang.Void> callback) throws ApiException, LWAException
(asynchronously) This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
- Request body for ndrFeedback operation (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
unlinkCarrierAccount
public UnlinkCarrierAccountResponse unlinkCarrierAccount(UnlinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- UnlinkCarrierAccountRequest body (required)carrierId
- carrier Id to unlink with merchant. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- UnlinkCarrierAccountResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
unlinkCarrierAccountWithHttpInfo
public ApiResponse<UnlinkCarrierAccountResponse> unlinkCarrierAccountWithHttpInfo(UnlinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId) throws ApiException, LWAException
This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- UnlinkCarrierAccountRequest body (required)carrierId
- carrier Id to unlink with merchant. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (optional)- Returns:
- ApiResponse<UnlinkCarrierAccountResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyLWAException
- If calls to fetch LWA access token fails
-
unlinkCarrierAccountAsync
public okhttp3.Call unlinkCarrierAccountAsync(UnlinkCarrierAccountRequest body, java.lang.String carrierId, java.lang.String xAmznShippingBusinessId, ApiCallback<UnlinkCarrierAccountResponse> callback) throws ApiException, LWAException
(asynchronously) This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).- Parameters:
body
- UnlinkCarrierAccountRequest body (required)carrierId
- carrier Id to unlink with merchant. (required)xAmznShippingBusinessId
- Amazon shipping business to assume for this request. The default is AmazonShipping_UK. (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 objectLWAException
- If calls to fetch LWA access token fails
-
-