POST api/Orders/GetStatus

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique system generated user identifier	string	None.
ShipmentGUID	Internal Shipment identifier	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "ShipmentGUID": "sample string 2"
}

application/xml, text/xml

Sample:

<GetStatusParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <UserGUID>sample string 1</UserGUID>
</GetStatusParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetStatusResp

Name	Description	Type	Additional information
IsSuccessful	Set to true if method was successful	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Order	Order detail item		None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Order": {
    "ErrorMessage": "sample string 1",
    "ShipmentGUID": "sample string 2",
    "OrderNumber": "sample string 3",
    "StatusDisplay": "sample string 4",
    "OrderDate": "sample string 5",
    "OrderByName": "sample string 6",
    "PiecesWeight": "sample string 7",
    "ServiceName": "sample string 8",
    "Reference": "sample string 9",
    "Contents": "sample string 10",
    "PickupAddress": "sample string 11",
    "DeliveryAddress": "sample string 12",
    "Itinerary": [
      {
        "StepSequence": "sample string 1",
        "StepName": "sample string 2",
        "IsCompleted": "sample string 3"
      },
      {
        "StepSequence": "sample string 1",
        "StepName": "sample string 2",
        "IsCompleted": "sample string 3"
      }
    ],
    "Flights": null,
    "References": null,
    "Charges": null,
    "Notes": null,
    "WorkflowID": "sample string 13",
    "CustomsReleaseRequired": "sample string 14",
    "OnWatchList": "sample string 15"
  }
}

application/xml, text/xml

Sample:

<GetStatusResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Order xmlns:d2p1="http://schemas.datacontract.org/2004/07/ParcelLogic.WcfWebServices.Transportation">
    <d2p1:Charges i:nil="true" />
    <d2p1:Contents>sample string 10</d2p1:Contents>
    <d2p1:CustomsReleaseRequired>sample string 14</d2p1:CustomsReleaseRequired>
    <d2p1:DeliveryAddress>sample string 12</d2p1:DeliveryAddress>
    <d2p1:ErrorMessage>sample string 1</d2p1:ErrorMessage>
    <d2p1:Flights i:nil="true" />
    <d2p1:Itinerary>
      <d2p1:ItineraryItem>
        <d2p1:IsCompleted>sample string 3</d2p1:IsCompleted>
        <d2p1:StepName>sample string 2</d2p1:StepName>
        <d2p1:StepSequence>sample string 1</d2p1:StepSequence>
      </d2p1:ItineraryItem>
      <d2p1:ItineraryItem>
        <d2p1:IsCompleted>sample string 3</d2p1:IsCompleted>
        <d2p1:StepName>sample string 2</d2p1:StepName>
        <d2p1:StepSequence>sample string 1</d2p1:StepSequence>
      </d2p1:ItineraryItem>
    </d2p1:Itinerary>
    <d2p1:Notes i:nil="true" />
    <d2p1:OnWatchList>sample string 15</d2p1:OnWatchList>
    <d2p1:OrderByName>sample string 6</d2p1:OrderByName>
    <d2p1:OrderDate>sample string 5</d2p1:OrderDate>
    <d2p1:OrderNumber>sample string 3</d2p1:OrderNumber>
    <d2p1:PickupAddress>sample string 11</d2p1:PickupAddress>
    <d2p1:PiecesWeight>sample string 7</d2p1:PiecesWeight>
    <d2p1:Reference>sample string 9</d2p1:Reference>
    <d2p1:References i:nil="true" />
    <d2p1:ServiceName>sample string 8</d2p1:ServiceName>
    <d2p1:ShipmentGUID>sample string 2</d2p1:ShipmentGUID>
    <d2p1:StatusDisplay>sample string 4</d2p1:StatusDisplay>
    <d2p1:WorkflowID>sample string 13</d2p1:WorkflowID>
  </Order>
</GetStatusResp>