Package software.amazon.spapi.api.vendor.shipments.v1

Class VendorShippingApi

  • public class VendorShippingApi
extends java.lang.Object

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      GetShipmentDetailsResponse getShipmentDetails​(java.lang.Long limit, java.lang.String sortOrder, java.lang.String nextToken, org.threeten.bp.OffsetDateTime createdAfter, org.threeten.bp.OffsetDateTime createdBefore, org.threeten.bp.OffsetDateTime shipmentConfirmedBefore, org.threeten.bp.OffsetDateTime shipmentConfirmedAfter, org.threeten.bp.OffsetDateTime packageLabelCreatedBefore, org.threeten.bp.OffsetDateTime packageLabelCreatedAfter, org.threeten.bp.OffsetDateTime shippedBefore, org.threeten.bp.OffsetDateTime shippedAfter, org.threeten.bp.OffsetDateTime estimatedDeliveryBefore, org.threeten.bp.OffsetDateTime estimatedDeliveryAfter, org.threeten.bp.OffsetDateTime shipmentDeliveryBefore, org.threeten.bp.OffsetDateTime shipmentDeliveryAfter, org.threeten.bp.OffsetDateTime requestedPickUpBefore, org.threeten.bp.OffsetDateTime requestedPickUpAfter, org.threeten.bp.OffsetDateTime scheduledPickUpBefore, org.threeten.bp.OffsetDateTime scheduledPickUpAfter, java.lang.String currentShipmentStatus, java.lang.String vendorShipmentIdentifier, java.lang.String buyerReferenceNumber, java.lang.String buyerWarehouseCode, java.lang.String sellerWarehouseCode)
      GetShipmentDetails Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify.
      okhttp3.Call getShipmentDetailsAsync​(java.lang.Long limit, java.lang.String sortOrder, java.lang.String nextToken, org.threeten.bp.OffsetDateTime createdAfter, org.threeten.bp.OffsetDateTime createdBefore, org.threeten.bp.OffsetDateTime shipmentConfirmedBefore, org.threeten.bp.OffsetDateTime shipmentConfirmedAfter, org.threeten.bp.OffsetDateTime packageLabelCreatedBefore, org.threeten.bp.OffsetDateTime packageLabelCreatedAfter, org.threeten.bp.OffsetDateTime shippedBefore, org.threeten.bp.OffsetDateTime shippedAfter, org.threeten.bp.OffsetDateTime estimatedDeliveryBefore, org.threeten.bp.OffsetDateTime estimatedDeliveryAfter, org.threeten.bp.OffsetDateTime shipmentDeliveryBefore, org.threeten.bp.OffsetDateTime shipmentDeliveryAfter, org.threeten.bp.OffsetDateTime requestedPickUpBefore, org.threeten.bp.OffsetDateTime requestedPickUpAfter, org.threeten.bp.OffsetDateTime scheduledPickUpBefore, org.threeten.bp.OffsetDateTime scheduledPickUpAfter, java.lang.String currentShipmentStatus, java.lang.String vendorShipmentIdentifier, java.lang.String buyerReferenceNumber, java.lang.String buyerWarehouseCode, java.lang.String sellerWarehouseCode, ApiCallback<GetShipmentDetailsResponse> callback)
      GetShipmentDetails (asynchronously) Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify.
      ApiResponse<GetShipmentDetailsResponse> getShipmentDetailsWithHttpInfo​(java.lang.Long limit, java.lang.String sortOrder, java.lang.String nextToken, org.threeten.bp.OffsetDateTime createdAfter, org.threeten.bp.OffsetDateTime createdBefore, org.threeten.bp.OffsetDateTime shipmentConfirmedBefore, org.threeten.bp.OffsetDateTime shipmentConfirmedAfter, org.threeten.bp.OffsetDateTime packageLabelCreatedBefore, org.threeten.bp.OffsetDateTime packageLabelCreatedAfter, org.threeten.bp.OffsetDateTime shippedBefore, org.threeten.bp.OffsetDateTime shippedAfter, org.threeten.bp.OffsetDateTime estimatedDeliveryBefore, org.threeten.bp.OffsetDateTime estimatedDeliveryAfter, org.threeten.bp.OffsetDateTime shipmentDeliveryBefore, org.threeten.bp.OffsetDateTime shipmentDeliveryAfter, org.threeten.bp.OffsetDateTime requestedPickUpBefore, org.threeten.bp.OffsetDateTime requestedPickUpAfter, org.threeten.bp.OffsetDateTime scheduledPickUpBefore, org.threeten.bp.OffsetDateTime scheduledPickUpAfter, java.lang.String currentShipmentStatus, java.lang.String vendorShipmentIdentifier, java.lang.String buyerReferenceNumber, java.lang.String buyerWarehouseCode, java.lang.String sellerWarehouseCode)
      GetShipmentDetails Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify.
      GetShipmentLabels getShipmentLabels​(java.lang.Long limit, java.lang.String sortOrder, java.lang.String nextToken, org.threeten.bp.OffsetDateTime labelCreatedAfter, org.threeten.bp.OffsetDateTime labelCreatedBefore, java.lang.String buyerReferenceNumber, java.lang.String vendorShipmentIdentifier, java.lang.String sellerWarehouseCode)
      Returns small parcel shipment labels based on the filters that you specify.
      okhttp3.Call getShipmentLabelsAsync​(java.lang.Long limit, java.lang.String sortOrder, java.lang.String nextToken, org.threeten.bp.OffsetDateTime labelCreatedAfter, org.threeten.bp.OffsetDateTime labelCreatedBefore, java.lang.String buyerReferenceNumber, java.lang.String vendorShipmentIdentifier, java.lang.String sellerWarehouseCode, ApiCallback<GetShipmentLabels> callback)
      (asynchronously) Returns small parcel shipment labels based on the filters that you specify.
      ApiResponse<GetShipmentLabels> getShipmentLabelsWithHttpInfo​(java.lang.Long limit, java.lang.String sortOrder, java.lang.String nextToken, org.threeten.bp.OffsetDateTime labelCreatedAfter, org.threeten.bp.OffsetDateTime labelCreatedBefore, java.lang.String buyerReferenceNumber, java.lang.String vendorShipmentIdentifier, java.lang.String sellerWarehouseCode)
      Returns small parcel shipment labels based on the filters that you specify.
      SubmitShipmentConfirmationsResponse submitShipmentConfirmations​(SubmitShipmentConfirmationsRequest body)
      SubmitShipmentConfirmations Submits one or more shipment confirmations for vendor orders.
      okhttp3.Call submitShipmentConfirmationsAsync​(SubmitShipmentConfirmationsRequest body, ApiCallback<SubmitShipmentConfirmationsResponse> callback)
      SubmitShipmentConfirmations (asynchronously) Submits one or more shipment confirmations for vendor orders.
      ApiResponse<SubmitShipmentConfirmationsResponse> submitShipmentConfirmationsWithHttpInfo​(SubmitShipmentConfirmationsRequest body)
      SubmitShipmentConfirmations Submits one or more shipment confirmations for vendor orders.
      SubmitShipmentConfirmationsResponse submitShipments​(SubmitShipments body)
      SubmitShipments Submits one or more shipment request for vendor Orders.
      okhttp3.Call submitShipmentsAsync​(SubmitShipments body, ApiCallback<SubmitShipmentConfirmationsResponse> callback)
      SubmitShipments (asynchronously) Submits one or more shipment request for vendor Orders.
      ApiResponse<SubmitShipmentConfirmationsResponse> submitShipmentsWithHttpInfo​(SubmitShipments body)
      SubmitShipments Submits one or more shipment request for vendor Orders.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • getShipmentDetailsBucket

        public final io.github.bucket4j.Bucket getShipmentDetailsBucket

      • getShipmentLabelsBucket

        public final io.github.bucket4j.Bucket getShipmentLabelsBucket

      • submitShipmentConfirmationsBucket

        public final io.github.bucket4j.Bucket submitShipmentConfirmationsBucket

      • submitShipmentsBucket

        public final io.github.bucket4j.Bucket submitShipmentsBucket

    • Constructor Detail

      • VendorShippingApi

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

    • Method Detail

      • getShipmentDetails

        public GetShipmentDetailsResponse getShipmentDetails​(java.lang.Long limit,
                                                     java.lang.String sortOrder,
                                                     java.lang.String nextToken,
                                                     org.threeten.bp.OffsetDateTime createdAfter,
                                                     org.threeten.bp.OffsetDateTime createdBefore,
                                                     org.threeten.bp.OffsetDateTime shipmentConfirmedBefore,
                                                     org.threeten.bp.OffsetDateTime shipmentConfirmedAfter,
                                                     org.threeten.bp.OffsetDateTime packageLabelCreatedBefore,
                                                     org.threeten.bp.OffsetDateTime packageLabelCreatedAfter,
                                                     org.threeten.bp.OffsetDateTime shippedBefore,
                                                     org.threeten.bp.OffsetDateTime shippedAfter,
                                                     org.threeten.bp.OffsetDateTime estimatedDeliveryBefore,
                                                     org.threeten.bp.OffsetDateTime estimatedDeliveryAfter,
                                                     org.threeten.bp.OffsetDateTime shipmentDeliveryBefore,
                                                     org.threeten.bp.OffsetDateTime shipmentDeliveryAfter,
                                                     org.threeten.bp.OffsetDateTime requestedPickUpBefore,
                                                     org.threeten.bp.OffsetDateTime requestedPickUpAfter,
                                                     org.threeten.bp.OffsetDateTime scheduledPickUpBefore,
                                                     org.threeten.bp.OffsetDateTime scheduledPickUpAfter,
                                                     java.lang.String currentShipmentStatus,
                                                     java.lang.String vendorShipmentIdentifier,
                                                     java.lang.String buyerReferenceNumber,
                                                     java.lang.String buyerWarehouseCode,
                                                     java.lang.String sellerWarehouseCode)
                                              throws ApiException,
                                                     LWAException
        GetShipmentDetails Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        limit - The limit to the number of records returned. Default value is 50 records. (optional)
        sortOrder - Sort in ascending or descending order by purchase order creation date. (optional)
        nextToken - Used for pagination when there are more shipments than the specified result size limit. (optional)
        createdAfter - Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        createdBefore - Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentConfirmedBefore - Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentConfirmedAfter - Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        packageLabelCreatedBefore - Get Shipment Details by passing Package label create Date by buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        packageLabelCreatedAfter - Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shippedBefore - Get Shipment Details by passing Shipped Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shippedAfter - Get Shipment Details by passing Shipped Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        estimatedDeliveryBefore - Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        estimatedDeliveryAfter - Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentDeliveryBefore - Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentDeliveryAfter - Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        requestedPickUpBefore - Get Shipment Details by passing Before Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        requestedPickUpAfter - Get Shipment Details by passing After Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        scheduledPickUpBefore - Get Shipment Details by passing Before scheduled pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        scheduledPickUpAfter - Get Shipment Details by passing After Scheduled pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        currentShipmentStatus - Get Shipment Details by passing Current shipment status. (optional)
        vendorShipmentIdentifier - Get Shipment Details by passing Vendor Shipment ID (optional)
        buyerReferenceNumber - Get Shipment Details by passing buyer Reference ID (optional)
        buyerWarehouseCode - Get Shipping Details based on buyer warehouse code. This value should be same as 'shipToParty.partyId' in the Shipment. (optional)
        sellerWarehouseCode - Get Shipping Details based on vendor warehouse code. This value should be same as 'sellingParty.partyId' in the Shipment. (optional)
        Returns:
        GetShipmentDetailsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentDetailsWithHttpInfo

        public ApiResponse<GetShipmentDetailsResponse> getShipmentDetailsWithHttpInfo​(java.lang.Long limit,
                                                                              java.lang.String sortOrder,
                                                                              java.lang.String nextToken,
                                                                              org.threeten.bp.OffsetDateTime createdAfter,
                                                                              org.threeten.bp.OffsetDateTime createdBefore,
                                                                              org.threeten.bp.OffsetDateTime shipmentConfirmedBefore,
                                                                              org.threeten.bp.OffsetDateTime shipmentConfirmedAfter,
                                                                              org.threeten.bp.OffsetDateTime packageLabelCreatedBefore,
                                                                              org.threeten.bp.OffsetDateTime packageLabelCreatedAfter,
                                                                              org.threeten.bp.OffsetDateTime shippedBefore,
                                                                              org.threeten.bp.OffsetDateTime shippedAfter,
                                                                              org.threeten.bp.OffsetDateTime estimatedDeliveryBefore,
                                                                              org.threeten.bp.OffsetDateTime estimatedDeliveryAfter,
                                                                              org.threeten.bp.OffsetDateTime shipmentDeliveryBefore,
                                                                              org.threeten.bp.OffsetDateTime shipmentDeliveryAfter,
                                                                              org.threeten.bp.OffsetDateTime requestedPickUpBefore,
                                                                              org.threeten.bp.OffsetDateTime requestedPickUpAfter,
                                                                              org.threeten.bp.OffsetDateTime scheduledPickUpBefore,
                                                                              org.threeten.bp.OffsetDateTime scheduledPickUpAfter,
                                                                              java.lang.String currentShipmentStatus,
                                                                              java.lang.String vendorShipmentIdentifier,
                                                                              java.lang.String buyerReferenceNumber,
                                                                              java.lang.String buyerWarehouseCode,
                                                                              java.lang.String sellerWarehouseCode)
                                                                       throws ApiException,
                                                                              LWAException
        GetShipmentDetails Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        limit - The limit to the number of records returned. Default value is 50 records. (optional)
        sortOrder - Sort in ascending or descending order by purchase order creation date. (optional)
        nextToken - Used for pagination when there are more shipments than the specified result size limit. (optional)
        createdAfter - Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        createdBefore - Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentConfirmedBefore - Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentConfirmedAfter - Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        packageLabelCreatedBefore - Get Shipment Details by passing Package label create Date by buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        packageLabelCreatedAfter - Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shippedBefore - Get Shipment Details by passing Shipped Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shippedAfter - Get Shipment Details by passing Shipped Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        estimatedDeliveryBefore - Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        estimatedDeliveryAfter - Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentDeliveryBefore - Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentDeliveryAfter - Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        requestedPickUpBefore - Get Shipment Details by passing Before Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        requestedPickUpAfter - Get Shipment Details by passing After Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        scheduledPickUpBefore - Get Shipment Details by passing Before scheduled pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        scheduledPickUpAfter - Get Shipment Details by passing After Scheduled pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        currentShipmentStatus - Get Shipment Details by passing Current shipment status. (optional)
        vendorShipmentIdentifier - Get Shipment Details by passing Vendor Shipment ID (optional)
        buyerReferenceNumber - Get Shipment Details by passing buyer Reference ID (optional)
        buyerWarehouseCode - Get Shipping Details based on buyer warehouse code. This value should be same as 'shipToParty.partyId' in the Shipment. (optional)
        sellerWarehouseCode - Get Shipping Details based on vendor warehouse code. This value should be same as 'sellingParty.partyId' in the Shipment. (optional)
        Returns:
        ApiResponse<GetShipmentDetailsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getShipmentDetailsAsync

        public okhttp3.Call getShipmentDetailsAsync​(java.lang.Long limit,
                                            java.lang.String sortOrder,
                                            java.lang.String nextToken,
                                            org.threeten.bp.OffsetDateTime createdAfter,
                                            org.threeten.bp.OffsetDateTime createdBefore,
                                            org.threeten.bp.OffsetDateTime shipmentConfirmedBefore,
                                            org.threeten.bp.OffsetDateTime shipmentConfirmedAfter,
                                            org.threeten.bp.OffsetDateTime packageLabelCreatedBefore,
                                            org.threeten.bp.OffsetDateTime packageLabelCreatedAfter,
                                            org.threeten.bp.OffsetDateTime shippedBefore,
                                            org.threeten.bp.OffsetDateTime shippedAfter,
                                            org.threeten.bp.OffsetDateTime estimatedDeliveryBefore,
                                            org.threeten.bp.OffsetDateTime estimatedDeliveryAfter,
                                            org.threeten.bp.OffsetDateTime shipmentDeliveryBefore,
                                            org.threeten.bp.OffsetDateTime shipmentDeliveryAfter,
                                            org.threeten.bp.OffsetDateTime requestedPickUpBefore,
                                            org.threeten.bp.OffsetDateTime requestedPickUpAfter,
                                            org.threeten.bp.OffsetDateTime scheduledPickUpBefore,
                                            org.threeten.bp.OffsetDateTime scheduledPickUpAfter,
                                            java.lang.String currentShipmentStatus,
                                            java.lang.String vendorShipmentIdentifier,
                                            java.lang.String buyerReferenceNumber,
                                            java.lang.String buyerWarehouseCode,
                                            java.lang.String sellerWarehouseCode,
                                            ApiCallback<GetShipmentDetailsResponse> callback)
                                     throws ApiException,
                                            LWAException
        GetShipmentDetails (asynchronously) Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        limit - The limit to the number of records returned. Default value is 50 records. (optional)
        sortOrder - Sort in ascending or descending order by purchase order creation date. (optional)
        nextToken - Used for pagination when there are more shipments than the specified result size limit. (optional)
        createdAfter - Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        createdBefore - Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentConfirmedBefore - Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentConfirmedAfter - Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        packageLabelCreatedBefore - Get Shipment Details by passing Package label create Date by buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        packageLabelCreatedAfter - Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shippedBefore - Get Shipment Details by passing Shipped Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shippedAfter - Get Shipment Details by passing Shipped Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        estimatedDeliveryBefore - Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        estimatedDeliveryAfter - Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentDeliveryBefore - Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        shipmentDeliveryAfter - Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        requestedPickUpBefore - Get Shipment Details by passing Before Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        requestedPickUpAfter - Get Shipment Details by passing After Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        scheduledPickUpBefore - Get Shipment Details by passing Before scheduled pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        scheduledPickUpAfter - Get Shipment Details by passing After Scheduled pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format. (optional)
        currentShipmentStatus - Get Shipment Details by passing Current shipment status. (optional)
        vendorShipmentIdentifier - Get Shipment Details by passing Vendor Shipment ID (optional)
        buyerReferenceNumber - Get Shipment Details by passing buyer Reference ID (optional)
        buyerWarehouseCode - Get Shipping Details based on buyer warehouse code. This value should be same as 'shipToParty.partyId' in the Shipment. (optional)
        sellerWarehouseCode - Get Shipping Details based on vendor warehouse code. This value should be same as 'sellingParty.partyId' in the Shipment. (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

      • getShipmentLabels

        public GetShipmentLabels getShipmentLabels​(java.lang.Long limit,
                                           java.lang.String sortOrder,
                                           java.lang.String nextToken,
                                           org.threeten.bp.OffsetDateTime labelCreatedAfter,
                                           org.threeten.bp.OffsetDateTime labelCreatedBefore,
                                           java.lang.String buyerReferenceNumber,
                                           java.lang.String vendorShipmentIdentifier,
                                           java.lang.String sellerWarehouseCode)
                                    throws ApiException,
                                           LWAException
        Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        limit - The limit to the number of records returned. Default value is 50 records. (optional)
        sortOrder - Sort the list by shipment label creation date in ascending or descending order. (optional)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        labelCreatedAfter - Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. (optional)
        labelCreatedBefore - Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. (optional)
        buyerReferenceNumber - Get Shipment labels by passing buyer reference number. (optional)
        vendorShipmentIdentifier - Get Shipment labels by passing vendor shipment identifier. (optional)
        sellerWarehouseCode - Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment. (optional)
        Returns:
        GetShipmentLabels
        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

      • getShipmentLabelsWithHttpInfo

        public ApiResponse<GetShipmentLabels> getShipmentLabelsWithHttpInfo​(java.lang.Long limit,
                                                                    java.lang.String sortOrder,
                                                                    java.lang.String nextToken,
                                                                    org.threeten.bp.OffsetDateTime labelCreatedAfter,
                                                                    org.threeten.bp.OffsetDateTime labelCreatedBefore,
                                                                    java.lang.String buyerReferenceNumber,
                                                                    java.lang.String vendorShipmentIdentifier,
                                                                    java.lang.String sellerWarehouseCode)
                                                             throws ApiException,
                                                                    LWAException
        Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        limit - The limit to the number of records returned. Default value is 50 records. (optional)
        sortOrder - Sort the list by shipment label creation date in ascending or descending order. (optional)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        labelCreatedAfter - Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. (optional)
        labelCreatedBefore - Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. (optional)
        buyerReferenceNumber - Get Shipment labels by passing buyer reference number. (optional)
        vendorShipmentIdentifier - Get Shipment labels by passing vendor shipment identifier. (optional)
        sellerWarehouseCode - Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment. (optional)
        Returns:
        ApiResponse<GetShipmentLabels>
        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

      • getShipmentLabelsAsync

        public okhttp3.Call getShipmentLabelsAsync​(java.lang.Long limit,
                                           java.lang.String sortOrder,
                                           java.lang.String nextToken,
                                           org.threeten.bp.OffsetDateTime labelCreatedAfter,
                                           org.threeten.bp.OffsetDateTime labelCreatedBefore,
                                           java.lang.String buyerReferenceNumber,
                                           java.lang.String vendorShipmentIdentifier,
                                           java.lang.String sellerWarehouseCode,
                                           ApiCallback<GetShipmentLabels> callback)
                                    throws ApiException,
                                           LWAException
        (asynchronously) Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        limit - The limit to the number of records returned. Default value is 50 records. (optional)
        sortOrder - Sort the list by shipment label creation date in ascending or descending order. (optional)
        nextToken - A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. (optional)
        labelCreatedAfter - Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. (optional)
        labelCreatedBefore - Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format. (optional)
        buyerReferenceNumber - Get Shipment labels by passing buyer reference number. (optional)
        vendorShipmentIdentifier - Get Shipment labels by passing vendor shipment identifier. (optional)
        sellerWarehouseCode - Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment. (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

      • submitShipmentConfirmations

        public SubmitShipmentConfirmationsResponse submitShipmentConfirmations​(SubmitShipmentConfirmationsRequest body)
                                                                throws ApiException,
                                                                       LWAException
        SubmitShipmentConfirmations Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        body - A request to submit shipment confirmation. (required)
        Returns:
        SubmitShipmentConfirmationsResponse
        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

      • submitShipmentConfirmationsWithHttpInfo

        public ApiResponse<SubmitShipmentConfirmationsResponse> submitShipmentConfirmationsWithHttpInfo​(SubmitShipmentConfirmationsRequest body)
                                                                                         throws ApiException,
                                                                                                LWAException
        SubmitShipmentConfirmations Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        body - A request to submit shipment confirmation. (required)
        Returns:
        ApiResponse<SubmitShipmentConfirmationsResponse>
        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

      • submitShipmentConfirmationsAsync

        public okhttp3.Call submitShipmentConfirmationsAsync​(SubmitShipmentConfirmationsRequest body,
                                                     ApiCallback<SubmitShipmentConfirmationsResponse> callback)
                                              throws ApiException,
                                                     LWAException
        SubmitShipmentConfirmations (asynchronously) Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        body - A request to submit shipment confirmation. (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

      • submitShipments

        public SubmitShipmentConfirmationsResponse submitShipments​(SubmitShipments body)
                                                    throws ApiException,
                                                           LWAException
        SubmitShipments Submits one or more shipment request for vendor Orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        body - A request to submit shipment request. (required)
        Returns:
        SubmitShipmentConfirmationsResponse
        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

      • submitShipmentsWithHttpInfo

        public ApiResponse<SubmitShipmentConfirmationsResponse> submitShipmentsWithHttpInfo​(SubmitShipments body)
                                                                             throws ApiException,
                                                                                    LWAException
        SubmitShipments Submits one or more shipment request for vendor Orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        body - A request to submit shipment request. (required)
        Returns:
        ApiResponse<SubmitShipmentConfirmationsResponse>
        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

      • submitShipmentsAsync

        public okhttp3.Call submitShipmentsAsync​(SubmitShipments body,
                                         ApiCallback<SubmitShipmentConfirmationsResponse> callback)
                                  throws ApiException,
                                         LWAException
        SubmitShipments (asynchronously) Submits one or more shipment request for vendor Orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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 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:
        body - A request to submit shipment request. (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