POST v1/Order/OrderVersionPostageDetailUpdate

Updates order version postage detail information

This is secure method and requires below attributes in header

Authorization: Authorize Token

Request Information

URI Parameters

None.

Body Parameters

OrderVersionPostageDetail
NameDescriptionTypeAdditional information
OrderVersionPostageDetailID

Provide the OrderVersionPostageDetailID

integer

None.

OrderVersionPostageID

Provide the OrderVersionPostageID

integer

None.

RateDescription

Provide the RateDescription

string

None.

Quantity

Provide the Quantity

integer

None.

Rate

Provide the Rate

decimal number

None.

DetailTotalWeight

Provide the DetailTotalWeight

decimal number

None.

DetailTotalPostage

Provide the DetailTotalPostage

decimal number

None.

DetailDate

Provide the DetailDate

string

None.

RateCode

Provide the RateCode

string

None.

WtType

Provide the WtType

string

None.

Precanceled

Provide the Precanceled

string

None.

Sign

Provide the Sign

string

None.

PostageAccountID

Provide the PostageAccountID

integer

None.

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.

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

Sample:
{
  "OrderVersionPostageDetailID": 1,
  "OrderVersionPostageID": 2,
  "RateDescription": "sample string 3",
  "Quantity": 4,
  "Rate": 5.0,
  "DetailTotalWeight": 6.0,
  "DetailTotalPostage": 7.0,
  "DetailDate": "sample string 8",
  "RateCode": "sample string 9",
  "WtType": "sample string 10",
  "Precanceled": "sample string 11",
  "Sign": "sample string 12",
  "PostageAccountID": 13,
  "VersionID": 1,
  "PostageAffixID": 1,
  "PostageAffixName": "sample string 14",
  "PostageQuantity": 1,
  "PostageRate": 1.0,
  "PostageMarkupType": "sample string 15",
  "PostageMarkupValue": 1.0,
  "PostageSellRate": 1.0,
  "PostageTotal": 1.0,
  "DateUsed": "sample string 16",
  "MailClassID": 1,
  "TotalWeight": 1.0,
  "FormNo": "sample string 18",
  "LOT": "sample string 19",
  "PermitNo": "sample string 20",
  "NonProfit": "sample string 21",
  "PostOffice": "sample string 22",
  "POCity": "sample string 23",
  "POZIP": "sample string 24",
  "WTStatus": "sample string 25",
  "ProcessingCategory": "sample string 26",
  "FTtr1": 1,
  "FTtr2": 1,
  "Sacks": 1,
  "Pallets": 1,
  "FlatTr": 1,
  "Other": 1,
  "TareWt": 1.0,
  "IfExistIDDateAppendDetailUpdateHeader": true
}

application/xml, text/xml

Sample:
<OrderVersionPostageDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderVersionPostageID>1</OrderVersionPostageID>
  <VersionID>1</VersionID>
  <PostageAffixID>1</PostageAffixID>
  <PostageAffixName>sample string 14</PostageAffixName>
  <PostageQuantity>1</PostageQuantity>
  <PostageRate>1</PostageRate>
  <PostageMarkupType>sample string 15</PostageMarkupType>
  <PostageMarkupValue>1</PostageMarkupValue>
  <PostageSellRate>1</PostageSellRate>
  <PostageTotal>1</PostageTotal>
  <DateUsed>sample string 16</DateUsed>
  <MailClassID>1</MailClassID>
  <TotalWeight>1</TotalWeight>
  <FormNo>sample string 18</FormNo>
  <LOT>sample string 19</LOT>
  <PermitNo>sample string 20</PermitNo>
  <NonProfit>sample string 21</NonProfit>
  <PostOffice>sample string 22</PostOffice>
  <POCity>sample string 23</POCity>
  <POZIP>sample string 24</POZIP>
  <WTStatus>sample string 25</WTStatus>
  <ProcessingCategory>sample string 26</ProcessingCategory>
  <FTtr1>1</FTtr1>
  <FTtr2>1</FTtr2>
  <Sacks>1</Sacks>
  <Pallets>1</Pallets>
  <FlatTr>1</FlatTr>
  <Other>1</Other>
  <TareWt>1</TareWt>
  <Precanceled i:nil="true" />
  <PostageAccountID>0</PostageAccountID>
  <IfExistIDDateAppendDetailUpdateHeader>true</IfExistIDDateAppendDetailUpdateHeader>
  <DetailDate>sample string 8</DetailDate>
  <DetailTotalPostage>7</DetailTotalPostage>
  <DetailTotalWeight>6</DetailTotalWeight>
  <OrderVersionPostageDetailID>1</OrderVersionPostageDetailID>
  <OrderVersionPostageID>2</OrderVersionPostageID>
  <PostageAccountID>13</PostageAccountID>
  <Precanceled>sample string 11</Precanceled>
  <Quantity>4</Quantity>
  <Rate>5</Rate>
  <RateCode>sample string 9</RateCode>
  <RateDescription>sample string 3</RateDescription>
  <Sign>sample string 12</Sign>
  <WtType>sample string 10</WtType>
</OrderVersionPostageDetail>

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 'OrderVersionPostageDetail'.

Response Information

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>