POST api/VTOLOrder/v2

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrderNo	integer	None.
Split	boolean	None.
ERPEnvironmentCode	string	None.
Company	integer	None.
Warehouse	string	None.
Customer	integer	None.
FixedTradeDiscount	string	None.
OrderChannel	integer	None.
Credentials	VtOnlineCredentials	None.
PurchaseOrderNumber	string	Max length: 22
OrderReference	string	None.
RequestedShipDate	string	None.
ShiptoNumber	string	Max length: 8
ShiptoName	string	Max length: 35
ShiptoAddress1	string	Max length: 35
ShiptoAddress2	string	Max length: 35
ShiptoCity	string	Max length: 35
ShiptoState	string	None.
ShiptoZip	string	Max length: 10
ContactName	string	Max length: 35
ContactEmail	string	Max length: 50
ContactPhone	string	None.
SendEmailMessage	boolean	None.
Carrier	string	Max length: 10
ProjectNumber	string	None.
SpecialOrderType	string	Max length: 10
Comments	string	None.
EDIMerchantVendor	string	None.
EDIPayablesVendor	string	None.
EDITradingPartner	string	None.
LineItems	Collection of LineItem	None.
SpecialCharges	Collection of SpecialCharge	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderNo": 1,
  "Split": true,
  "ERPEnvironmentCode": "sample string 2",
  "Company": 3,
  "Warehouse": "sample string 4",
  "Customer": 5,
  "FixedTradeDiscount": "sample string 6",
  "OrderChannel": 7,
  "Credentials": {
    "AccountNumber": 1,
    "Password": "sample string 2"
  },
  "PurchaseOrderNumber": "sample string 8",
  "OrderReference": "sample string 9",
  "RequestedShipDate": "sample string 10",
  "ShiptoNumber": "sample string 11",
  "ShiptoName": "sample string 12",
  "ShiptoAddress1": "sample string 13",
  "ShiptoAddress2": "sample string 14",
  "ShiptoCity": "sample string 15",
  "ShiptoState": "sample string 16",
  "ShiptoZip": "sample string 17",
  "ContactName": "sample string 18",
  "ContactEmail": "sample string 19",
  "ContactPhone": "sample string 20",
  "SendEmailMessage": true,
  "Carrier": "sample string 22",
  "ProjectNumber": "sample string 23",
  "SpecialOrderType": "sample string 24",
  "Comments": "sample string 25",
  "EDIMerchantVendor": "sample string 26",
  "EDIPayablesVendor": "sample string 27",
  "EDITradingPartner": "sample string 28",
  "LineItems": [
    {
      "LineSequence": 1,
      "ItemNumber": "sample string 2",
      "SpecialDepthDecimal": "sample string 3",
      "BacksplashHeightDecimal": "sample string 4",
      "Comment": "sample string 5",
      "Quantity": 6,
      "Color": "sample string 7",
      "Grade": "sample string 8",
      "Miter": "sample string 9",
      "Backer": "sample string 10",
      "PriceOverrideFlag": true,
      "Price": "sample string 12",
      "Commercial": "sample string 13",
      "Trim": "sample string 14",
      "Tag": "sample string 15",
      "RequestDate": "2026-04-01T18:45:28.1189734-05:00",
      "CustomerInformation": {
        "YourCustomerName": "sample string 1",
        "YourCustomerAddress1": "sample string 2",
        "YourCustomerAddress2": "sample string 3",
        "YourCustomerCity": "sample string 4",
        "YourCustomerState": "sample string 5",
        "YourCustomerZip": "sample string 6",
        "YourCustomerProjectName": "sample string 7",
        "YourCustomerProjectID": "sample string 8",
        "YourCustomerPurchaseOrder": "sample string 9",
        "YourCustomerSalesOrder": "sample string 10",
        "YourCustomerRequestDate": "sample string 11",
        "YourCustomerZone": "sample string 12",
        "YourCustomerLineSequence": "sample string 13",
        "YourCustomerItemDescription": "sample string 14",
        "YourCustomerStyle": "sample string 15",
        "YourCustomerColor": "sample string 16",
        "YourCustomerBarcodeData": "sample string 17",
        "YourPOSeq": "sample string 18"
      }
    },
    {
      "LineSequence": 1,
      "ItemNumber": "sample string 2",
      "SpecialDepthDecimal": "sample string 3",
      "BacksplashHeightDecimal": "sample string 4",
      "Comment": "sample string 5",
      "Quantity": 6,
      "Color": "sample string 7",
      "Grade": "sample string 8",
      "Miter": "sample string 9",
      "Backer": "sample string 10",
      "PriceOverrideFlag": true,
      "Price": "sample string 12",
      "Commercial": "sample string 13",
      "Trim": "sample string 14",
      "Tag": "sample string 15",
      "RequestDate": "2026-04-01T18:45:28.1189734-05:00",
      "CustomerInformation": {
        "YourCustomerName": "sample string 1",
        "YourCustomerAddress1": "sample string 2",
        "YourCustomerAddress2": "sample string 3",
        "YourCustomerCity": "sample string 4",
        "YourCustomerState": "sample string 5",
        "YourCustomerZip": "sample string 6",
        "YourCustomerProjectName": "sample string 7",
        "YourCustomerProjectID": "sample string 8",
        "YourCustomerPurchaseOrder": "sample string 9",
        "YourCustomerSalesOrder": "sample string 10",
        "YourCustomerRequestDate": "sample string 11",
        "YourCustomerZone": "sample string 12",
        "YourCustomerLineSequence": "sample string 13",
        "YourCustomerItemDescription": "sample string 14",
        "YourCustomerStyle": "sample string 15",
        "YourCustomerColor": "sample string 16",
        "YourCustomerBarcodeData": "sample string 17",
        "YourPOSeq": "sample string 18"
      }
    }
  ],
  "SpecialCharges": [
    {
      "LineSequence": 1,
      "Code": "sample string 2",
      "Type": "sample string 3",
      "Amount": 4.0,
      "Notes": "sample string 5",
      "Reference": "sample string 6"
    },
    {
      "LineSequence": 1,
      "Code": "sample string 2",
      "Type": "sample string 3",
      "Amount": 4.0,
      "Notes": "sample string 5",
      "Reference": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<PurchaseOrderVTOL xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderNo>1</OrderNo>
  <Split>true</Split>
  <ERPEnvironmentCode>sample string 2</ERPEnvironmentCode>
  <Company>3</Company>
  <Warehouse>sample string 4</Warehouse>
  <Customer>5</Customer>
  <FixedTradeDiscount>sample string 6</FixedTradeDiscount>
  <OrderChannel>7</OrderChannel>
  <Credentials>
    <AccountNumber>1</AccountNumber>
    <Password>sample string 2</Password>
  </Credentials>
  <PurchaseOrderNumber>sample string 8</PurchaseOrderNumber>
  <OrderReference>sample string 9</OrderReference>
  <RequestedShipDate>sample string 10</RequestedShipDate>
  <ShiptoNumber>sample string 11</ShiptoNumber>
  <ShiptoName>sample string 12</ShiptoName>
  <ShiptoAddress1>sample string 13</ShiptoAddress1>
  <ShiptoAddress2>sample string 14</ShiptoAddress2>
  <ShiptoCity>sample string 15</ShiptoCity>
  <ShiptoState>sample string 16</ShiptoState>
  <ShiptoZip>sample string 17</ShiptoZip>
  <ContactName>sample string 18</ContactName>
  <ContactEmail>sample string 19</ContactEmail>
  <ContactPhone>sample string 20</ContactPhone>
  <SendEmailMessage>true</SendEmailMessage>
  <Carrier>sample string 22</Carrier>
  <ProjectNumber>sample string 23</ProjectNumber>
  <SpecialOrderType>sample string 24</SpecialOrderType>
  <Comments>sample string 25</Comments>
  <EDIMerchantVendor>sample string 26</EDIMerchantVendor>
  <EDIPayablesVendor>sample string 27</EDIPayablesVendor>
  <EDITradingPartner>sample string 28</EDITradingPartner>
  <LineItems>
    <LineItem>
      <LineSequence>1</LineSequence>
      <ItemNumber>sample string 2</ItemNumber>
      <SpecialDepthDecimal>sample string 3</SpecialDepthDecimal>
      <BacksplashHeightDecimal>sample string 4</BacksplashHeightDecimal>
      <Comment>sample string 5</Comment>
      <Quantity>6</Quantity>
      <Color>sample string 7</Color>
      <Grade>sample string 8</Grade>
      <Miter>sample string 9</Miter>
      <Backer>sample string 10</Backer>
      <PriceOverrideFlag>true</PriceOverrideFlag>
      <Price>sample string 12</Price>
      <Commercial>sample string 13</Commercial>
      <Trim>sample string 14</Trim>
      <Tag>sample string 15</Tag>
      <RequestDate>2026-04-01T18:45:28.1189734-05:00</RequestDate>
      <CustomerInformation>
        <YourCustomerName>sample string 1</YourCustomerName>
        <YourCustomerAddress1>sample string 2</YourCustomerAddress1>
        <YourCustomerAddress2>sample string 3</YourCustomerAddress2>
        <YourCustomerCity>sample string 4</YourCustomerCity>
        <YourCustomerState>sample string 5</YourCustomerState>
        <YourCustomerZip>sample string 6</YourCustomerZip>
        <YourCustomerProjectName>sample string 7</YourCustomerProjectName>
        <YourCustomerProjectID>sample string 8</YourCustomerProjectID>
        <YourCustomerPurchaseOrder>sample string 9</YourCustomerPurchaseOrder>
        <YourCustomerSalesOrder>sample string 10</YourCustomerSalesOrder>
        <YourCustomerRequestDate>sample string 11</YourCustomerRequestDate>
        <YourCustomerZone>sample string 12</YourCustomerZone>
        <YourCustomerLineSequence>sample string 13</YourCustomerLineSequence>
        <YourCustomerItemDescription>sample string 14</YourCustomerItemDescription>
        <YourCustomerStyle>sample string 15</YourCustomerStyle>
        <YourCustomerColor>sample string 16</YourCustomerColor>
        <YourCustomerBarcodeData>sample string 17</YourCustomerBarcodeData>
        <YourPOSeq>sample string 18</YourPOSeq>
      </CustomerInformation>
    </LineItem>
    <LineItem>
      <LineSequence>1</LineSequence>
      <ItemNumber>sample string 2</ItemNumber>
      <SpecialDepthDecimal>sample string 3</SpecialDepthDecimal>
      <BacksplashHeightDecimal>sample string 4</BacksplashHeightDecimal>
      <Comment>sample string 5</Comment>
      <Quantity>6</Quantity>
      <Color>sample string 7</Color>
      <Grade>sample string 8</Grade>
      <Miter>sample string 9</Miter>
      <Backer>sample string 10</Backer>
      <PriceOverrideFlag>true</PriceOverrideFlag>
      <Price>sample string 12</Price>
      <Commercial>sample string 13</Commercial>
      <Trim>sample string 14</Trim>
      <Tag>sample string 15</Tag>
      <RequestDate>2026-04-01T18:45:28.1189734-05:00</RequestDate>
      <CustomerInformation>
        <YourCustomerName>sample string 1</YourCustomerName>
        <YourCustomerAddress1>sample string 2</YourCustomerAddress1>
        <YourCustomerAddress2>sample string 3</YourCustomerAddress2>
        <YourCustomerCity>sample string 4</YourCustomerCity>
        <YourCustomerState>sample string 5</YourCustomerState>
        <YourCustomerZip>sample string 6</YourCustomerZip>
        <YourCustomerProjectName>sample string 7</YourCustomerProjectName>
        <YourCustomerProjectID>sample string 8</YourCustomerProjectID>
        <YourCustomerPurchaseOrder>sample string 9</YourCustomerPurchaseOrder>
        <YourCustomerSalesOrder>sample string 10</YourCustomerSalesOrder>
        <YourCustomerRequestDate>sample string 11</YourCustomerRequestDate>
        <YourCustomerZone>sample string 12</YourCustomerZone>
        <YourCustomerLineSequence>sample string 13</YourCustomerLineSequence>
        <YourCustomerItemDescription>sample string 14</YourCustomerItemDescription>
        <YourCustomerStyle>sample string 15</YourCustomerStyle>
        <YourCustomerColor>sample string 16</YourCustomerColor>
        <YourCustomerBarcodeData>sample string 17</YourCustomerBarcodeData>
        <YourPOSeq>sample string 18</YourPOSeq>
      </CustomerInformation>
    </LineItem>
  </LineItems>
  <SpecialCharges>
    <SpecialCharge>
      <LineSequence>1</LineSequence>
      <Code>sample string 2</Code>
      <Type>sample string 3</Type>
      <Amount>4</Amount>
      <Notes>sample string 5</Notes>
      <Reference>sample string 6</Reference>
    </SpecialCharge>
    <SpecialCharge>
      <LineSequence>1</LineSequence>
      <Code>sample string 2</Code>
      <Type>sample string 3</Type>
      <Amount>4</Amount>
      <Notes>sample string 5</Notes>
      <Reference>sample string 6</Reference>
    </SpecialCharge>
  </SpecialCharges>
</PurchaseOrderVTOL>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Message2

Name	Type	Additional information
Type	string	None.
Code	string	None.
Description	string	None.
Details	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Type": "sample string 1",
    "Code": "sample string 2",
    "Description": "sample string 3",
    "Details": "sample string 4"
  },
  {
    "Type": "sample string 1",
    "Code": "sample string 2",
    "Description": "sample string 3",
    "Details": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMessage2 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Message2>
    <Type>sample string 1</Type>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Details>sample string 4</Details>
  </Message2>
  <Message2>
    <Type>sample string 1</Type>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Details>sample string 4</Details>
  </Message2>
</ArrayOfMessage2>