POST v1/Order/OrderVersionUpdate
Request Information
URI Parameters
None.
Body Parameters
OrderVersionUpdateRequestName | Description | Type | Additional information |
---|---|---|---|
VersionID | integer |
Required |
|
Quantity | decimal number |
None. |
|
DPInStartDate | string |
None. |
|
DPOutDate | string |
None. |
|
DPOutTime | string |
None. |
|
PostOffice | integer |
None. |
|
Weight | decimal number |
None. |
|
Thickness | decimal number |
None. |
|
Height | decimal number |
None. |
|
Width | decimal number |
None. |
|
CanadianRecords | integer |
None. |
|
ForeignRecords | integer |
None. |
|
Unmailables | integer |
None. |
|
ActualBilled | decimal number |
None. |
|
DataCheckedDate | string |
None. |
|
DPActualQuantity | integer |
None. |
|
PostageRequired | decimal number |
None. |
|
PostageDue | string |
None. |
|
MailSort | integer |
None. |
|
MailClass | integer |
None. |
|
PostageAffix | integer |
None. |
|
MailGeography | integer |
None. |
|
MailCategory | integer |
None. |
|
PostageStatus | integer |
None. |
|
OrderVersionStatus | integer |
None. |
|
VersionJobType | integer |
None. |
|
PermitNumber | string |
None. |
|
PermitHolder | string |
None. |
|
MeterNumber | string |
None. |
|
PODrop | integer |
None. |
|
DPInitials | string |
None. |
|
GhostCode | string |
None. |
|
NonProfitAuthCode | string |
None. |
|
MailerCode | string |
None. |
|
CustRegCode | string |
None. |
|
Comment | string |
None. |
|
VersionName | string |
None. |
|
UrgencyID | integer |
None. |
|
UDFList | StandardUDFList |
None. |
Request Formats
application/json, text/json
Sample:
{ "VersionID": 1, "Quantity": 1.0, "DPInStartDate": "sample string 2", "DPOutDate": "sample string 3", "DPOutTime": "sample string 4", "PostOffice": 1, "Weight": 1.0, "Thickness": 1.0, "Height": 1.0, "Width": 1.0, "CanadianRecords": 1, "ForeignRecords": 1, "Unmailables": 1, "ActualBilled": 1.0, "DataCheckedDate": "sample string 5", "DPActualQuantity": 1, "PostageRequired": 1.0, "PostageDue": "sample string 6", "MailSort": 1, "MailClass": 1, "PostageAffix": 1, "MailGeography": 1, "MailCategory": 1, "PostageStatus": 1, "OrderVersionStatus": 1, "VersionJobType": 1, "PermitNumber": "sample string 7", "PermitHolder": "sample string 8", "MeterNumber": "sample string 9", "PODrop": 1, "DPInitials": "sample string 10", "GhostCode": "sample string 11", "NonProfitAuthCode": "sample string 12", "MailerCode": "sample string 13", "CustRegCode": "sample string 14", "Comment": "sample string 15", "VersionName": "sample string 16", "UrgencyID": 17, "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" } }
application/xml, text/xml
Sample:
<OrderVersionUpdateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <VersionID>1</VersionID> <Quantity>1</Quantity> <DPInStartDate>sample string 2</DPInStartDate> <DPOutDate>sample string 3</DPOutDate> <DPOutTime>sample string 4</DPOutTime> <PostOffice>1</PostOffice> <Weight>1</Weight> <Thickness>1</Thickness> <Height>1</Height> <Width>1</Width> <CanadianRecords>1</CanadianRecords> <ForeignRecords>1</ForeignRecords> <Unmailables>1</Unmailables> <ActualBilled>1</ActualBilled> <DataCheckedDate>sample string 5</DataCheckedDate> <DPActualQuantity>1</DPActualQuantity> <PostageRequired>1</PostageRequired> <PostageDue>sample string 6</PostageDue> <MailSort>1</MailSort> <MailClass>1</MailClass> <PostageAffix>1</PostageAffix> <MailGeography>1</MailGeography> <MailCategory>1</MailCategory> <PostageStatus>1</PostageStatus> <OrderVersionStatus>1</OrderVersionStatus> <VersionJobType>1</VersionJobType> <PermitNumber>sample string 7</PermitNumber> <PermitHolder>sample string 8</PermitHolder> <MeterNumber>sample string 9</MeterNumber> <PODrop>1</PODrop> <DPInitials>sample string 10</DPInitials> <GhostCode>sample string 11</GhostCode> <NonProfitAuthCode>sample string 12</NonProfitAuthCode> <MailerCode>sample string 13</MailerCode> <CustRegCode>sample string 14</CustRegCode> <Comment>sample string 15</Comment> <VersionName>sample string 16</VersionName> <UrgencyID>17</UrgencyID> <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> </OrderVersionUpdateRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string>sample string 1</string>