Skip to content

OrderSummary

Source code in docs_src/capo_outposts/types/order_summary.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class OrderSummary(TypedDict, closed=True):
    outpost_id: NotRequired["capo_outposts.types.outpost_id_only.OutpostIdOnly"]
    """<p> The ID of the Outpost. </p>"""
    order_id: NotRequired["capo_outposts.types.order_id.OrderId"]
    """<p> The ID of the order. </p>"""
    order_type: NotRequired["capo_outposts.types.order_type.OrderType"]
    """<p>The type of order.</p>"""
    status: NotRequired["capo_outposts.types.order_status.OrderStatus"]
    """<p>The status of the order.</p> <ul> <li> <p> <code>PREPARING</code> - Order is received and is being prepared.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Order is either being built, shipped, or installed. For more information, see the <code>LineItem</code> status.</p> </li> <li> <p> <code>COMPLETED</code> - Order is complete.</p> </li> <li> <p> <code>CANCELLED</code> - Order is cancelled.</p> </li> <li> <p> <code>ERROR</code> - Customer should contact support.</p> </li> </ul> <note> <p>The following statuses are deprecated: <code>RECEIVED</code>, <code>PENDING</code>, <code>PROCESSING</code>, <code>INSTALLING</code>, and <code>FULFILLED</code>. </p> </note>"""
    line_item_counts_by_status: NotRequired[
        "capo_outposts.types.line_item_status_counts.LineItemStatusCounts"
    ]
    """<p> The status of all line items in the order. </p>"""
    order_submission_date: NotRequired[
        "capo_outposts.types.iso8601_timestamp.ISO8601Timestamp"
    ]
    """<p> The submission date for the order. </p>"""
    order_fulfilled_date: NotRequired[
        "capo_outposts.types.iso8601_timestamp.ISO8601Timestamp"
    ]
    """<p> The fulfilment date for the order. </p>"""

line_item_counts_by_status instance-attribute 

line_item_counts_by_status: NotRequired[LineItemStatusCounts]

The status of all line items in the order.

order_fulfilled_date instance-attribute 

order_fulfilled_date: NotRequired[ISO8601Timestamp]

The fulfilment date for the order.

order_id instance-attribute 

order_id: NotRequired[OrderId]

The ID of the order.

order_submission_date instance-attribute 

order_submission_date: NotRequired[ISO8601Timestamp]

The submission date for the order.

order_type instance-attribute 

order_type: NotRequired[OrderType]

The type of order.

outpost_id instance-attribute 

outpost_id: NotRequired[OutpostIdOnly]

The ID of the Outpost.

status instance-attribute 

status: NotRequired[OrderStatus]

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 the LineItem 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.