POST v1/Order/OrderVersionPostageUpdate
Updates order version postage information
This is secure method and requires below attributes in header
Request Information
URI Parameters
None.
Body Parameters
OrderVersionPostageName | Description | Type | Additional information |
---|---|---|---|
OrderVersionPostageID |
Ignored for OrderVersionPostageInsert. Required for OrderVersionPostageUpdate. |
integer |
None. |
VersionID |
Required for OrderVersionPostageInsert. Must match Midnight VersionID. |
integer |
None. |
PostageAffixID |
Provide the PostageAffixID |
integer |
None. |
PostageAffixName |
Must match PostageAffix Name in Midnight. |
string |
None. |
PostageQuantity |
Provide the PostageQuantity |
integer |
None. |
PostageRate |
Provide the PostageRate |
decimal number |
None. |
PostageMarkupType |
Provide the PostageMarkupType |
string |
None. |
PostageMarkupValue |
Provide the PostageMarkupValue |
decimal number |
None. |
PostageSellRate |
Provide the PostageSellRate |
decimal number |
None. |
PostageTotal |
must be a valid decimal value and the product of PostageQuantity and PostageRate. |
decimal number |
None. |
DateUsed |
Provide the DateUsed |
string |
None. |
MailClassID |
must match MailClass in Midnight. |
integer |
None. |
TotalWeight |
Provide the TotalWeight |
decimal number |
None. |
FormNo |
Provide the FormNo |
string |
None. |
LOT |
Provide the LOT |
string |
None. |
PermitNo |
Provide the PermitNo |
string |
None. |
NonProfit |
Provide the NonProfit |
string |
None. |
PostOffice |
Provide the PostOffice |
string |
None. |
POCity |
Provide the POCity |
string |
None. |
POZIP |
Provide the POZIP |
string |
None. |
WTStatus |
Provide the WTStatus |
string |
None. |
ProcessingCategory |
Provide the ProcessingCategory |
string |
None. |
FTtr1 |
Provide the FTtr1 |
integer |
None. |
FTtr2 |
Provide the FTtr2 |
integer |
None. |
Sacks |
Provide the Sacks |
integer |
None. |
Pallets |
Provide the Pallets |
integer |
None. |
FlatTr |
Provide the FlatTr |
integer |
None. |
Other |
Provide the Other |
integer |
None. |
TareWt |
Provide the TareWt |
decimal number |
None. |
Precanceled |
Provide the Precanceled |
string |
None. |
IfExistIDDateAppendDetailUpdateHeader |
Optional, custom parameter. Only relevant for OrderVersionPostageInsert. If a value of true is provided for this parameter, and the combination of values of VersionID, PostageAffixID, DateUsed parameters match an existing OrderVersionPostage record; an OrderVersionPostageDetail record is added to the matched OrderVersionPostage record which itself is updated accordingly. If a value of false or no value is provided for this parameter, or the combination of values of VersionID, PostageAffixID, DateUsed parameters do not match an existing OrderVersionPostage record; a new OrderVersionPostage record is added. |
boolean |
None. |
Request Formats
application/json, text/json
{ "OrderVersionPostageID": 1, "VersionID": 1, "PostageAffixID": 1, "PostageAffixName": "sample string 1", "PostageQuantity": 1, "PostageRate": 1.0, "PostageMarkupType": "sample string 2", "PostageMarkupValue": 1.0, "PostageSellRate": 1.0, "PostageTotal": 1.0, "DateUsed": "sample string 3", "MailClassID": 1, "TotalWeight": 1.0, "FormNo": "sample string 5", "LOT": "sample string 6", "PermitNo": "sample string 7", "NonProfit": "sample string 8", "PostOffice": "sample string 9", "POCity": "sample string 10", "POZIP": "sample string 11", "WTStatus": "sample string 12", "ProcessingCategory": "sample string 13", "FTtr1": 1, "FTtr2": 1, "Sacks": 1, "Pallets": 1, "FlatTr": 1, "Other": 1, "TareWt": 1.0, "Precanceled": "sample string 14", "IfExistIDDateAppendDetailUpdateHeader": true }
application/x-www-form-urlencoded
Response Information
Response Formats
application/json, text/json
"sample string 1"
application/xml, text/xml
<string>sample string 1</string>