POST v1/Order/OrderVersionList

Return the list of OrderVersion

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
OrderID	Provide OrderID	integer	Required
VersionDropDateFrom	Provide VersionDropDateFrom	string	None.
VersionDropDateTo	Provide VersionDropDateTo	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 1,
  "VersionDropDateFrom": "sample string 2",
  "VersionDropDateTo": "sample string 3"
}

application/xml, text/xml

Sample:

<OrderVersionListRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <OrderID>1</OrderID>
  <VersionDropDateFrom>sample string 2</VersionDropDateFrom>
  <VersionDropDateTo>sample string 3</VersionDropDateTo>
</OrderVersionListRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderVersionListRequest'.

Response Information

Resource Description

Collection of OrderVersionListResponse

Name	Description	Type	Additional information
VersionID	Provide VersionID	integer	None.
OrderID	Provide OrderID	integer	None.
Suffix	Provide Suffix	integer	None.
Quantity	Provide Quantity	decimal number	None.
VersionName	Provide VersionName	string	None.
SubTotal	Provide SubTotal	decimal number	None.
TaxAmt	Provide SubTotalTaxAmt	decimal number	None.
Postage	Provide Postage	decimal number	None.
TotalDue	Provide TotalDue	decimal number	None.
MailGeographyID	Provide MailGeographyID	integer	None.
MailGeographyName	Provide MailGeographyName	string	None.
MailSortID	Provide MailSortID	integer	None.
MailSortName	Provide MailSortName	string	None.
MailClassID	Provide MailClassID	integer	None.
MailClassName	Provide MailClassName	string	None.
MailCategoryID	Provide MailCategoryID	integer	None.
MailCategoryName	Provide MailCategoryName	string	None.
PostOfficeID	Provide PostOfficeID	integer	None.
PostOfficeName	Provide PostOfficeName	string	None.
PostageAffixID	Provide PostageAffixID	integer	None.
PostageAffixName	Provide PostageAffixName	string	None.
PermitNumber	Provide PermitNumber	string	None.
PermitHolder	Provide PermitHolder	string	None.
MeterNumber	Provide MeterNumber	string	None.
PostageRequired	Provide PostageRequired	decimal number	None.
PostageDue	Provide PostageDue	string	None.
PostageStatusID	Provide PostageStatusID	integer	None.
DataProcessingOutTime	Provide DataProcessingOutTime	string	None.
Weight	Provide Weight	decimal number	None.
Thickness	Provide Thickness	decimal number	None.
Height	Provide Height	decimal number	None.
Width	Provide Width	decimal number	None.
DataProcessingStatusID	Provide DataProcessingStatusID	integer	None.
DataProcessingStatusName	Provide DataProcessingStatusName	string	None.
DataProcessingActualQuantity	Provide DataProcessingActualQuantity	integer	None.
DataProcessingActualBilled	Provide DataProcessingActualBilled	decimal number	None.
VersionDropDate	Provide VersionDropDate	string	None.
VersionDropQuantity	Provide VersionDropQuantity	integer	None.
VersionDropName	Provide VersionDropName	string	None.
VersionDropActualDate		string	None.
CanadianRecordsID	Provide CanadianRecordsID	integer	None.
CanadianRecordsName	Provide CanadianRecordsName	string	None.
ForeignRecordsID	Provide ForeignRecordsID	integer	None.
ForeignRecordsName	Provide ForeignRecordsName	string	None.
UnmailablesID	Provide UnmailablesID	integer	None.
UnmailablesName	Provide UnmailablesName	string	None.
VersionComment	Provide UnmailablesName	string	None.
DPInStartDate	Provide DPInStartDate	string	None.
DPOutDate	Provide DPOutDate	string	None.
DPInitials	Provide DataProcessingInitials	string	None.
DataCheckedDate	Provide DataCheckedDate	string	None.
GhostCode	Provide GhostCode	string	None.
NonProfitAuthCode	Provide GhostCodeNonProfitAuthCode	string	None.
MailerCode	Provide MailerCode	string	None.
CustRegCode	Provide CustRegCode	string	None.
Urgency	Provide Urgency	string	None.
VersionJobType	Provide JobType	string	None.
PostageBalance	The remaining balance of postage	string	None.
InvoiceServiceBalance	The amount of services with invoices created but not paid	string	None.
InvoicePostageBalance	The amount of postage with invoices created but not paid	string	None.
EarmarkedBalance	The amount of funds in the deposit account earmarked to the order but not used	string	None.
UDFList	Provide UDF List	StandardUDFList	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "VersionID": 1,
    "OrderID": 2,
    "Suffix": 3,
    "Quantity": 4.0,
    "VersionName": "sample string 5",
    "SubTotal": 6.0,
    "TaxAmt": 7.0,
    "Postage": 8.0,
    "TotalDue": 9.0,
    "MailGeographyID": 10,
    "MailGeographyName": "sample string 11",
    "MailSortID": 12,
    "MailSortName": "sample string 13",
    "MailClassID": 14,
    "MailClassName": "sample string 15",
    "MailCategoryID": 16,
    "MailCategoryName": "sample string 17",
    "PostOfficeID": 18,
    "PostOfficeName": "sample string 19",
    "PostageAffixID": 20,
    "PostageAffixName": "sample string 21",
    "PermitNumber": "sample string 22",
    "PermitHolder": "sample string 23",
    "MeterNumber": "sample string 24",
    "PostageRequired": 25.0,
    "PostageDue": "sample string 26",
    "PostageStatusID": 27,
    "DataProcessingOutTime": "sample string 28",
    "Weight": 29.0,
    "Thickness": 30.0,
    "Height": 31.0,
    "Width": 32.0,
    "DataProcessingStatusID": 33,
    "DataProcessingStatusName": "sample string 34",
    "DataProcessingActualQuantity": 35,
    "DataProcessingActualBilled": 36.0,
    "VersionDropDate": "sample string 37",
    "VersionDropQuantity": 38,
    "VersionDropName": "sample string 39",
    "VersionDropActualDate": "sample string 40",
    "CanadianRecordsID": 41,
    "CanadianRecordsName": "sample string 42",
    "ForeignRecordsID": 43,
    "ForeignRecordsName": "sample string 44",
    "UnmailablesID": 45,
    "UnmailablesName": "sample string 46",
    "VersionComment": "sample string 47",
    "DPInStartDate": "sample string 48",
    "DPOutDate": "sample string 49",
    "DPInitials": "sample string 50",
    "DataCheckedDate": "sample string 51",
    "GhostCode": "sample string 52",
    "NonProfitAuthCode": "sample string 53",
    "MailerCode": "sample string 54",
    "CustRegCode": "sample string 55",
    "Urgency": "sample string 56",
    "VersionJobType": "sample string 57",
    "PostageBalance": "sample string 58",
    "UDFList": {
      "UDF1": "sample string 21",
      "UDF2": "sample string 22",
      "UDF3": "sample string 23",
      "UDF4": "sample string 24",
      "UDF5": "sample string 25",
      "UDF6": "sample string 26",
      "UDF7": "sample string 27",
      "UDF8": "sample string 28",
      "UDF9": "sample string 29",
      "UDF10": "sample string 30",
      "UDF11": "sample string 1",
      "UDF12": "sample string 2",
      "UDF13": "sample string 3",
      "UDF14": "sample string 4",
      "UDF15": "sample string 5",
      "UDF16": "sample string 6",
      "UDF17": "sample string 7",
      "UDF18": "sample string 8",
      "UDF19": "sample string 9",
      "UDF20": "sample string 10",
      "UDF21": "sample string 11",
      "UDF22": "sample string 12",
      "UDF23": "sample string 13",
      "UDF24": "sample string 14",
      "UDF25": "sample string 15",
      "UDF26": "sample string 16",
      "UDF27": "sample string 17",
      "UDF28": "sample string 18",
      "UDF29": "sample string 19",
      "UDF30": "sample string 20"
    },
    "InvoiceServiceBalance": "sample string 59",
    "InvoicePostageBalance": "sample string 60",
    "EarmarkedBalance": "sample string 61"
  },
  {
    "VersionID": 1,
    "OrderID": 2,
    "Suffix": 3,
    "Quantity": 4.0,
    "VersionName": "sample string 5",
    "SubTotal": 6.0,
    "TaxAmt": 7.0,
    "Postage": 8.0,
    "TotalDue": 9.0,
    "MailGeographyID": 10,
    "MailGeographyName": "sample string 11",
    "MailSortID": 12,
    "MailSortName": "sample string 13",
    "MailClassID": 14,
    "MailClassName": "sample string 15",
    "MailCategoryID": 16,
    "MailCategoryName": "sample string 17",
    "PostOfficeID": 18,
    "PostOfficeName": "sample string 19",
    "PostageAffixID": 20,
    "PostageAffixName": "sample string 21",
    "PermitNumber": "sample string 22",
    "PermitHolder": "sample string 23",
    "MeterNumber": "sample string 24",
    "PostageRequired": 25.0,
    "PostageDue": "sample string 26",
    "PostageStatusID": 27,
    "DataProcessingOutTime": "sample string 28",
    "Weight": 29.0,
    "Thickness": 30.0,
    "Height": 31.0,
    "Width": 32.0,
    "DataProcessingStatusID": 33,
    "DataProcessingStatusName": "sample string 34",
    "DataProcessingActualQuantity": 35,
    "DataProcessingActualBilled": 36.0,
    "VersionDropDate": "sample string 37",
    "VersionDropQuantity": 38,
    "VersionDropName": "sample string 39",
    "VersionDropActualDate": "sample string 40",
    "CanadianRecordsID": 41,
    "CanadianRecordsName": "sample string 42",
    "ForeignRecordsID": 43,
    "ForeignRecordsName": "sample string 44",
    "UnmailablesID": 45,
    "UnmailablesName": "sample string 46",
    "VersionComment": "sample string 47",
    "DPInStartDate": "sample string 48",
    "DPOutDate": "sample string 49",
    "DPInitials": "sample string 50",
    "DataCheckedDate": "sample string 51",
    "GhostCode": "sample string 52",
    "NonProfitAuthCode": "sample string 53",
    "MailerCode": "sample string 54",
    "CustRegCode": "sample string 55",
    "Urgency": "sample string 56",
    "VersionJobType": "sample string 57",
    "PostageBalance": "sample string 58",
    "UDFList": {
      "UDF1": "sample string 21",
      "UDF2": "sample string 22",
      "UDF3": "sample string 23",
      "UDF4": "sample string 24",
      "UDF5": "sample string 25",
      "UDF6": "sample string 26",
      "UDF7": "sample string 27",
      "UDF8": "sample string 28",
      "UDF9": "sample string 29",
      "UDF10": "sample string 30",
      "UDF11": "sample string 1",
      "UDF12": "sample string 2",
      "UDF13": "sample string 3",
      "UDF14": "sample string 4",
      "UDF15": "sample string 5",
      "UDF16": "sample string 6",
      "UDF17": "sample string 7",
      "UDF18": "sample string 8",
      "UDF19": "sample string 9",
      "UDF20": "sample string 10",
      "UDF21": "sample string 11",
      "UDF22": "sample string 12",
      "UDF23": "sample string 13",
      "UDF24": "sample string 14",
      "UDF25": "sample string 15",
      "UDF26": "sample string 16",
      "UDF27": "sample string 17",
      "UDF28": "sample string 18",
      "UDF29": "sample string 19",
      "UDF30": "sample string 20"
    },
    "InvoiceServiceBalance": "sample string 59",
    "InvoicePostageBalance": "sample string 60",
    "EarmarkedBalance": "sample string 61"
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderVersionListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <OrderVersionListResponse>
    <VersionID>1</VersionID>
    <OrderID>2</OrderID>
    <Suffix>3</Suffix>
    <Quantity>4</Quantity>
    <VersionName>sample string 5</VersionName>
    <SubTotal>6</SubTotal>
    <TaxAmt>7</TaxAmt>
    <Postage>8</Postage>
    <TotalDue>9</TotalDue>
    <MailGeographyID>10</MailGeographyID>
    <MailGeographyName>sample string 11</MailGeographyName>
    <MailSortID>12</MailSortID>
    <MailSortName>sample string 13</MailSortName>
    <MailClassID>14</MailClassID>
    <MailClassName>sample string 15</MailClassName>
    <MailCategoryID>16</MailCategoryID>
    <MailCategoryName>sample string 17</MailCategoryName>
    <PostOfficeID>18</PostOfficeID>
    <PostOfficeName>sample string 19</PostOfficeName>
    <PostageAffixID>20</PostageAffixID>
    <PostageAffixName>sample string 21</PostageAffixName>
    <PermitNumber>sample string 22</PermitNumber>
    <PermitHolder>sample string 23</PermitHolder>
    <MeterNumber>sample string 24</MeterNumber>
    <PostageRequired>25</PostageRequired>
    <PostageDue>sample string 26</PostageDue>
    <PostageStatusID>27</PostageStatusID>
    <DataProcessingOutTime>sample string 28</DataProcessingOutTime>
    <Weight>29</Weight>
    <Thickness>30</Thickness>
    <Height>31</Height>
    <Width>32</Width>
    <DataProcessingStatusID>33</DataProcessingStatusID>
    <DataProcessingStatusName>sample string 34</DataProcessingStatusName>
    <DataProcessingActualQuantity>35</DataProcessingActualQuantity>
    <DataProcessingActualBilled>36</DataProcessingActualBilled>
    <VersionDropDate>sample string 37</VersionDropDate>
    <VersionDropQuantity>38</VersionDropQuantity>
    <VersionDropName>sample string 39</VersionDropName>
    <VersionDropActualDate>sample string 40</VersionDropActualDate>
    <CanadianRecordsID>41</CanadianRecordsID>
    <CanadianRecordsName>sample string 42</CanadianRecordsName>
    <ForeignRecordsID>43</ForeignRecordsID>
    <ForeignRecordsName>sample string 44</ForeignRecordsName>
    <UnmailablesID>45</UnmailablesID>
    <UnmailablesName>sample string 46</UnmailablesName>
    <VersionComment>sample string 47</VersionComment>
    <DPInStartDate>sample string 48</DPInStartDate>
    <DPOutDate>sample string 49</DPOutDate>
    <DPInitials>sample string 50</DPInitials>
    <DataCheckedDate>sample string 51</DataCheckedDate>
    <GhostCode>sample string 52</GhostCode>
    <NonProfitAuthCode>sample string 53</NonProfitAuthCode>
    <MailerCode>sample string 54</MailerCode>
    <CustRegCode>sample string 55</CustRegCode>
    <Urgency>sample string 56</Urgency>
    <VersionJobType>sample string 57</VersionJobType>
    <PostageBalance>sample string 58</PostageBalance>
    <InvoiceServiceBalance>sample string 59</InvoiceServiceBalance>
    <InvoicePostageBalance>sample string 60</InvoicePostageBalance>
    <EarmarkedBalance>sample string 61</EarmarkedBalance>
    <UDFList>
      <UDF1>sample string 21</UDF1>
      <UDF2>sample string 22</UDF2>
      <UDF3>sample string 23</UDF3>
      <UDF4>sample string 24</UDF4>
      <UDF5>sample string 25</UDF5>
      <UDF6>sample string 26</UDF6>
      <UDF7>sample string 27</UDF7>
      <UDF8>sample string 28</UDF8>
      <UDF9>sample string 29</UDF9>
      <UDF10>sample string 30</UDF10>
      <UDF11>sample string 1</UDF11>
      <UDF12>sample string 2</UDF12>
      <UDF13>sample string 3</UDF13>
      <UDF14>sample string 4</UDF14>
      <UDF15>sample string 5</UDF15>
      <UDF16>sample string 6</UDF16>
      <UDF17>sample string 7</UDF17>
      <UDF18>sample string 8</UDF18>
      <UDF19>sample string 9</UDF19>
      <UDF20>sample string 10</UDF20>
      <UDF21>sample string 11</UDF21>
      <UDF22>sample string 12</UDF22>
      <UDF23>sample string 13</UDF23>
      <UDF24>sample string 14</UDF24>
      <UDF25>sample string 15</UDF25>
      <UDF26>sample string 16</UDF26>
      <UDF27>sample string 17</UDF27>
      <UDF28>sample string 18</UDF28>
      <UDF29>sample string 19</UDF29>
      <UDF30>sample string 20</UDF30>
    </UDFList>
  </OrderVersionListResponse>
  <OrderVersionListResponse>
    <VersionID>1</VersionID>
    <OrderID>2</OrderID>
    <Suffix>3</Suffix>
    <Quantity>4</Quantity>
    <VersionName>sample string 5</VersionName>
    <SubTotal>6</SubTotal>
    <TaxAmt>7</TaxAmt>
    <Postage>8</Postage>
    <TotalDue>9</TotalDue>
    <MailGeographyID>10</MailGeographyID>
    <MailGeographyName>sample string 11</MailGeographyName>
    <MailSortID>12</MailSortID>
    <MailSortName>sample string 13</MailSortName>
    <MailClassID>14</MailClassID>
    <MailClassName>sample string 15</MailClassName>
    <MailCategoryID>16</MailCategoryID>
    <MailCategoryName>sample string 17</MailCategoryName>
    <PostOfficeID>18</PostOfficeID>
    <PostOfficeName>sample string 19</PostOfficeName>
    <PostageAffixID>20</PostageAffixID>
    <PostageAffixName>sample string 21</PostageAffixName>
    <PermitNumber>sample string 22</PermitNumber>
    <PermitHolder>sample string 23</PermitHolder>
    <MeterNumber>sample string 24</MeterNumber>
    <PostageRequired>25</PostageRequired>
    <PostageDue>sample string 26</PostageDue>
    <PostageStatusID>27</PostageStatusID>
    <DataProcessingOutTime>sample string 28</DataProcessingOutTime>
    <Weight>29</Weight>
    <Thickness>30</Thickness>
    <Height>31</Height>
    <Width>32</Width>
    <DataProcessingStatusID>33</DataProcessingStatusID>
    <DataProcessingStatusName>sample string 34</DataProcessingStatusName>
    <DataProcessingActualQuantity>35</DataProcessingActualQuantity>
    <DataProcessingActualBilled>36</DataProcessingActualBilled>
    <VersionDropDate>sample string 37</VersionDropDate>
    <VersionDropQuantity>38</VersionDropQuantity>
    <VersionDropName>sample string 39</VersionDropName>
    <VersionDropActualDate>sample string 40</VersionDropActualDate>
    <CanadianRecordsID>41</CanadianRecordsID>
    <CanadianRecordsName>sample string 42</CanadianRecordsName>
    <ForeignRecordsID>43</ForeignRecordsID>
    <ForeignRecordsName>sample string 44</ForeignRecordsName>
    <UnmailablesID>45</UnmailablesID>
    <UnmailablesName>sample string 46</UnmailablesName>
    <VersionComment>sample string 47</VersionComment>
    <DPInStartDate>sample string 48</DPInStartDate>
    <DPOutDate>sample string 49</DPOutDate>
    <DPInitials>sample string 50</DPInitials>
    <DataCheckedDate>sample string 51</DataCheckedDate>
    <GhostCode>sample string 52</GhostCode>
    <NonProfitAuthCode>sample string 53</NonProfitAuthCode>
    <MailerCode>sample string 54</MailerCode>
    <CustRegCode>sample string 55</CustRegCode>
    <Urgency>sample string 56</Urgency>
    <VersionJobType>sample string 57</VersionJobType>
    <PostageBalance>sample string 58</PostageBalance>
    <InvoiceServiceBalance>sample string 59</InvoiceServiceBalance>
    <InvoicePostageBalance>sample string 60</InvoicePostageBalance>
    <EarmarkedBalance>sample string 61</EarmarkedBalance>
    <UDFList>
      <UDF1>sample string 21</UDF1>
      <UDF2>sample string 22</UDF2>
      <UDF3>sample string 23</UDF3>
      <UDF4>sample string 24</UDF4>
      <UDF5>sample string 25</UDF5>
      <UDF6>sample string 26</UDF6>
      <UDF7>sample string 27</UDF7>
      <UDF8>sample string 28</UDF8>
      <UDF9>sample string 29</UDF9>
      <UDF10>sample string 30</UDF10>
      <UDF11>sample string 1</UDF11>
      <UDF12>sample string 2</UDF12>
      <UDF13>sample string 3</UDF13>
      <UDF14>sample string 4</UDF14>
      <UDF15>sample string 5</UDF15>
      <UDF16>sample string 6</UDF16>
      <UDF17>sample string 7</UDF17>
      <UDF18>sample string 8</UDF18>
      <UDF19>sample string 9</UDF19>
      <UDF20>sample string 10</UDF20>
      <UDF21>sample string 11</UDF21>
      <UDF22>sample string 12</UDF22>
      <UDF23>sample string 13</UDF23>
      <UDF24>sample string 14</UDF24>
      <UDF25>sample string 15</UDF25>
      <UDF26>sample string 16</UDF26>
      <UDF27>sample string 17</UDF27>
      <UDF28>sample string 18</UDF28>
      <UDF29>sample string 19</UDF29>
      <UDF30>sample string 20</UDF30>
    </UDFList>
  </OrderVersionListResponse>
</ArrayOfOrderVersionListResponse>

POST v1/Order/OrderVersionList

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body