POST api/Ship/Edit/Update
Use this method to updated an editable order
Request Information
URI Parameters
None.
Body Parameters
EditOrderParmName | Description | Type | Additional information |
---|---|---|---|
auth | string |
None. |
|
ShipmentGUID | string |
None. |
|
Reference | string |
None. |
|
Contents | string |
None. |
|
Pieces | integer |
None. |
|
Weight | decimal number |
None. |
|
WeightUOM | string |
None. |
|
Length | integer |
None. |
|
Width | integer |
None. |
|
Height | integer |
None. |
|
SizeUOM | string |
None. |
|
ShipmentReferenceID1 | integer |
None. |
|
ShipmentReferenceID2 | integer |
None. |
|
ShipmentReferenceID3 | integer |
None. |
|
ShipmentReferenceID4 | integer |
None. |
|
ShipmentReferenceID5 | integer |
None. |
|
ShipmentReferenceID6 | integer |
None. |
|
ShipmentReferenceID7 | integer |
None. |
|
ShipmentReferenceID8 | integer |
None. |
|
ReferenceValue1 | string |
None. |
|
ReferenceValue2 | string |
None. |
|
ReferenceValue3 | string |
None. |
|
ReferenceValue4 | string |
None. |
|
ReferenceValue5 | string |
None. |
|
ReferenceValue6 | string |
None. |
|
ReferenceValue7 | string |
None. |
|
ReferenceValue8 | string |
None. |
|
DeclaredValue | decimal number |
None. |
|
DeclaredValueCurrencyID | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Contents": "sample string 4", "DeclaredValue": 1, "DeclaredValueCurrencyID": "sample string 16", "Height": 1, "Length": 1, "Pieces": 5, "Reference": "sample string 3", "ReferenceValue1": "sample string 8", "ReferenceValue2": "sample string 9", "ReferenceValue3": "sample string 10", "ReferenceValue4": "sample string 11", "ReferenceValue5": "sample string 12", "ReferenceValue6": "sample string 13", "ReferenceValue7": "sample string 14", "ReferenceValue8": "sample string 15", "ShipmentGUID": "sample string 2", "ShipmentReferenceID1": 1, "ShipmentReferenceID2": 1, "ShipmentReferenceID3": 1, "ShipmentReferenceID4": 1, "ShipmentReferenceID5": 1, "ShipmentReferenceID6": 1, "ShipmentReferenceID7": 1, "ShipmentReferenceID8": 1, "SizeUOM": "sample string 7", "Weight": 1, "WeightUOM": "sample string 6", "Width": 1, "auth": "sample string 1" }
application/xml, text/xml
Sample:
<EditOrderParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <Contents>sample string 4</Contents> <DeclaredValue>1</DeclaredValue> <DeclaredValueCurrencyID>sample string 16</DeclaredValueCurrencyID> <Height>1</Height> <Length>1</Length> <Pieces>5</Pieces> <Reference>sample string 3</Reference> <ReferenceValue1>sample string 8</ReferenceValue1> <ReferenceValue2>sample string 9</ReferenceValue2> <ReferenceValue3>sample string 10</ReferenceValue3> <ReferenceValue4>sample string 11</ReferenceValue4> <ReferenceValue5>sample string 12</ReferenceValue5> <ReferenceValue6>sample string 13</ReferenceValue6> <ReferenceValue7>sample string 14</ReferenceValue7> <ReferenceValue8>sample string 15</ReferenceValue8> <ShipmentGUID>sample string 2</ShipmentGUID> <ShipmentReferenceID1>1</ShipmentReferenceID1> <ShipmentReferenceID2>1</ShipmentReferenceID2> <ShipmentReferenceID3>1</ShipmentReferenceID3> <ShipmentReferenceID4>1</ShipmentReferenceID4> <ShipmentReferenceID5>1</ShipmentReferenceID5> <ShipmentReferenceID6>1</ShipmentReferenceID6> <ShipmentReferenceID7>1</ShipmentReferenceID7> <ShipmentReferenceID8>1</ShipmentReferenceID8> <SizeUOM>sample string 7</SizeUOM> <Weight>1</Weight> <WeightUOM>sample string 6</WeightUOM> <Width>1</Width> <auth>sample string 1</auth> </EditOrderParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBaseName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorMessage": "sample string 2", "IsSuccessful": true }
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>