GET api/audShipSearch/OrderID/{OrderID}

Search for Order/Packages by OrderID

Request Information

URI Parameters

Name	Description	Type	Additional information
OrderID	The Ship OrderID to search for	integer	Required

Body Parameters

None.

Response Information

Resource Description

A single audShipOrderSummary record

audShipOrderSummary

Name	Type	Additional information
ShipOrderID	integer	None.
ShipmentID	integer	None.
ClientName	string	None.
ConsigneeName	string	None.
ConsigneeAddress	string	None.
CarrierName	string	None.
ServiceCode	string	None.
ReferenceNumber	string	None.
ReferenceNumber2	string	None.
ShipDate	string	None.
ShipPackages	Collection of audShipPackageSummary	None.

Response Formats

application/json, text/json

Sample:

{
  "ShipOrderID": 1,
  "ShipmentID": 2,
  "ClientName": "sample string 3",
  "ConsigneeName": "sample string 4",
  "ConsigneeAddress": "sample string 5",
  "CarrierName": "sample string 6",
  "ServiceCode": "sample string 7",
  "ReferenceNumber": "sample string 8",
  "ReferenceNumber2": "sample string 9",
  "ShipDate": "sample string 10",
  "ShipPackages": [
    {
      "ShipPackageID": 1,
      "ManifestPackageID": 2,
      "TrackingNumber": "sample string 3",
      "ShipLength": 4,
      "ShipWidth": 5,
      "ShipHeight": 6,
      "ShipWeight": 7
    },
    {
      "ShipPackageID": 1,
      "ManifestPackageID": 2,
      "TrackingNumber": "sample string 3",
      "ShipLength": 4,
      "ShipWidth": 5,
      "ShipHeight": 6,
      "ShipWeight": 7
    }
  ]
}

application/xml, text/xml

Sample:

<audShipOrderSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <CarrierName>sample string 6</CarrierName>
  <ClientName>sample string 3</ClientName>
  <ConsigneeAddress>sample string 5</ConsigneeAddress>
  <ConsigneeName>sample string 4</ConsigneeName>
  <ReferenceNumber>sample string 8</ReferenceNumber>
  <ReferenceNumber2>sample string 9</ReferenceNumber2>
  <ServiceCode>sample string 7</ServiceCode>
  <ShipDate>sample string 10</ShipDate>
  <ShipOrderID>1</ShipOrderID>
  <ShipPackages>
    <audShipPackageSummary>
      <ManifestPackageID>2</ManifestPackageID>
      <ShipHeight>6</ShipHeight>
      <ShipLength>4</ShipLength>
      <ShipPackageID>1</ShipPackageID>
      <ShipWeight>7</ShipWeight>
      <ShipWidth>5</ShipWidth>
      <TrackingNumber>sample string 3</TrackingNumber>
    </audShipPackageSummary>
    <audShipPackageSummary>
      <ManifestPackageID>2</ManifestPackageID>
      <ShipHeight>6</ShipHeight>
      <ShipLength>4</ShipLength>
      <ShipPackageID>1</ShipPackageID>
      <ShipWeight>7</ShipWeight>
      <ShipWidth>5</ShipWidth>
      <TrackingNumber>sample string 3</TrackingNumber>
    </audShipPackageSummary>
  </ShipPackages>
  <ShipmentID>2</ShipmentID>
</audShipOrderSummary>