Typescript SDK Type Docs
    Preparing search index...

    Interface OrderFromCartDraft

    interface OrderFromCartDraft {
        cart?: CartResourceIdentifier;
        custom?: CustomFieldsDraft;
        id?: string;
        orderNumber?: string;
        orderState?: OrderState;
        paymentState?: PaymentState;
        purchaseOrderNumber?: string;
        shipmentState?: ShipmentState;
        state?: StateResourceIdentifier;
        version: number;
    }
    Index

    Properties

    cart? custom? id? orderNumber? orderState? paymentState? purchaseOrderNumber? shipmentState? state? version

    Properties

    cart?: CartResourceIdentifier

    ResourceIdentifier to the Cart from which the Order is created.

    This field is required, but is marked as optional for backwards compatibility reasons.
    custom?: CustomFieldsDraft

    Custom Fields for the Order. The Custom Fields' type must match the Custom Fields' type in the referenced Cart.

    - If empty, the Custom Fields on the referenced [Cart](ctp:api:type:Cart) are added to the Order automatically.
- If specified, the Custom Fields are merged with the Custom Fields on the referenced [Cart](ctp:api:type:Cart) and added to the Order.
    id?: string

    id of the Cart used to create the Order.

    orderNumber?: string

    User-defined identifier for the Order that is unique across a Project. Once set, the value cannot be changed.

    orderState?: OrderState

    Current status for the Order.

    paymentState?: PaymentState

    Payment status for the Order.

    purchaseOrderNumber?: string

    User-defined identifier for a purchase order.

    It is typically set by the [Buyer](ctp:api:type:Buyer) or Merchant to track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).

If not provided, the `purchaseOrderNumber` from the referenced [Cart](ctp:api:type:Cart) is used.
    shipmentState?: ShipmentState

    Shipment status for the Order.

    state?: StateResourceIdentifier

    State for the Order in a custom workflow.

    version: number

    version of the Cart from which the Order is created.

    Settings

    Member Visibility

    On This Page

    Properties