POST api/PurchaseOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Credentials	VtOnlineCredentials	None.
PurchaseOrderNumber	string	Max length: 22
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.
Countertops	Collection of PurchaseOrderCountertop	None.
Accessories	Collection of PurchaseOrderAccessory	None.
CustomFabrication	Collection of CustomFabricationLine	None.

Request Formats

application/json, text/json

Sample:

{
  "Credentials": {
    "AccountNumber": 1,
    "Password": "sample string 2"
  },
  "PurchaseOrderNumber": "sample string 1",
  "RequestedShipDate": "sample string 2",
  "ShiptoNumber": "sample string 3",
  "ShiptoName": "sample string 4",
  "ShiptoAddress1": "sample string 5",
  "ShiptoAddress2": "sample string 6",
  "ShiptoCity": "sample string 7",
  "ShiptoState": "sample string 8",
  "ShiptoZip": "sample string 9",
  "ContactName": "sample string 10",
  "ContactEmail": "sample string 11",
  "ContactPhone": "sample string 12",
  "SendEmailMessage": true,
  "Carrier": "sample string 14",
  "ProjectNumber": "sample string 15",
  "SpecialOrderType": "sample string 16",
  "SimulateOrderSplits": true,
  "Comments": "sample string 18",
  "Countertops": [
    {
      "LineSequence": "sample string 1",
      "Quantity": "sample string 2",
      "Color": "sample string 3",
      "ColorDescription": "sample string 4",
      "Length": "sample string 5",
      "Style": "sample string 6",
      "Product": "sample string 7",
      "Depth": "sample string 8",
      "SpecialDepthDecimal": "sample string 9",
      "Substrate": "sample string 10",
      "Backer": "sample string 11",
      "Miter": "sample string 12",
      "Trim": "sample string 13",
      "BacksplashHeightDecimal": "sample string 14",
      "UnitPrice": 15.0,
      "Comment": "sample string 16",
      "YourItemDescription": "sample string 17",
      "YourCustomerLineInformation": {
        "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": "sample string 1",
      "Quantity": "sample string 2",
      "Color": "sample string 3",
      "ColorDescription": "sample string 4",
      "Length": "sample string 5",
      "Style": "sample string 6",
      "Product": "sample string 7",
      "Depth": "sample string 8",
      "SpecialDepthDecimal": "sample string 9",
      "Substrate": "sample string 10",
      "Backer": "sample string 11",
      "Miter": "sample string 12",
      "Trim": "sample string 13",
      "BacksplashHeightDecimal": "sample string 14",
      "UnitPrice": 15.0,
      "Comment": "sample string 16",
      "YourItemDescription": "sample string 17",
      "YourCustomerLineInformation": {
        "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"
      }
    }
  ],
  "Accessories": [
    {
      "LineSequence": "sample string 1",
      "Code": "sample string 2",
      "Quantity": "sample string 3",
      "Style": "sample string 4",
      "Substrate": "sample string 5",
      "Color": "sample string 6",
      "Comment": "sample string 7",
      "YourItemDescription": "sample string 8",
      "YourCustomerLineInformation": {
        "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": "sample string 1",
      "Code": "sample string 2",
      "Quantity": "sample string 3",
      "Style": "sample string 4",
      "Substrate": "sample string 5",
      "Color": "sample string 6",
      "Comment": "sample string 7",
      "YourItemDescription": "sample string 8",
      "YourCustomerLineInformation": {
        "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"
      }
    }
  ],
  "CustomFabrication": [
    {
      "LineSequence": "sample string 1",
      "Code": "sample string 2",
      "Quantity": "sample string 3",
      "UnitPrice": 4.0,
      "Comment": "sample string 5"
    },
    {
      "LineSequence": "sample string 1",
      "Code": "sample string 2",
      "Quantity": "sample string 3",
      "UnitPrice": 4.0,
      "Comment": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<PurchaseOrder xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Credentials>
    <AccountNumber>1</AccountNumber>
    <Password>sample string 2</Password>
  </Credentials>
  <PurchaseOrderNumber>sample string 1</PurchaseOrderNumber>
  <RequestedShipDate>sample string 2</RequestedShipDate>
  <ShiptoNumber>sample string 3</ShiptoNumber>
  <ShiptoName>sample string 4</ShiptoName>
  <ShiptoAddress1>sample string 5</ShiptoAddress1>
  <ShiptoAddress2>sample string 6</ShiptoAddress2>
  <ShiptoCity>sample string 7</ShiptoCity>
  <ShiptoState>sample string 8</ShiptoState>
  <ShiptoZip>sample string 9</ShiptoZip>
  <ContactName>sample string 10</ContactName>
  <ContactEmail>sample string 11</ContactEmail>
  <ContactPhone>sample string 12</ContactPhone>
  <SendEmailMessage>true</SendEmailMessage>
  <Carrier>sample string 14</Carrier>
  <ProjectNumber>sample string 15</ProjectNumber>
  <SpecialOrderType>sample string 16</SpecialOrderType>
  <SimulateOrderSplits>true</SimulateOrderSplits>
  <Comments>sample string 18</Comments>
  <Countertops>
    <PurchaseOrderCountertop>
      <LineSequence>sample string 1</LineSequence>
      <Quantity>sample string 2</Quantity>
      <Color>sample string 3</Color>
      <ColorDescription>sample string 4</ColorDescription>
      <Length>sample string 5</Length>
      <Style>sample string 6</Style>
      <Product>sample string 7</Product>
      <Depth>sample string 8</Depth>
      <SpecialDepthDecimal>sample string 9</SpecialDepthDecimal>
      <Substrate>sample string 10</Substrate>
      <Backer>sample string 11</Backer>
      <Miter>sample string 12</Miter>
      <Trim>sample string 13</Trim>
      <BacksplashHeightDecimal>sample string 14</BacksplashHeightDecimal>
      <UnitPrice>15</UnitPrice>
      <Comment>sample string 16</Comment>
      <YourItemDescription>sample string 17</YourItemDescription>
      <YourCustomerLineInformation>
        <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>
      </YourCustomerLineInformation>
    </PurchaseOrderCountertop>
    <PurchaseOrderCountertop>
      <LineSequence>sample string 1</LineSequence>
      <Quantity>sample string 2</Quantity>
      <Color>sample string 3</Color>
      <ColorDescription>sample string 4</ColorDescription>
      <Length>sample string 5</Length>
      <Style>sample string 6</Style>
      <Product>sample string 7</Product>
      <Depth>sample string 8</Depth>
      <SpecialDepthDecimal>sample string 9</SpecialDepthDecimal>
      <Substrate>sample string 10</Substrate>
      <Backer>sample string 11</Backer>
      <Miter>sample string 12</Miter>
      <Trim>sample string 13</Trim>
      <BacksplashHeightDecimal>sample string 14</BacksplashHeightDecimal>
      <UnitPrice>15</UnitPrice>
      <Comment>sample string 16</Comment>
      <YourItemDescription>sample string 17</YourItemDescription>
      <YourCustomerLineInformation>
        <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>
      </YourCustomerLineInformation>
    </PurchaseOrderCountertop>
  </Countertops>
  <Accessories>
    <PurchaseOrderAccessory>
      <LineSequence>sample string 1</LineSequence>
      <Code>sample string 2</Code>
      <Quantity>sample string 3</Quantity>
      <Style>sample string 4</Style>
      <Substrate>sample string 5</Substrate>
      <Color>sample string 6</Color>
      <Comment>sample string 7</Comment>
      <YourItemDescription>sample string 8</YourItemDescription>
      <YourCustomerLineInformation>
        <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>
      </YourCustomerLineInformation>
    </PurchaseOrderAccessory>
    <PurchaseOrderAccessory>
      <LineSequence>sample string 1</LineSequence>
      <Code>sample string 2</Code>
      <Quantity>sample string 3</Quantity>
      <Style>sample string 4</Style>
      <Substrate>sample string 5</Substrate>
      <Color>sample string 6</Color>
      <Comment>sample string 7</Comment>
      <YourItemDescription>sample string 8</YourItemDescription>
      <YourCustomerLineInformation>
        <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>
      </YourCustomerLineInformation>
    </PurchaseOrderAccessory>
  </Accessories>
  <CustomFabrication>
    <CustomFabricationLine>
      <LineSequence>sample string 1</LineSequence>
      <Code>sample string 2</Code>
      <Quantity>sample string 3</Quantity>
      <UnitPrice>4</UnitPrice>
      <Comment>sample string 5</Comment>
    </CustomFabricationLine>
    <CustomFabricationLine>
      <LineSequence>sample string 1</LineSequence>
      <Code>sample string 2</Code>
      <Quantity>sample string 3</Quantity>
      <UnitPrice>4</UnitPrice>
      <Comment>sample string 5</Comment>
    </CustomFabricationLine>
  </CustomFabrication>
</PurchaseOrder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.