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

UpdateOrderParm
NameDescriptionTypeAdditional information
UserGUID

Unique system generated user identifier

 string

Required

Max length: 36
ShipmentNumber

System assigned shipment number to update

 integer

Required
PickupAddressCode

Address code used to identify address

 string

Max length: 20
PickupCompanyName

Company name at pickup address

 string

Required

Max length: 50
PickupAddress1

First line of street address

 string

Max length: 50
PickupAddress2

Second line of street address

 string

Max length: 50
PickupAddress3

Third line of street address

 string

Max length: 50
PickupCityName

City name at pickup address

 string

Required

Max length: 50
PickupStateProvID

State or province code at pickup address

 string

Max length: 3
PickupPostalCode

Postal code at pickup address

 string

Max length: 10
PickupCountryID

Country ID at pickup address (ie. US)

 string

Required

Max length: 10
PickupPersonToSee

Name of person to see at pickup address

 string

Max length: 50
PickupPhoneNumber

Phone number at pickup address

 string

Max length: 25
PickupInstructions

Special instructions at pickup

 string

Max length: 500
DeliveryAddressCode

Address code used to identify delivery address

 string

Max length: 20
DeliveryCompanyName

Company name at delivery address

 string

Max length: 50
DeliveryAddress1

First address line at delivery address

 string

Max length: 50
DeliveryAddress2

Second address line at delivery address

 string

Max length: 50
DeliveryAddress3

Third address line at delivery address

 string

Max length: 50
DeliveryCityName

City name at delivery address

 string

Max length: 50
DeliveryStateProvID

State or province code at delivery address

 string

Max length: 3
DeliveryPostalCode

Postal code at delivery address

 string

Max length: 10
DeliveryCountryID

Country code at delivery address (ie. US)

 string

Max length: 2
DeliveryAttention

Attention person at delivery address

 string

Max length: 50
DeliveryPhoneNumber

Phone number at delivery address

 string

Max length: 25
DeliveryEmailAddress

Email address at delivery address

 string

Max length: 100
DeliveryInstructions

Special instructions at delivery

 string

Max length: 500
ReadyDate

The date the shipment is ready in pickup timezone (yyyy-MM-dd)

 string

Required

Max length: 10
ReadyTime

The time the shipment is ready in pickup timezone (HH:mm)

 string

Required

Max length: 5

Request Formats

application/json, text/json

Sample: 
{
  "DeliveryAddress1": "sample string 17",
  "DeliveryAddress2": "sample string 18",
  "DeliveryAddress3": "sample string 19",
  "DeliveryAddressCode": "sample string 15",
  "DeliveryAttention": "sample string 24",
  "DeliveryCityName": "sample string 20",
  "DeliveryCompanyName": "sample string 16",
  "DeliveryCountryID": "sample string 23",
  "DeliveryEmailAddress": "sample string 26",
  "DeliveryInstructions": "sample string 27",
  "DeliveryPhoneNumber": "sample string 25",
  "DeliveryPostalCode": "sample string 22",
  "DeliveryStateProvID": "sample string 21",
  "PickupAddress1": "sample string 5",
  "PickupAddress2": "sample string 6",
  "PickupAddress3": "sample string 7",
  "PickupAddressCode": "sample string 3",
  "PickupCityName": "sample string 8",
  "PickupCompanyName": "sample string 4",
  "PickupCountryID": "sample string 11",
  "PickupInstructions": "sample string 14",
  "PickupPersonToSee": "sample string 12",
  "PickupPhoneNumber": "sample string 13",
  "PickupPostalCode": "sample string 10",
  "PickupStateProvID": "sample string 9",
  "ReadyDate": "sample string 28",
  "ReadyTime": "sample string 29",
  "ShipmentNumber": 2,
  "UserGUID": "sample string 1"
}

application/xml, text/xml

Sample: 
<UpdateOrderParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <DeliveryAddress1>sample string 17</DeliveryAddress1>
  <DeliveryAddress2>sample string 18</DeliveryAddress2>
  <DeliveryAddress3>sample string 19</DeliveryAddress3>
  <DeliveryAddressCode>sample string 15</DeliveryAddressCode>
  <DeliveryAttention>sample string 24</DeliveryAttention>
  <DeliveryCityName>sample string 20</DeliveryCityName>
  <DeliveryCompanyName>sample string 16</DeliveryCompanyName>
  <DeliveryCountryID>sample string 23</DeliveryCountryID>
  <DeliveryEmailAddress>sample string 26</DeliveryEmailAddress>
  <DeliveryInstructions>sample string 27</DeliveryInstructions>
  <DeliveryPhoneNumber>sample string 25</DeliveryPhoneNumber>
  <DeliveryPostalCode>sample string 22</DeliveryPostalCode>
  <DeliveryStateProvID>sample string 21</DeliveryStateProvID>
  <PickupAddress1>sample string 5</PickupAddress1>
  <PickupAddress2>sample string 6</PickupAddress2>
  <PickupAddress3>sample string 7</PickupAddress3>
  <PickupAddressCode>sample string 3</PickupAddressCode>
  <PickupCityName>sample string 8</PickupCityName>
  <PickupCompanyName>sample string 4</PickupCompanyName>
  <PickupCountryID>sample string 11</PickupCountryID>
  <PickupInstructions>sample string 14</PickupInstructions>
  <PickupPersonToSee>sample string 12</PickupPersonToSee>
  <PickupPhoneNumber>sample string 13</PickupPhoneNumber>
  <PickupPostalCode>sample string 10</PickupPostalCode>
  <PickupStateProvID>sample string 9</PickupStateProvID>
  <ReadyDate>sample string 28</ReadyDate>
  <ReadyTime>sample string 29</ReadyTime>
  <ShipmentNumber>2</ShipmentNumber>
  <UserGUID>sample string 1</UserGUID>
</UpdateOrderParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

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.

Response Formats

application/json, text/json

Sample: 
{
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true,
  "ShipmentNumber": 3
}

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>
  <IsSuccessful>true</IsSuccessful>
  <ShipmentNumber>3</ShipmentNumber>
</UpdateOrderResp>