POST api/Ship/UpdateOrder

Used to Update an order (only available before courier is dispatched, on limited fields)

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

UpdateOrderResp
NameDescriptionTypeAdditional information
IsSuccessful

Method call was successful (true) or failed (false)

boolean

None.

ErrorMessage

Error message if method call failed for any reason

string

None.

ShipmentNumber

Unique system generated shipment number

integer

None.

WaybillNumber

The carriers waybill number

string

None.

FileData

The raw file data

string

None.

FileName

Name of the file

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorMessage": "sample string 2",
  "FileData": "sample string 5",
  "FileName": "sample string 6",
  "IsSuccessful": true,
  "ShipmentNumber": 3,
  "WaybillNumber": "sample string 4"
}

application/xml, text/xml

Sample:
<UpdateOrderResp 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>
  <FileData>sample string 5</FileData>
  <FileName>sample string 6</FileName>
  <IsSuccessful>true</IsSuccessful>
  <ShipmentNumber>3</ShipmentNumber>
  <WaybillNumber>sample string 4</WaybillNumber>
</UpdateOrderResp>