Package software.amazon.spapi.models.orders.v0

Class Order

  • public class Order
extends java.lang.Object
    Order information.

    • Constructor Detail

      • Order

        public Order()

    • Method Detail

      • amazonOrderId

        public Order amazonOrderId​(java.lang.String amazonOrderId)

      • getAmazonOrderId

        public java.lang.String getAmazonOrderId()
        An Amazon-defined order identifier, in 3-7-7 format.
        Returns:
        amazonOrderId

      • setAmazonOrderId

        public void setAmazonOrderId​(java.lang.String amazonOrderId)

      • sellerOrderId

        public Order sellerOrderId​(java.lang.String sellerOrderId)

      • getSellerOrderId

        public java.lang.String getSellerOrderId()
        A seller-defined order identifier.
        Returns:
        sellerOrderId

      • setSellerOrderId

        public void setSellerOrderId​(java.lang.String sellerOrderId)

      • purchaseDate

        public Order purchaseDate​(java.lang.String purchaseDate)

      • getPurchaseDate

        public java.lang.String getPurchaseDate()
        The date when the order was created.
        Returns:
        purchaseDate

      • setPurchaseDate

        public void setPurchaseDate​(java.lang.String purchaseDate)

      • lastUpdateDate

        public Order lastUpdateDate​(java.lang.String lastUpdateDate)

      • getLastUpdateDate

        public java.lang.String getLastUpdateDate()
        The date when the order was last updated. __Note__: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01.
        Returns:
        lastUpdateDate

      • setLastUpdateDate

        public void setLastUpdateDate​(java.lang.String lastUpdateDate)

      • getOrderStatus

        public Order.OrderStatusEnum getOrderStatus()
        The current order status.
        Returns:
        orderStatus

      • getFulfillmentChannel

        public Order.FulfillmentChannelEnum getFulfillmentChannel()
        Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`).
        Returns:
        fulfillmentChannel

      • salesChannel

        public Order salesChannel​(java.lang.String salesChannel)

      • getSalesChannel

        public java.lang.String getSalesChannel()
        The sales channel for the first item in the order.
        Returns:
        salesChannel

      • setSalesChannel

        public void setSalesChannel​(java.lang.String salesChannel)

      • orderChannel

        public Order orderChannel​(java.lang.String orderChannel)

      • getOrderChannel

        public java.lang.String getOrderChannel()
        The order channel for the first item in the order.
        Returns:
        orderChannel

      • setOrderChannel

        public void setOrderChannel​(java.lang.String orderChannel)

      • shipServiceLevel

        public Order shipServiceLevel​(java.lang.String shipServiceLevel)

      • getShipServiceLevel

        public java.lang.String getShipServiceLevel()
        The order's shipment service level.
        Returns:
        shipServiceLevel

      • setShipServiceLevel

        public void setShipServiceLevel​(java.lang.String shipServiceLevel)

      • orderTotal

        public Order orderTotal​(Money orderTotal)

      • getOrderTotal

        public Money getOrderTotal()
        Get orderTotal
        Returns:
        orderTotal

      • setOrderTotal

        public void setOrderTotal​(Money orderTotal)

      • numberOfItemsShipped

        public Order numberOfItemsShipped​(java.lang.Integer numberOfItemsShipped)

      • getNumberOfItemsShipped

        public java.lang.Integer getNumberOfItemsShipped()
        The number of items shipped.
        Returns:
        numberOfItemsShipped

      • setNumberOfItemsShipped

        public void setNumberOfItemsShipped​(java.lang.Integer numberOfItemsShipped)

      • numberOfItemsUnshipped

        public Order numberOfItemsUnshipped​(java.lang.Integer numberOfItemsUnshipped)

      • getNumberOfItemsUnshipped

        public java.lang.Integer getNumberOfItemsUnshipped()
        The number of items unshipped.
        Returns:
        numberOfItemsUnshipped

      • setNumberOfItemsUnshipped

        public void setNumberOfItemsUnshipped​(java.lang.Integer numberOfItemsUnshipped)

      • getPaymentExecutionDetail

        public PaymentExecutionDetailItemList getPaymentExecutionDetail()
        Get paymentExecutionDetail
        Returns:
        paymentExecutionDetail

      • getPaymentMethod

        public Order.PaymentMethodEnum getPaymentMethod()
        The payment method for the order. This property is limited to COD and CVS payment methods. Unless you need the specific COD payment information provided by the `PaymentExecutionDetailItem` object, we recommend using the `PaymentMethodDetails` property to get payment method information.
        Returns:
        paymentMethod

      • getPaymentMethodDetails

        public PaymentMethodDetailItemList getPaymentMethodDetails()
        Get paymentMethodDetails
        Returns:
        paymentMethodDetails

      • marketplaceId

        public Order marketplaceId​(java.lang.String marketplaceId)

      • getMarketplaceId

        public java.lang.String getMarketplaceId()
        The identifier for the marketplace where the order was placed.
        Returns:
        marketplaceId

      • setMarketplaceId

        public void setMarketplaceId​(java.lang.String marketplaceId)

      • shipmentServiceLevelCategory

        public Order shipmentServiceLevelCategory​(java.lang.String shipmentServiceLevelCategory)

      • getShipmentServiceLevelCategory

        public java.lang.String getShipmentServiceLevelCategory()
        The shipment service level category for the order. **Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`.
        Returns:
        shipmentServiceLevelCategory

      • setShipmentServiceLevelCategory

        public void setShipmentServiceLevelCategory​(java.lang.String shipmentServiceLevelCategory)

      • getEasyShipShipmentStatus

        public EasyShipShipmentStatus getEasyShipShipmentStatus()
        Get easyShipShipmentStatus
        Returns:
        easyShipShipmentStatus

      • setEasyShipShipmentStatus

        public void setEasyShipShipmentStatus​(EasyShipShipmentStatus easyShipShipmentStatus)

      • cbaDisplayableShippingLabel

        public Order cbaDisplayableShippingLabel​(java.lang.String cbaDisplayableShippingLabel)

      • getCbaDisplayableShippingLabel

        public java.lang.String getCbaDisplayableShippingLabel()
        Custom ship label for Checkout by Amazon (CBA).
        Returns:
        cbaDisplayableShippingLabel

      • setCbaDisplayableShippingLabel

        public void setCbaDisplayableShippingLabel​(java.lang.String cbaDisplayableShippingLabel)

      • getOrderType

        public Order.OrderTypeEnum getOrderType()
        The order's type.
        Returns:
        orderType

      • earliestShipDate

        public Order earliestShipDate​(java.lang.String earliestShipDate)

      • getEarliestShipDate

        public java.lang.String getEarliestShipDate()
        The start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. __Note__: `EarliestShipDate` might not be returned for orders placed before February 1, 2013.
        Returns:
        earliestShipDate

      • setEarliestShipDate

        public void setEarliestShipDate​(java.lang.String earliestShipDate)

      • latestShipDate

        public Order latestShipDate​(java.lang.String latestShipDate)

      • getLatestShipDate

        public java.lang.String getLatestShipDate()
        The end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. __Note__: `LatestShipDate` might not be returned for orders placed before February 1, 2013.
        Returns:
        latestShipDate

      • setLatestShipDate

        public void setLatestShipDate​(java.lang.String latestShipDate)

      • earliestDeliveryDate

        public Order earliestDeliveryDate​(java.lang.String earliestDeliveryDate)

      • getEarliestDeliveryDate

        public java.lang.String getEarliestDeliveryDate()
        The start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.
        Returns:
        earliestDeliveryDate

      • setEarliestDeliveryDate

        public void setEarliestDeliveryDate​(java.lang.String earliestDeliveryDate)

      • latestDeliveryDate

        public Order latestDeliveryDate​(java.lang.String latestDeliveryDate)

      • getLatestDeliveryDate

        public java.lang.String getLatestDeliveryDate()
        The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pending`, or `Canceled` status.
        Returns:
        latestDeliveryDate

      • setLatestDeliveryDate

        public void setLatestDeliveryDate​(java.lang.String latestDeliveryDate)

      • isBusinessOrder

        public Order isBusinessOrder​(java.lang.Boolean isBusinessOrder)

      • isIsBusinessOrder

        public java.lang.Boolean isIsBusinessOrder()
        When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer.
        Returns:
        isBusinessOrder

      • setIsBusinessOrder

        public void setIsBusinessOrder​(java.lang.Boolean isBusinessOrder)

      • isPrime

        public Order isPrime​(java.lang.Boolean isPrime)

      • isIsPrime

        public java.lang.Boolean isIsPrime()
        When true, the order is a seller-fulfilled Amazon Prime order.
        Returns:
        isPrime

      • setIsPrime

        public void setIsPrime​(java.lang.Boolean isPrime)

      • isPremiumOrder

        public Order isPremiumOrder​(java.lang.Boolean isPremiumOrder)

      • isIsPremiumOrder

        public java.lang.Boolean isIsPremiumOrder()
        When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to \"Premium Shipping Options\" in the Seller Central Help for your marketplace.
        Returns:
        isPremiumOrder

      • setIsPremiumOrder

        public void setIsPremiumOrder​(java.lang.Boolean isPremiumOrder)

      • isGlobalExpressEnabled

        public Order isGlobalExpressEnabled​(java.lang.Boolean isGlobalExpressEnabled)

      • isIsGlobalExpressEnabled

        public java.lang.Boolean isIsGlobalExpressEnabled()
        When true, the order is a `GlobalExpress` order.
        Returns:
        isGlobalExpressEnabled

      • setIsGlobalExpressEnabled

        public void setIsGlobalExpressEnabled​(java.lang.Boolean isGlobalExpressEnabled)

      • replacedOrderId

        public Order replacedOrderId​(java.lang.String replacedOrderId)

      • getReplacedOrderId

        public java.lang.String getReplacedOrderId()
        The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true.
        Returns:
        replacedOrderId

      • setReplacedOrderId

        public void setReplacedOrderId​(java.lang.String replacedOrderId)

      • isReplacementOrder

        public Order isReplacementOrder​(java.lang.Boolean isReplacementOrder)

      • isIsReplacementOrder

        public java.lang.Boolean isIsReplacementOrder()
        When true, this is a replacement order.
        Returns:
        isReplacementOrder

      • setIsReplacementOrder

        public void setIsReplacementOrder​(java.lang.Boolean isReplacementOrder)

      • promiseResponseDueDate

        public Order promiseResponseDueDate​(java.lang.String promiseResponseDueDate)

      • getPromiseResponseDueDate

        public java.lang.String getPromiseResponseDueDate()
        Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders.
        Returns:
        promiseResponseDueDate

      • setPromiseResponseDueDate

        public void setPromiseResponseDueDate​(java.lang.String promiseResponseDueDate)

      • isEstimatedShipDateSet

        public Order isEstimatedShipDateSet​(java.lang.Boolean isEstimatedShipDateSet)

      • isIsEstimatedShipDateSet

        public java.lang.Boolean isIsEstimatedShipDateSet()
        When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders.
        Returns:
        isEstimatedShipDateSet

      • setIsEstimatedShipDateSet

        public void setIsEstimatedShipDateSet​(java.lang.Boolean isEstimatedShipDateSet)

      • isSoldByAB

        public Order isSoldByAB​(java.lang.Boolean isSoldByAB)

      • isIsSoldByAB

        public java.lang.Boolean isIsSoldByAB()
        When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller.
        Returns:
        isSoldByAB

      • setIsSoldByAB

        public void setIsSoldByAB​(java.lang.Boolean isSoldByAB)

      • isIBA

        public Order isIBA​(java.lang.Boolean isIBA)

      • isIsIBA

        public java.lang.Boolean isIsIBA()
        When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller.
        Returns:
        isIBA

      • setIsIBA

        public void setIsIBA​(java.lang.Boolean isIBA)

      • defaultShipFromLocationAddress

        public Order defaultShipFromLocationAddress​(Address defaultShipFromLocationAddress)

      • getDefaultShipFromLocationAddress

        public Address getDefaultShipFromLocationAddress()
        Get defaultShipFromLocationAddress
        Returns:
        defaultShipFromLocationAddress

      • setDefaultShipFromLocationAddress

        public void setDefaultShipFromLocationAddress​(Address defaultShipFromLocationAddress)

      • getBuyerInvoicePreference

        public Order.BuyerInvoicePreferenceEnum getBuyerInvoicePreference()
        The buyer's invoicing preference. Sellers can use this data to issue electronic invoices for orders in Turkey. **Note**: This attribute is only available in the Turkey marketplace.
        Returns:
        buyerInvoicePreference

      • getBuyerTaxInformation

        public BuyerTaxInformation getBuyerTaxInformation()
        Get buyerTaxInformation
        Returns:
        buyerTaxInformation

      • setBuyerTaxInformation

        public void setBuyerTaxInformation​(BuyerTaxInformation buyerTaxInformation)

      • getFulfillmentInstruction

        public FulfillmentInstruction getFulfillmentInstruction()
        Get fulfillmentInstruction
        Returns:
        fulfillmentInstruction

      • setFulfillmentInstruction

        public void setFulfillmentInstruction​(FulfillmentInstruction fulfillmentInstruction)

      • isISPU

        public Order isISPU​(java.lang.Boolean isISPU)

      • isIsISPU

        public java.lang.Boolean isIsISPU()
        When true, this order is marked to be picked up from a store rather than delivered.
        Returns:
        isISPU

      • setIsISPU

        public void setIsISPU​(java.lang.Boolean isISPU)

      • isAccessPointOrder

        public Order isAccessPointOrder​(java.lang.Boolean isAccessPointOrder)

      • isIsAccessPointOrder

        public java.lang.Boolean isIsAccessPointOrder()
        When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers.
        Returns:
        isAccessPointOrder

      • setIsAccessPointOrder

        public void setIsAccessPointOrder​(java.lang.Boolean isAccessPointOrder)

      • getMarketplaceTaxInfo

        public MarketplaceTaxInfo getMarketplaceTaxInfo()
        Get marketplaceTaxInfo
        Returns:
        marketplaceTaxInfo

      • setMarketplaceTaxInfo

        public void setMarketplaceTaxInfo​(MarketplaceTaxInfo marketplaceTaxInfo)

      • sellerDisplayName

        public Order sellerDisplayName​(java.lang.String sellerDisplayName)

      • getSellerDisplayName

        public java.lang.String getSellerDisplayName()
        The seller’s friendly name registered in the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil. **Note**: This attribute is only available in the Brazil marketplace for the orders with `Pending` or `Unshipped` status.
        Returns:
        sellerDisplayName

      • setSellerDisplayName

        public void setSellerDisplayName​(java.lang.String sellerDisplayName)

      • shippingAddress

        public Order shippingAddress​(Address shippingAddress)

      • getShippingAddress

        public Address getShippingAddress()
        Get shippingAddress
        Returns:
        shippingAddress

      • setShippingAddress

        public void setShippingAddress​(Address shippingAddress)

      • getBuyerInfo

        public BuyerInfo getBuyerInfo()
        Get buyerInfo
        Returns:
        buyerInfo

      • setBuyerInfo

        public void setBuyerInfo​(BuyerInfo buyerInfo)

      • getAutomatedShippingSettings

        public AutomatedShippingSettings getAutomatedShippingSettings()
        Get automatedShippingSettings
        Returns:
        automatedShippingSettings

      • setAutomatedShippingSettings

        public void setAutomatedShippingSettings​(AutomatedShippingSettings automatedShippingSettings)

      • hasRegulatedItems

        public Order hasRegulatedItems​(java.lang.Boolean hasRegulatedItems)

      • isHasRegulatedItems

        public java.lang.Boolean isHasRegulatedItems()
        Whether the order contains regulated items which may require additional approval steps before being fulfilled.
        Returns:
        hasRegulatedItems

      • setHasRegulatedItems

        public void setHasRegulatedItems​(java.lang.Boolean hasRegulatedItems)

      • getElectronicInvoiceStatus

        public ElectronicInvoiceStatus getElectronicInvoiceStatus()
        Get electronicInvoiceStatus
        Returns:
        electronicInvoiceStatus

      • setElectronicInvoiceStatus

        public void setElectronicInvoiceStatus​(ElectronicInvoiceStatus electronicInvoiceStatus)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object