OnTime Extension SDK Documentation
OnTime.Extensions.SDK Namespace / DataAccess Class / SaveOrder Method
A comprehensive Order object.



In This Topic
    SaveOrder Method
    In This Topic
    Creates a new Order record, or updates an existing Order record.
    Syntax
    'Declaration
     
    
    Public Function SaveOrder( _
       ByVal order As Order _
    ) As Order
    'Usage
     
    
    Dim instance As DataAccess
    Dim order As Order
    Dim value As Order
     
    value = instance.SaveOrder(order)
    public Order SaveOrder( 
       Order order
    )
    public:
    Order^ SaveOrder( 
       Order^ order
    ) 

    Parameters

    order
    A comprehensive Order object.

    Return Value

    The exact comprehensive Order object that was persisted to the database.
    Remarks
    If the unique identifier of order references an existing Order record, the referenced record will be updated instead.
    A unique TrackingNumber value must always be provided when creating a new Order.

    Statuses
    New Order records are always assigned with a status value of OrderStatusBase.Dispatched (i.e. Submitted), and cannot be modified.
    To update the status of an existing Order record, see SaveOrderStatusChange.

    Collect-On-Delivery (COD)
    Only one of CollectionCODRequired or DeliveryCODRequired field values can be set to True at any given time.
    If a COD-requirement is selected, the CODAmount value must be greater than zero.

    Recursive Updates
    If any of the following fields reference an existing record, the existing record will be updated with the field's values provided.
    Otherwise, if any non-null value is provided, a new record will be created automatically.
    Requirements

    Target Platforms: Windows 7, Windows 8, Windows 8.1, Windows 10, Windows 11, Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2012, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019, Windows Server 2022

    See Also