Package software.amazon.spapi.api.fulfillment.inbound.v0

Class FbaInboundApi

  • public class FbaInboundApi
extends java.lang.Object

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FbaInboundApi.Builder  

    • Constructor Summary

      Constructors 
      Constructor Description
      FbaInboundApi​(ApiClient apiClient, java.lang.Boolean disableRateLimiting)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      GetBillOfLadingResponse getBillOfLading​(java.lang.String shipmentId)
      Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.
      okhttp3.Call getBillOfLadingAsync​(java.lang.String shipmentId, ApiCallback<GetBillOfLadingResponse> callback)
      (asynchronously) Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.
      ApiResponse<GetBillOfLadingResponse> getBillOfLadingWithHttpInfo​(java.lang.String shipmentId)
      Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.
      GetLabelsResponse getLabels​(java.lang.String shipmentId, java.lang.String pageType, java.lang.String labelType, java.lang.Integer numberOfPackages, java.util.List<java.lang.String> packageLabelsToPrint, java.lang.Integer numberOfPallets, java.lang.Integer pageSize, java.lang.Integer pageStartIndex)
      Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.
      okhttp3.Call getLabelsAsync​(java.lang.String shipmentId, java.lang.String pageType, java.lang.String labelType, java.lang.Integer numberOfPackages, java.util.List<java.lang.String> packageLabelsToPrint, java.lang.Integer numberOfPallets, java.lang.Integer pageSize, java.lang.Integer pageStartIndex, ApiCallback<GetLabelsResponse> callback)
      (asynchronously) Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.
      ApiResponse<GetLabelsResponse> getLabelsWithHttpInfo​(java.lang.String shipmentId, java.lang.String pageType, java.lang.String labelType, java.lang.Integer numberOfPackages, java.util.List<java.lang.String> packageLabelsToPrint, java.lang.Integer numberOfPallets, java.lang.Integer pageSize, java.lang.Integer pageStartIndex)
      Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.
      GetPrepInstructionsResponse getPrepInstructions​(java.lang.String shipToCountryCode, java.util.List<java.lang.String> sellerSKUList, java.util.List<java.lang.String> asINList)
      Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.
      okhttp3.Call getPrepInstructionsAsync​(java.lang.String shipToCountryCode, java.util.List<java.lang.String> sellerSKUList, java.util.List<java.lang.String> asINList, ApiCallback<GetPrepInstructionsResponse> callback)
      (asynchronously) Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.
      ApiResponse<GetPrepInstructionsResponse> getPrepInstructionsWithHttpInfo​(java.lang.String shipToCountryCode, java.util.List<java.lang.String> sellerSKUList, java.util.List<java.lang.String> asINList)
      Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.
      GetShipmentItemsResponse getShipmentItems​(java.lang.String queryType, java.lang.String marketplaceId, org.threeten.bp.OffsetDateTime lastUpdatedAfter, org.threeten.bp.OffsetDateTime lastUpdatedBefore, java.lang.String nextToken)
      Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.
      okhttp3.Call getShipmentItemsAsync​(java.lang.String queryType, java.lang.String marketplaceId, org.threeten.bp.OffsetDateTime lastUpdatedAfter, org.threeten.bp.OffsetDateTime lastUpdatedBefore, java.lang.String nextToken, ApiCallback<GetShipmentItemsResponse> callback)
      (asynchronously) Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.
      GetShipmentItemsResponse getShipmentItemsByShipmentId​(java.lang.String shipmentId, java.lang.String marketplaceId)
      Returns a list of items in a specified inbound shipment.
      okhttp3.Call getShipmentItemsByShipmentIdAsync​(java.lang.String shipmentId, java.lang.String marketplaceId, ApiCallback<GetShipmentItemsResponse> callback)
      (asynchronously) Returns a list of items in a specified inbound shipment.
      ApiResponse<GetShipmentItemsResponse> getShipmentItemsByShipmentIdWithHttpInfo​(java.lang.String shipmentId, java.lang.String marketplaceId)
      Returns a list of items in a specified inbound shipment.
      ApiResponse<GetShipmentItemsResponse> getShipmentItemsWithHttpInfo​(java.lang.String queryType, java.lang.String marketplaceId, org.threeten.bp.OffsetDateTime lastUpdatedAfter, org.threeten.bp.OffsetDateTime lastUpdatedBefore, java.lang.String nextToken)
      Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.
      GetShipmentsResponse getShipments​(java.lang.String queryType, java.lang.String marketplaceId, java.util.List<java.lang.String> shipmentStatusList, java.util.List<java.lang.String> shipmentIdList, org.threeten.bp.OffsetDateTime lastUpdatedAfter, org.threeten.bp.OffsetDateTime lastUpdatedBefore, java.lang.String nextToken)
      Returns a list of inbound shipments based on criteria that you specify.
      okhttp3.Call getShipmentsAsync​(java.lang.String queryType, java.lang.String marketplaceId, java.util.List<java.lang.String> shipmentStatusList, java.util.List<java.lang.String> shipmentIdList, org.threeten.bp.OffsetDateTime lastUpdatedAfter, org.threeten.bp.OffsetDateTime lastUpdatedBefore, java.lang.String nextToken, ApiCallback<GetShipmentsResponse> callback)
      (asynchronously) Returns a list of inbound shipments based on criteria that you specify.
      ApiResponse<GetShipmentsResponse> getShipmentsWithHttpInfo​(java.lang.String queryType, java.lang.String marketplaceId, java.util.List<java.lang.String> shipmentStatusList, java.util.List<java.lang.String> shipmentIdList, org.threeten.bp.OffsetDateTime lastUpdatedAfter, org.threeten.bp.OffsetDateTime lastUpdatedBefore, java.lang.String nextToken)
      Returns a list of inbound shipments based on criteria that you specify.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • getBillOfLadingBucket

        public final io.github.bucket4j.Bucket getBillOfLadingBucket

      • getLabelsBucket

        public final io.github.bucket4j.Bucket getLabelsBucket

      • getPrepInstructionsBucket

        public final io.github.bucket4j.Bucket getPrepInstructionsBucket

      • getShipmentItemsBucket

        public final io.github.bucket4j.Bucket getShipmentItemsBucket

      • getShipmentItemsByShipmentIdBucket

        public final io.github.bucket4j.Bucket getShipmentItemsByShipmentIdBucket

      • getShipmentsBucket

        public final io.github.bucket4j.Bucket getShipmentsBucket

    • Constructor Detail

      • FbaInboundApi

        public FbaInboundApi​(ApiClient apiClient,
                     java.lang.Boolean disableRateLimiting)

    • Method Detail

      • getBillOfLading

        public GetBillOfLadingResponse getBillOfLading​(java.lang.String shipmentId)
                                        throws ApiException,
                                               LWAException
        Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier originally returned by the createInboundShipmentPlan operation. (required)
        Returns:
        GetBillOfLadingResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getBillOfLadingWithHttpInfo

        public ApiResponse<GetBillOfLadingResponse> getBillOfLadingWithHttpInfo​(java.lang.String shipmentId)
                                                                 throws ApiException,
                                                                        LWAException
        Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier originally returned by the createInboundShipmentPlan operation. (required)
        Returns:
        ApiResponse<GetBillOfLadingResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getBillOfLadingAsync

        public okhttp3.Call getBillOfLadingAsync​(java.lang.String shipmentId,
                                         ApiCallback<GetBillOfLadingResponse> callback)
                                  throws ApiException,
                                         LWAException
        (asynchronously) Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier originally returned by the createInboundShipmentPlan operation. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • getLabels

        public GetLabelsResponse getLabels​(java.lang.String shipmentId,
                                   java.lang.String pageType,
                                   java.lang.String labelType,
                                   java.lang.Integer numberOfPackages,
                                   java.util.List<java.lang.String> packageLabelsToPrint,
                                   java.lang.Integer numberOfPallets,
                                   java.lang.Integer pageSize,
                                   java.lang.Integer pageStartIndex)
                            throws ApiException,
                                   LWAException
        Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier originally returned by the createInboundShipmentPlan operation. (required)
        pageType - The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. (required)
        labelType - The type of labels requested. (required)
        numberOfPackages - The number of packages in the shipment. (optional)
        packageLabelsToPrint - A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code. (optional)
        numberOfPallets - The number of pallets in the shipment. This returns four identical labels for each pallet. (optional)
        pageSize - The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000. (optional)
        pageStartIndex - The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. (optional)
        Returns:
        GetLabelsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getLabelsWithHttpInfo

        public ApiResponse<GetLabelsResponse> getLabelsWithHttpInfo​(java.lang.String shipmentId,
                                                            java.lang.String pageType,
                                                            java.lang.String labelType,
                                                            java.lang.Integer numberOfPackages,
                                                            java.util.List<java.lang.String> packageLabelsToPrint,
                                                            java.lang.Integer numberOfPallets,
                                                            java.lang.Integer pageSize,
                                                            java.lang.Integer pageStartIndex)
                                                     throws ApiException,
                                                            LWAException
        Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier originally returned by the createInboundShipmentPlan operation. (required)
        pageType - The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. (required)
        labelType - The type of labels requested. (required)
        numberOfPackages - The number of packages in the shipment. (optional)
        packageLabelsToPrint - A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code. (optional)
        numberOfPallets - The number of pallets in the shipment. This returns four identical labels for each pallet. (optional)
        pageSize - The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000. (optional)
        pageStartIndex - The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. (optional)
        Returns:
        ApiResponse<GetLabelsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getLabelsAsync

        public okhttp3.Call getLabelsAsync​(java.lang.String shipmentId,
                                   java.lang.String pageType,
                                   java.lang.String labelType,
                                   java.lang.Integer numberOfPackages,
                                   java.util.List<java.lang.String> packageLabelsToPrint,
                                   java.lang.Integer numberOfPallets,
                                   java.lang.Integer pageSize,
                                   java.lang.Integer pageStartIndex,
                                   ApiCallback<GetLabelsResponse> callback)
                            throws ApiException,
                                   LWAException
        (asynchronously) Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier originally returned by the createInboundShipmentPlan operation. (required)
        pageType - The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error. (required)
        labelType - The type of labels requested. (required)
        numberOfPackages - The number of packages in the shipment. (optional)
        packageLabelsToPrint - A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code. (optional)
        numberOfPallets - The number of pallets in the shipment. This returns four identical labels for each pallet. (optional)
        pageSize - The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000. (optional)
        pageStartIndex - The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. (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 object
        LWAException - If calls to fetch LWA access token fails

      • getPrepInstructions

        public GetPrepInstructionsResponse getPrepInstructions​(java.lang.String shipToCountryCode,
                                                       java.util.List<java.lang.String> sellerSKUList,
                                                       java.util.List<java.lang.String> asINList)
                                                throws ApiException,
                                                       LWAException
        Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipToCountryCode - The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. (required)
        sellerSKUList - A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. (optional)
        asINList - A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. (optional)
        Returns:
        GetPrepInstructionsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getPrepInstructionsWithHttpInfo

        public ApiResponse<GetPrepInstructionsResponse> getPrepInstructionsWithHttpInfo​(java.lang.String shipToCountryCode,
                                                                                java.util.List<java.lang.String> sellerSKUList,
                                                                                java.util.List<java.lang.String> asINList)
                                                                         throws ApiException,
                                                                                LWAException
        Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipToCountryCode - The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. (required)
        sellerSKUList - A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. (optional)
        asINList - A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. (optional)
        Returns:
        ApiResponse<GetPrepInstructionsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getPrepInstructionsAsync

        public okhttp3.Call getPrepInstructionsAsync​(java.lang.String shipToCountryCode,
                                             java.util.List<java.lang.String> sellerSKUList,
                                             java.util.List<java.lang.String> asINList,
                                             ApiCallback<GetPrepInstructionsResponse> callback)
                                      throws ApiException,
                                             LWAException
        (asynchronously) Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipToCountryCode - The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country. (required)
        sellerSKUList - A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. (optional)
        asINList - A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. (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 object
        LWAException - If calls to fetch LWA access token fails

      • getShipmentItems

        public GetShipmentItemsResponse getShipmentItems​(java.lang.String queryType,
                                                 java.lang.String marketplaceId,
                                                 org.threeten.bp.OffsetDateTime lastUpdatedAfter,
                                                 org.threeten.bp.OffsetDateTime lastUpdatedBefore,
                                                 java.lang.String nextToken)
                                          throws ApiException,
                                                 LWAException
        Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        queryType - Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. (required)
        marketplaceId - A marketplace identifier. Specifies the marketplace where the product would be stored. (required)
        lastUpdatedAfter - A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        lastUpdatedBefore - A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        nextToken - A string token returned in the response to your previous request. (optional)
        Returns:
        GetShipmentItemsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentItemsWithHttpInfo

        public ApiResponse<GetShipmentItemsResponse> getShipmentItemsWithHttpInfo​(java.lang.String queryType,
                                                                          java.lang.String marketplaceId,
                                                                          org.threeten.bp.OffsetDateTime lastUpdatedAfter,
                                                                          org.threeten.bp.OffsetDateTime lastUpdatedBefore,
                                                                          java.lang.String nextToken)
                                                                   throws ApiException,
                                                                          LWAException
        Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        queryType - Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. (required)
        marketplaceId - A marketplace identifier. Specifies the marketplace where the product would be stored. (required)
        lastUpdatedAfter - A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        lastUpdatedBefore - A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        nextToken - A string token returned in the response to your previous request. (optional)
        Returns:
        ApiResponse<GetShipmentItemsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentItemsAsync

        public okhttp3.Call getShipmentItemsAsync​(java.lang.String queryType,
                                          java.lang.String marketplaceId,
                                          org.threeten.bp.OffsetDateTime lastUpdatedAfter,
                                          org.threeten.bp.OffsetDateTime lastUpdatedBefore,
                                          java.lang.String nextToken,
                                          ApiCallback<GetShipmentItemsResponse> callback)
                                   throws ApiException,
                                          LWAException
        (asynchronously) Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        queryType - Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request. (required)
        marketplaceId - A marketplace identifier. Specifies the marketplace where the product would be stored. (required)
        lastUpdatedAfter - A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        lastUpdatedBefore - A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        nextToken - A string token returned in the response to your previous request. (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 object
        LWAException - If calls to fetch LWA access token fails

      • getShipmentItemsByShipmentId

        public GetShipmentItemsResponse getShipmentItemsByShipmentId​(java.lang.String shipmentId,
                                                             java.lang.String marketplaceId)
                                                      throws ApiException,
                                                             LWAException
        Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier used for selecting items in a specific inbound shipment. (required)
        marketplaceId - Deprecated. Do not use. (optional)
        Returns:
        GetShipmentItemsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentItemsByShipmentIdWithHttpInfo

        public ApiResponse<GetShipmentItemsResponse> getShipmentItemsByShipmentIdWithHttpInfo​(java.lang.String shipmentId,
                                                                                      java.lang.String marketplaceId)
                                                                               throws ApiException,
                                                                                      LWAException
        Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier used for selecting items in a specific inbound shipment. (required)
        marketplaceId - Deprecated. Do not use. (optional)
        Returns:
        ApiResponse<GetShipmentItemsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentItemsByShipmentIdAsync

        public okhttp3.Call getShipmentItemsByShipmentIdAsync​(java.lang.String shipmentId,
                                                      java.lang.String marketplaceId,
                                                      ApiCallback<GetShipmentItemsResponse> callback)
                                               throws ApiException,
                                                      LWAException
        (asynchronously) Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        shipmentId - A shipment identifier used for selecting items in a specific inbound shipment. (required)
        marketplaceId - Deprecated. Do not use. (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 object
        LWAException - If calls to fetch LWA access token fails

      • getShipments

        public GetShipmentsResponse getShipments​(java.lang.String queryType,
                                         java.lang.String marketplaceId,
                                         java.util.List<java.lang.String> shipmentStatusList,
                                         java.util.List<java.lang.String> shipmentIdList,
                                         org.threeten.bp.OffsetDateTime lastUpdatedAfter,
                                         org.threeten.bp.OffsetDateTime lastUpdatedBefore,
                                         java.lang.String nextToken)
                                  throws ApiException,
                                         LWAException
        Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        queryType - Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. (required)
        marketplaceId - A marketplace identifier. Specifies the marketplace where the product would be stored. (required)
        shipmentStatusList - A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. (optional)
        shipmentIdList - A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. (optional)
        lastUpdatedAfter - A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        lastUpdatedBefore - A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        nextToken - A string token returned in the response to your previous request. (optional)
        Returns:
        GetShipmentsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentsWithHttpInfo

        public ApiResponse<GetShipmentsResponse> getShipmentsWithHttpInfo​(java.lang.String queryType,
                                                                  java.lang.String marketplaceId,
                                                                  java.util.List<java.lang.String> shipmentStatusList,
                                                                  java.util.List<java.lang.String> shipmentIdList,
                                                                  org.threeten.bp.OffsetDateTime lastUpdatedAfter,
                                                                  org.threeten.bp.OffsetDateTime lastUpdatedBefore,
                                                                  java.lang.String nextToken)
                                                           throws ApiException,
                                                                  LWAException
        Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        queryType - Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. (required)
        marketplaceId - A marketplace identifier. Specifies the marketplace where the product would be stored. (required)
        shipmentStatusList - A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. (optional)
        shipmentIdList - A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. (optional)
        lastUpdatedAfter - A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        lastUpdatedBefore - A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        nextToken - A string token returned in the response to your previous request. (optional)
        Returns:
        ApiResponse<GetShipmentsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentsAsync

        public okhttp3.Call getShipmentsAsync​(java.lang.String queryType,
                                      java.lang.String marketplaceId,
                                      java.util.List<java.lang.String> shipmentStatusList,
                                      java.util.List<java.lang.String> shipmentIdList,
                                      org.threeten.bp.OffsetDateTime lastUpdatedAfter,
                                      org.threeten.bp.OffsetDateTime lastUpdatedBefore,
                                      java.lang.String nextToken,
                                      ApiCallback<GetShipmentsResponse> callback)
                               throws ApiException,
                                      LWAException
        (asynchronously) Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        queryType - Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request. (required)
        marketplaceId - A marketplace identifier. Specifies the marketplace where the product would be stored. (required)
        shipmentStatusList - A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify. (optional)
        shipmentIdList - A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned. (optional)
        lastUpdatedAfter - A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        lastUpdatedBefore - A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. (optional)
        nextToken - A string token returned in the response to your previous request. (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 object
        LWAException - If calls to fetch LWA access token fails