GET api/Ship/Edit/{auth}/{TrackingValue}

Use this method to retrieve order information before editing

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	Required
TrackingValue	Tracking value	string	Required

Body Parameters

None.

Response Information

Resource Description

EditOrderResp

Name	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.
ShipmentGUID		string	None.
OrderState		string	None.
OrderStatus		integer	None.
ShipmentNumber		integer	None.
TrackingNumber		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.
PuCompanyName		string	None.
PuAddress1		string	None.
PuAddress2		string	None.
PuAddress3		string	None.
PuCityName		string	None.
PuStateProvID		string	None.
PuPostalCode		string	None.
PuCountryID		string	None.
PuCountryName		string	None.
PuPersonToSee		string	None.
PuPhoneNumber		string	None.
DelCompanyName		string	None.
DelAddress1		string	None.
DelAddress2		string	None.
DelAddress3		string	None.
DelCityName		string	None.
DelStateProvID		string	None.
DelPostalCode		string	None.
DelCountryID		string	None.
DelCountryName		string	None.
DelAttention		string	None.
DelPhoneNumber		string	None.
ServiceID		integer	None.
ServiceName		string	None.
DeclaredValue		decimal number	None.
DeclaredValueCurrencyID		string	None.
ReadyDateTime		date	None.
ShipmentReferenceID1		integer	None.
ReferenceTypeID1		integer	None.
ReferenceLabel1		string	None.
ReferenceValue1		string	None.
ShipmentReferenceID2		integer	None.
ReferenceTypeID2		integer	None.
ReferenceLabel2		string	None.
ReferenceValue2		string	None.
ShipmentReferenceID3		integer	None.
ReferenceTypeID3		integer	None.
ReferenceLabel3		string	None.
ReferenceValue3		string	None.
ShipmentReferenceID4		integer	None.
ReferenceTypeID4		integer	None.
ReferenceLabel4		string	None.
ReferenceValue4		string	None.
ShipmentReferenceID5		integer	None.
ReferenceTypeID5		integer	None.
ReferenceLabel5		string	None.
ReferenceValue5		string	None.
ShipmentReferenceID6		integer	None.
ReferenceTypeID6		integer	None.
ReferenceLabel6		string	None.
ReferenceValue6		string	None.
ShipmentReferenceID7		integer	None.
ReferenceTypeID7		integer	None.
ReferenceLabel7		string	None.
ReferenceValue7		string	None.
ShipmentReferenceID8		integer	None.
ReferenceTypeID8		integer	None.
ReferenceLabel8		string	None.
ReferenceValue8		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Contents": "sample string 9",
  "DeclaredValue": 1,
  "DeclaredValueCurrencyID": "sample string 37",
  "DelAddress1": "sample string 25",
  "DelAddress2": "sample string 26",
  "DelAddress3": "sample string 27",
  "DelAttention": "sample string 33",
  "DelCityName": "sample string 28",
  "DelCompanyName": "sample string 24",
  "DelCountryID": "sample string 31",
  "DelCountryName": "sample string 32",
  "DelPhoneNumber": "sample string 34",
  "DelPostalCode": "sample string 30",
  "DelStateProvID": "sample string 29",
  "ErrorMessage": "sample string 2",
  "Height": 1,
  "IsSuccessful": true,
  "Length": 1,
  "OrderState": "sample string 4",
  "OrderStatus": 5,
  "Pieces": 10,
  "PuAddress1": "sample string 14",
  "PuAddress2": "sample string 15",
  "PuAddress3": "sample string 16",
  "PuCityName": "sample string 17",
  "PuCompanyName": "sample string 13",
  "PuCountryID": "sample string 20",
  "PuCountryName": "sample string 21",
  "PuPersonToSee": "sample string 22",
  "PuPhoneNumber": "sample string 23",
  "PuPostalCode": "sample string 19",
  "PuStateProvID": "sample string 18",
  "ReadyDateTime": "2025-04-03T13:41:16.441-07:00",
  "Reference": "sample string 8",
  "ReferenceLabel1": "sample string 39",
  "ReferenceLabel2": "sample string 41",
  "ReferenceLabel3": "sample string 43",
  "ReferenceLabel4": "sample string 45",
  "ReferenceLabel5": "sample string 47",
  "ReferenceLabel6": "sample string 49",
  "ReferenceLabel7": "sample string 51",
  "ReferenceLabel8": "sample string 53",
  "ReferenceTypeID1": 1,
  "ReferenceTypeID2": 1,
  "ReferenceTypeID3": 1,
  "ReferenceTypeID4": 1,
  "ReferenceTypeID5": 1,
  "ReferenceTypeID6": 1,
  "ReferenceTypeID7": 1,
  "ReferenceTypeID8": 1,
  "ReferenceValue1": "sample string 40",
  "ReferenceValue2": "sample string 42",
  "ReferenceValue3": "sample string 44",
  "ReferenceValue4": "sample string 46",
  "ReferenceValue5": "sample string 48",
  "ReferenceValue6": "sample string 50",
  "ReferenceValue7": "sample string 52",
  "ReferenceValue8": "sample string 54",
  "ServiceID": 35,
  "ServiceName": "sample string 36",
  "ShipmentGUID": "sample string 3",
  "ShipmentNumber": 6,
  "ShipmentReferenceID1": 1,
  "ShipmentReferenceID2": 1,
  "ShipmentReferenceID3": 1,
  "ShipmentReferenceID4": 1,
  "ShipmentReferenceID5": 1,
  "ShipmentReferenceID6": 1,
  "ShipmentReferenceID7": 1,
  "ShipmentReferenceID8": 1,
  "SizeUOM": "sample string 12",
  "TrackingNumber": "sample string 7",
  "Weight": 1,
  "WeightUOM": "sample string 11",
  "Width": 1
}

application/xml, text/xml

Sample:

<EditOrderResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <Contents>sample string 9</Contents>
  <DeclaredValue>1</DeclaredValue>
  <DeclaredValueCurrencyID>sample string 37</DeclaredValueCurrencyID>
  <DelAddress1>sample string 25</DelAddress1>
  <DelAddress2>sample string 26</DelAddress2>
  <DelAddress3>sample string 27</DelAddress3>
  <DelAttention>sample string 33</DelAttention>
  <DelCityName>sample string 28</DelCityName>
  <DelCompanyName>sample string 24</DelCompanyName>
  <DelCountryID>sample string 31</DelCountryID>
  <DelCountryName>sample string 32</DelCountryName>
  <DelPhoneNumber>sample string 34</DelPhoneNumber>
  <DelPostalCode>sample string 30</DelPostalCode>
  <DelStateProvID>sample string 29</DelStateProvID>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Height>1</Height>
  <IsSuccessful>true</IsSuccessful>
  <Length>1</Length>
  <OrderState>sample string 4</OrderState>
  <OrderStatus>5</OrderStatus>
  <Pieces>10</Pieces>
  <PuAddress1>sample string 14</PuAddress1>
  <PuAddress2>sample string 15</PuAddress2>
  <PuAddress3>sample string 16</PuAddress3>
  <PuCityName>sample string 17</PuCityName>
  <PuCompanyName>sample string 13</PuCompanyName>
  <PuCountryID>sample string 20</PuCountryID>
  <PuCountryName>sample string 21</PuCountryName>
  <PuPersonToSee>sample string 22</PuPersonToSee>
  <PuPhoneNumber>sample string 23</PuPhoneNumber>
  <PuPostalCode>sample string 19</PuPostalCode>
  <PuStateProvID>sample string 18</PuStateProvID>
  <ReadyDateTime>2025-04-03T13:41:16.4412689-07:00</ReadyDateTime>
  <Reference>sample string 8</Reference>
  <ReferenceLabel1>sample string 39</ReferenceLabel1>
  <ReferenceLabel2>sample string 41</ReferenceLabel2>
  <ReferenceLabel3>sample string 43</ReferenceLabel3>
  <ReferenceLabel4>sample string 45</ReferenceLabel4>
  <ReferenceLabel5>sample string 47</ReferenceLabel5>
  <ReferenceLabel6>sample string 49</ReferenceLabel6>
  <ReferenceLabel7>sample string 51</ReferenceLabel7>
  <ReferenceLabel8>sample string 53</ReferenceLabel8>
  <ReferenceTypeID1>1</ReferenceTypeID1>
  <ReferenceTypeID2>1</ReferenceTypeID2>
  <ReferenceTypeID3>1</ReferenceTypeID3>
  <ReferenceTypeID4>1</ReferenceTypeID4>
  <ReferenceTypeID5>1</ReferenceTypeID5>
  <ReferenceTypeID6>1</ReferenceTypeID6>
  <ReferenceTypeID7>1</ReferenceTypeID7>
  <ReferenceTypeID8>1</ReferenceTypeID8>
  <ReferenceValue1>sample string 40</ReferenceValue1>
  <ReferenceValue2>sample string 42</ReferenceValue2>
  <ReferenceValue3>sample string 44</ReferenceValue3>
  <ReferenceValue4>sample string 46</ReferenceValue4>
  <ReferenceValue5>sample string 48</ReferenceValue5>
  <ReferenceValue6>sample string 50</ReferenceValue6>
  <ReferenceValue7>sample string 52</ReferenceValue7>
  <ReferenceValue8>sample string 54</ReferenceValue8>
  <ServiceID>35</ServiceID>
  <ServiceName>sample string 36</ServiceName>
  <ShipmentGUID>sample string 3</ShipmentGUID>
  <ShipmentNumber>6</ShipmentNumber>
  <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 12</SizeUOM>
  <TrackingNumber>sample string 7</TrackingNumber>
  <Weight>1</Weight>
  <WeightUOM>sample string 11</WeightUOM>
  <Width>1</Width>
</EditOrderResp>