Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data OrderSummary = OrderSummary' {}
- newOrderSummary :: OrderSummary
- orderSummary_lineItemCountsByStatus :: Lens' OrderSummary (Maybe (HashMap LineItemStatus Natural))
- orderSummary_orderFulfilledDate :: Lens' OrderSummary (Maybe UTCTime)
- orderSummary_orderId :: Lens' OrderSummary (Maybe Text)
- orderSummary_orderSubmissionDate :: Lens' OrderSummary (Maybe UTCTime)
- orderSummary_orderType :: Lens' OrderSummary (Maybe OrderType)
- orderSummary_outpostId :: Lens' OrderSummary (Maybe Text)
- orderSummary_status :: Lens' OrderSummary (Maybe OrderStatus)
Documentation
data OrderSummary Source #
A summary of line items in your order.
See: newOrderSummary
smart constructor.
OrderSummary' | |
|
Instances
newOrderSummary :: OrderSummary Source #
Create a value of OrderSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lineItemCountsByStatus:OrderSummary'
, orderSummary_lineItemCountsByStatus
- The status of all line items in the order.
$sel:orderFulfilledDate:OrderSummary'
, orderSummary_orderFulfilledDate
- The fulfilment date for the order.
$sel:orderId:OrderSummary'
, orderSummary_orderId
- The ID of the order.
$sel:orderSubmissionDate:OrderSummary'
, orderSummary_orderSubmissionDate
- The submission date for the order.
$sel:orderType:OrderSummary'
, orderSummary_orderType
- The type of order.
$sel:outpostId:OrderSummary'
, orderSummary_outpostId
- The ID of the Outpost.
$sel:status:OrderSummary'
, orderSummary_status
- The status of the order.
PREPARING
- Order is received and is being prepared.IN_PROGRESS
- Order is either being built, shipped, or installed. For more information, see theLineItem
status.COMPLETED
- Order is complete.CANCELLED
- Order is cancelled.ERROR
- Customer should contact support.
The following statuses are deprecated: RECEIVED
, PENDING
,
PROCESSING
, INSTALLING
, and FULFILLED
.
orderSummary_lineItemCountsByStatus :: Lens' OrderSummary (Maybe (HashMap LineItemStatus Natural)) Source #
The status of all line items in the order.
orderSummary_orderFulfilledDate :: Lens' OrderSummary (Maybe UTCTime) Source #
The fulfilment date for the order.
orderSummary_orderId :: Lens' OrderSummary (Maybe Text) Source #
The ID of the order.
orderSummary_orderSubmissionDate :: Lens' OrderSummary (Maybe UTCTime) Source #
The submission date for the order.
orderSummary_orderType :: Lens' OrderSummary (Maybe OrderType) Source #
The type of order.
orderSummary_outpostId :: Lens' OrderSummary (Maybe Text) Source #
The ID of the Outpost.
orderSummary_status :: Lens' OrderSummary (Maybe OrderStatus) Source #
The status of the order.
PREPARING
- Order is received and is being prepared.IN_PROGRESS
- Order is either being built, shipped, or installed. For more information, see theLineItem
status.COMPLETED
- Order is complete.CANCELLED
- Order is cancelled.ERROR
- Customer should contact support.
The following statuses are deprecated: RECEIVED
, PENDING
,
PROCESSING
, INSTALLING
, and FULFILLED
.