OnTime SOAP API
OnTime SOAP API / SOAP Methods Resource Group / /sites/{company-id}/ws/soap_v1.svc/CreateOrder (Method)
In This Topic
    Method/sites/{company-id}/ws/soap_v1.svc/CreateOrder
    In This Topic
    Description
    Creates a new Order record.
    Request (Isoap_v1_CreateOrder_InputMessage)

    The request body is of type CreateOrder.

    Request Body Parameters

    NameDescriptionData Type
    order Order

    Overview

    CreateOrder
    Sequence
    order optional Order Complex Type
    Sequence
    BasePrice optional xs:decimal
    BasePriceType optional OrderBase.BasePriceTypes Simple Type
    CODAmount optional xs:decimal
    CollectionArrivalDate optional xs:dateTime
    CollectionCODRequired optional xs:boolean
    CollectionContactName optional xs:string
    CollectionSignatureRequired optional xs:boolean
    Comments optional xs:string
    DateSubmitted optional xs:dateTime
    DeclaredValue optional xs:decimal
    DeliveryArrivalDate optional xs:dateTime
    DeliveryCODRequired optional xs:boolean
    DeliveryContactName optional xs:string
    DeliverySignatureRequired optional xs:boolean
    Description optional xs:string
    Distance optional xs:decimal
    Height optional xs:decimal
    ID optional guid Simple Type
    IncomingTrackingNumber optional xs:string
    Length optional xs:decimal
    OutgoingTrackingNumber optional xs:string
    PriceAdjustment optional xs:decimal
    PriceModifierTotalCost optional xs:decimal
    PurchaseOrderNumber optional xs:string
    Quantity optional xs:int
    ReferenceNumber optional xs:string
    RequestedBy optional xs:string
    RouteName optional xs:string
    StatusLevel optional StatusBase.OrderStatusBase Simple Type
    SubmissionSource optional xs:string
    TotalCost optional xs:decimal
    TrackingNumber optional xs:string
    Weight optional xs:decimal
    Width optional xs:decimal
    CollectionArrivalWindow optional TimeWindow Complex Type
    Sequence
    EarliestTime optional xs:dateTime
    LatestTime optional xs:dateTime
    Length optional duration Simple Type
    CollectionAssignedDriver optional guid Simple Type
    CollectionLocation optional Location Complex Type
    Sequence
    AddressLine1 optional xs:string
    AddressLine2 optional xs:string
    Category optional xs:string
    City optional xs:string
    Comments optional xs:string
    CompanyName optional xs:string
    ContactName optional xs:string
    Country optional xs:string
    Email optional xs:string
    ID optional guid Simple Type
    LatitudeLongitude optional xs:string
    Phone optional xs:string
    PostalCode optional xs:string
    State optional xs:string
    Zone optional Zone Complex Type
    Sequence
    ID optional guid Simple Type
    Name optional xs:string
    PostalCodes optional xs:string
    Customer optional guid Simple Type
    CustomerContact optional Contact Complex Type
    Sequence
    CustomerID optional guid Simple Type
    Email optional xs:string
    ID optional guid Simple Type
    Name optional xs:string
    Phone optional xs:string
    DeliveryArrivalWindow optional TimeWindow Complex Type
    Sequence
    EarliestTime optional xs:dateTime
    LatestTime optional xs:dateTime
    Length optional duration Simple Type
    DeliveryAssignedDriver optional guid Simple Type
    DeliveryLocation optional Location Complex Type
    Sequence
    AddressLine1 optional xs:string
    AddressLine2 optional xs:string
    Category optional xs:string
    City optional xs:string
    Comments optional xs:string
    CompanyName optional xs:string
    ContactName optional xs:string
    Country optional xs:string
    Email optional xs:string
    ID optional guid Simple Type
    LatitudeLongitude optional xs:string
    Phone optional xs:string
    PostalCode optional xs:string
    State optional xs:string
    Zone optional Zone Complex Type
    Sequence
    ID optional guid Simple Type
    Name optional xs:string
    PostalCodes optional xs:string
    Department optional Department Complex Type
    Sequence
    CustomerID optional guid Simple Type
    ID optional guid Simple Type
    Name optional xs:string
    Dispatcher optional guid Simple Type
    DriverCurrentlyAssigned optional guid Simple Type
    Items optional ArrayOfItem Complex Type
    Sequence
    Item 0..∞ Item Complex Type
    Sequence
    Comments optional xs:string
    Description optional xs:string
    Height optional xs:decimal
    ID optional guid Simple Type
    Length optional xs:decimal
    OrderID optional guid Simple Type
    TrackingNumber optional xs:string
    Weight optional xs:decimal
    Width optional xs:decimal
    PriceModifiers optional ArrayOfPriceModifier Complex Type
    Sequence
    PriceModifier 0..∞ PriceModifier Complex Type
    Sequence
    CustomValue optional xs:decimal
    ID optional guid Simple Type
    Input optional PriceModifierBase.InputFieldType Simple Type
    Name optional xs:string
    PercentCommissionable optional xs:decimal
    Price optional xs:decimal
    Type optional PriceModifierBase.PriceModifierType Simple Type
    PriceSet optional guid Simple Type
    Status optional Status Complex Type
    Sequence
    Description optional xs:string
    ID optional guid Simple Type
    Level optional StatusBase.OrderStatusBase Simple Type
    Name optional xs:string
    Timestamp optional xs:dateTime
    Subtotal optional xs:decimal
    TaxTotal optional xs:decimal
    UserDefinedFields optional ArrayOfKeyValueOfstringUserDefinedFieldtmAZPOme Complex Type
    Sequence
    KeyValueOfstringUserDefinedFieldtmAZPOme 0..∞
    Sequence
    Key xs:string
    Value UserDefinedField Complex Type
    Sequence
    Label optional xs:string
    OrderID optional guid Simple Type
    ValueAsBoolean optional xs:boolean
    ValueAsDate optional xs:dateTime
    ValueAsDecimal optional xs:decimal
    ValueAsString optional xs:string
    UserMiscCompensations optional ArrayOfUserMiscCompensation Complex Type
    VehicleRequired optional VehicleType Complex Type
    Sequence
    ID optional guid Simple Type
    Name optional xs:string
    200 Response (Isoap_v1_CreateOrder_OutputMessage)

    The response body is of type CreateOrderResponse.

    Response Body Parameters

    NameDescriptionData Type
    CreateOrderResult Order

    Overview

    CreateOrderResponse
    Sequence
    CreateOrderResult optional Order Complex Type
    Sequence
    BasePrice optional xs:decimal
    BasePriceType optional OrderBase.BasePriceTypes Simple Type
    CODAmount optional xs:decimal
    CollectionArrivalDate optional xs:dateTime
    CollectionCODRequired optional xs:boolean
    CollectionContactName optional xs:string
    CollectionSignatureRequired optional xs:boolean
    Comments optional xs:string
    DateSubmitted optional xs:dateTime
    DeclaredValue optional xs:decimal
    DeliveryArrivalDate optional xs:dateTime
    DeliveryCODRequired optional xs:boolean
    DeliveryContactName optional xs:string
    DeliverySignatureRequired optional xs:boolean
    Description optional xs:string
    Distance optional xs:decimal
    Height optional xs:decimal
    ID optional guid Simple Type
    IncomingTrackingNumber optional xs:string
    Length optional xs:decimal
    OutgoingTrackingNumber optional xs:string
    PriceAdjustment optional xs:decimal
    PriceModifierTotalCost optional xs:decimal
    PurchaseOrderNumber optional xs:string
    Quantity optional xs:int
    ReferenceNumber optional xs:string
    RequestedBy optional xs:string
    RouteName optional xs:string
    StatusLevel optional StatusBase.OrderStatusBase Simple Type
    SubmissionSource optional xs:string
    TotalCost optional xs:decimal
    TrackingNumber optional xs:string
    Weight optional xs:decimal
    Width optional xs:decimal
    CollectionArrivalWindow optional TimeWindow Complex Type
    Sequence
    EarliestTime optional xs:dateTime
    LatestTime optional xs:dateTime
    Length optional duration Simple Type
    CollectionAssignedDriver optional guid Simple Type
    CollectionLocation optional Location Complex Type
    Sequence
    AddressLine1 optional xs:string
    AddressLine2 optional xs:string
    Category optional xs:string
    City optional xs:string
    Comments optional xs:string
    CompanyName optional xs:string
    ContactName optional xs:string
    Country optional xs:string
    Email optional xs:string
    ID optional guid Simple Type
    LatitudeLongitude optional xs:string
    Phone optional xs:string
    PostalCode optional xs:string
    State optional xs:string
    Zone optional Zone Complex Type
    Sequence
    ID optional guid Simple Type
    Name optional xs:string
    PostalCodes optional xs:string
    Customer optional guid Simple Type
    CustomerContact optional Contact Complex Type
    Sequence
    CustomerID optional guid Simple Type
    Email optional xs:string
    ID optional guid Simple Type
    Name optional xs:string
    Phone optional xs:string
    DeliveryArrivalWindow optional TimeWindow Complex Type
    Sequence
    EarliestTime optional xs:dateTime
    LatestTime optional xs:dateTime
    Length optional duration Simple Type
    DeliveryAssignedDriver optional guid Simple Type
    DeliveryLocation optional Location Complex Type
    Sequence
    AddressLine1 optional xs:string
    AddressLine2 optional xs:string
    Category optional xs:string
    City optional xs:string
    Comments optional xs:string
    CompanyName optional xs:string
    ContactName optional xs:string
    Country optional xs:string
    Email optional xs:string
    ID optional guid Simple Type
    LatitudeLongitude optional xs:string
    Phone optional xs:string
    PostalCode optional xs:string
    State optional xs:string
    Zone optional Zone Complex Type
    Sequence
    ID optional guid Simple Type
    Name optional xs:string
    PostalCodes optional xs:string
    Department optional Department Complex Type
    Sequence
    CustomerID optional guid Simple Type
    ID optional guid Simple Type
    Name optional xs:string
    Dispatcher optional guid Simple Type
    DriverCurrentlyAssigned optional guid Simple Type
    Items optional ArrayOfItem Complex Type
    Sequence
    Item 0..∞ Item Complex Type
    Sequence
    Comments optional xs:string
    Description optional xs:string
    Height optional xs:decimal
    ID optional guid Simple Type
    Length optional xs:decimal
    OrderID optional guid Simple Type
    TrackingNumber optional xs:string
    Weight optional xs:decimal
    Width optional xs:decimal
    PriceModifiers optional ArrayOfPriceModifier Complex Type
    Sequence
    PriceModifier 0..∞ PriceModifier Complex Type
    Sequence
    CustomValue optional xs:decimal
    ID optional guid Simple Type
    Input optional PriceModifierBase.InputFieldType Simple Type
    Name optional xs:string
    PercentCommissionable optional xs:decimal
    Price optional xs:decimal
    Type optional PriceModifierBase.PriceModifierType Simple Type
    PriceSet optional guid Simple Type
    Status optional Status Complex Type
    Sequence
    Description optional xs:string
    ID optional guid Simple Type
    Level optional StatusBase.OrderStatusBase Simple Type
    Name optional xs:string
    Timestamp optional xs:dateTime
    Subtotal optional xs:decimal
    TaxTotal optional xs:decimal
    UserDefinedFields optional ArrayOfKeyValueOfstringUserDefinedFieldtmAZPOme Complex Type
    Sequence
    KeyValueOfstringUserDefinedFieldtmAZPOme 0..∞
    Sequence
    Key xs:string
    Value UserDefinedField Complex Type
    Sequence
    Label optional xs:string
    OrderID optional guid Simple Type
    ValueAsBoolean optional xs:boolean
    ValueAsDate optional xs:dateTime
    ValueAsDecimal optional xs:decimal
    ValueAsString optional xs:string
    UserMiscCompensations optional ArrayOfUserMiscCompensation Complex Type
    VehicleRequired optional VehicleType Complex Type
    Sequence
    ID optional guid Simple Type
    Name optional xs:string
    See Also
    SOAP Methods Resource Group | OnTime SOAP API

     

     

    © 2022 Vesigo Studios. All Rights Reserved.

    Send comments on this topic.