Skip to content

Order

Source code in docs_src/capo_outposts/types/order.py
class Order(TypedDict, closed=True):
    outpost_id: NotRequired["capo_outposts.types.outpost_id_only.OutpostIdOnly"]
    """<p> The ID of the Outpost in the order. </p>"""
    quote_identifier: NotRequired[
        "capo_outposts.types.quote_identifier.QuoteIdentifier"
    ]
    """<p>The ID of the quote associated with the order.</p>"""
    quote_option_identifier: NotRequired[
        "capo_outposts.types.quote_option_identifier.QuoteOptionIdentifier"
    ]
    """<p>The ID of the quote option associated with the order.</p>"""
    order_id: NotRequired["capo_outposts.types.order_id.OrderId"]
    """<p>The ID of the 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 being prepared.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Order is either being built or shipped. To get more details, see the line item status.</p> </li> <li> <p> <code>DELIVERED</code> - Order was delivered to the Outpost site.</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 status are deprecated: <code>RECEIVED</code>, <code>PENDING</code>, <code>PROCESSING</code>, <code>INSTALLING</code>, and <code>FULFILLED</code>. </p> </note>"""
    line_items: NotRequired[
        "capo_outposts.types.line_item_list_definition.LineItemListDefinition"
    ]
    """<p>The line items for the order</p>"""
    payment_option: NotRequired["capo_outposts.types.payment_option.PaymentOption"]
    """<p>The payment option for 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 fulfillment date of the order.</p>"""
    payment_term: NotRequired["capo_outposts.types.payment_term.PaymentTerm"]
    """<p>The payment term.</p>"""
    order_type: NotRequired["capo_outposts.types.order_type.OrderType"]
    """<p>The type of order.</p>"""

line_items instance-attribute

line_items: NotRequired[LineItemListDefinition]

The line items for the order

order_fulfilled_date instance-attribute

order_fulfilled_date: NotRequired[ISO8601Timestamp]

The fulfillment date of 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 in the order.

payment_option instance-attribute

payment_option: NotRequired[PaymentOption]

The payment option for the order.

payment_term instance-attribute

payment_term: NotRequired[PaymentTerm]

The payment term.

quote_identifier instance-attribute

quote_identifier: NotRequired[QuoteIdentifier]

The ID of the quote associated with the order.

quote_option_identifier instance-attribute

quote_option_identifier: NotRequired[QuoteOptionIdentifier]

The ID of the quote option associated with the order.

status instance-attribute

status: NotRequired[OrderStatus]

The status of the order.

  • PREPARING - Order is received and being prepared.

  • IN_PROGRESS - Order is either being built or shipped. To get more details, see the line item status.

  • DELIVERED - Order was delivered to the Outpost site.

  • COMPLETED - Order is complete.

  • CANCELLED - Order is cancelled.

  • ERROR - Customer should contact support.

The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.