GET api/Shipper/GetOrderDetails/{UserGUID}/{ShipmentGUID}

Used to retrieve the order details

Request Information

URI Parameters

Name	Description	Type	Additional information
UserGUID	Unique user identifier used for authentication	string	Required
ShipmentGUID	The identifier of the shipment that you want to retrieve details	string	Required

Body Parameters

None.

Response Information

Resource Description

OrderDetailItem

Name	Description	Type	Additional information
ShipmentGUID		string	None.
OrderNumber		string	None.
StatusDisplay		string	None.
OrderDate		string	None.
OrderByName		string	None.
PiecesWeight		string	None.
ServiceName		string	None.
Reference		string	None.
Contents		string	None.
PickupAddress		string	None.
DeliveryAddress		string	None.
Itinerary		Collection of ItineraryItem	None.
Flights		Collection of FlightItem	None.
References		Collection of ReferenceItem	None.
Charges		Collection of ChargeItem	None.
Notes		Collection of NoteItem	None.
WorkflowID		string	None.
CustomsReleaseRequired		string	None.
OnWatchList		string	None.
GpsInfo		string	None.
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	Required
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ShipmentGUID": "sample string 1",
  "OrderNumber": "sample string 2",
  "StatusDisplay": "sample string 3",
  "OrderDate": "sample string 4",
  "OrderByName": "sample string 5",
  "PiecesWeight": "sample string 6",
  "ServiceName": "sample string 7",
  "Reference": "sample string 8",
  "Contents": "sample string 9",
  "PickupAddress": "sample string 10",
  "DeliveryAddress": "sample string 11",
  "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": [
    {
      "MasterTextLabel": "sample string 1",
      "DetailTextLabel": "sample string 2"
    },
    {
      "MasterTextLabel": "sample string 1",
      "DetailTextLabel": "sample string 2"
    }
  ],
  "References": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Charges": null,
  "Notes": [
    {
      "Description": "sample string 1"
    },
    {
      "Description": "sample string 1"
    }
  ],
  "WorkflowID": "sample string 12",
  "CustomsReleaseRequired": "sample string 13",
  "OnWatchList": "sample string 14",
  "GpsInfo": "sample string 15",
  "IsSuccessful": true,
  "ErrorMessage": "sample string 17"
}

application/xml, text/xml

Sample:

<OrderDetailItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 17</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Charges i:nil="true" />
  <Contents>sample string 9</Contents>
  <CustomsReleaseRequired>sample string 13</CustomsReleaseRequired>
  <DeliveryAddress>sample string 11</DeliveryAddress>
  <Flights>
    <FlightItem>
      <DetailTextLabel>sample string 2</DetailTextLabel>
      <MasterTextLabel>sample string 1</MasterTextLabel>
    </FlightItem>
    <FlightItem>
      <DetailTextLabel>sample string 2</DetailTextLabel>
      <MasterTextLabel>sample string 1</MasterTextLabel>
    </FlightItem>
  </Flights>
  <GpsInfo>sample string 15</GpsInfo>
  <Itinerary>
    <ItineraryItem>
      <IsCompleted>sample string 3</IsCompleted>
      <StepName>sample string 2</StepName>
      <StepSequence>sample string 1</StepSequence>
    </ItineraryItem>
    <ItineraryItem>
      <IsCompleted>sample string 3</IsCompleted>
      <StepName>sample string 2</StepName>
      <StepSequence>sample string 1</StepSequence>
    </ItineraryItem>
  </Itinerary>
  <Notes>
    <NoteItem>
      <Description>sample string 1</Description>
    </NoteItem>
    <NoteItem>
      <Description>sample string 1</Description>
    </NoteItem>
  </Notes>
  <OnWatchList>sample string 14</OnWatchList>
  <OrderByName>sample string 5</OrderByName>
  <OrderDate>sample string 4</OrderDate>
  <OrderNumber>sample string 2</OrderNumber>
  <PickupAddress>sample string 10</PickupAddress>
  <PiecesWeight>sample string 6</PiecesWeight>
  <Reference>sample string 8</Reference>
  <References>
    <ReferenceItem>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </ReferenceItem>
    <ReferenceItem>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </ReferenceItem>
  </References>
  <ServiceName>sample string 7</ServiceName>
  <ShipmentGUID>sample string 1</ShipmentGUID>
  <StatusDisplay>sample string 3</StatusDisplay>
  <WorkflowID>sample string 12</WorkflowID>
</OrderDetailItem>