GET api/Document/Shipment/Detail/{auth}/{ShipmentDocumentID}

Used to select a single shipment document including raw file data

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	Required
ShipmentDocumentID	Unique shipment document identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

ShipmentDocumentResp

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.
Documents	Documents attached to the shipment	Collection of ShipmentDocumentItem	None.

Response Formats

application/json, text/json

Sample:

{
  "Documents": [
    {
      "Description": "sample string 4",
      "DocumentTypeID": 5,
      "DocumentTypeName": "sample string 13",
      "FileData": "sample string 19",
      "IncludeWithDelivery": true,
      "IncludeWithInvoice": true,
      "IncludeWithPickup": true,
      "InsertDateTime": "2024-09-21T15:19:51.505-07:00",
      "InsertUserID": 10,
      "InsertUserName": "sample string 12",
      "IsSysDoc": true,
      "Name": "sample string 3",
      "OrderNumber": "sample string 16",
      "OriginalFileName": "sample string 6",
      "ShipmentDocumentID": 1,
      "ShipmentGUID": "sample string 2",
      "SysDocType": "sample string 15",
      "SystemFileName": "sample string 7",
      "VisibleToCustomers": true
    },
    {
      "Description": "sample string 4",
      "DocumentTypeID": 5,
      "DocumentTypeName": "sample string 13",
      "FileData": "sample string 19",
      "IncludeWithDelivery": true,
      "IncludeWithInvoice": true,
      "IncludeWithPickup": true,
      "InsertDateTime": "2024-09-21T15:19:51.505-07:00",
      "InsertUserID": 10,
      "InsertUserName": "sample string 12",
      "IsSysDoc": true,
      "Name": "sample string 3",
      "OrderNumber": "sample string 16",
      "OriginalFileName": "sample string 6",
      "ShipmentDocumentID": 1,
      "ShipmentGUID": "sample string 2",
      "SysDocType": "sample string 15",
      "SystemFileName": "sample string 7",
      "VisibleToCustomers": true
    }
  ],
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true
}

application/xml, text/xml

Sample:

<ShipmentDocumentResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <Documents>
    <ShipmentDocumentItem>
      <Description>sample string 4</Description>
      <DocumentTypeID>5</DocumentTypeID>
      <DocumentTypeName>sample string 13</DocumentTypeName>
      <FileData>sample string 19</FileData>
      <IncludeWithDelivery>true</IncludeWithDelivery>
      <IncludeWithInvoice>true</IncludeWithInvoice>
      <IncludeWithPickup>true</IncludeWithPickup>
      <InsertDateTime>2024-09-21T15:19:51.5053369-07:00</InsertDateTime>
      <InsertUserID>10</InsertUserID>
      <InsertUserName>sample string 12</InsertUserName>
      <IsSysDoc>true</IsSysDoc>
      <Name>sample string 3</Name>
      <OrderNumber>sample string 16</OrderNumber>
      <OriginalFileName>sample string 6</OriginalFileName>
      <ShipmentDocumentID>1</ShipmentDocumentID>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <SysDocType>sample string 15</SysDocType>
      <SystemFileName>sample string 7</SystemFileName>
      <VisibleToCustomers>true</VisibleToCustomers>
    </ShipmentDocumentItem>
    <ShipmentDocumentItem>
      <Description>sample string 4</Description>
      <DocumentTypeID>5</DocumentTypeID>
      <DocumentTypeName>sample string 13</DocumentTypeName>
      <FileData>sample string 19</FileData>
      <IncludeWithDelivery>true</IncludeWithDelivery>
      <IncludeWithInvoice>true</IncludeWithInvoice>
      <IncludeWithPickup>true</IncludeWithPickup>
      <InsertDateTime>2024-09-21T15:19:51.5053369-07:00</InsertDateTime>
      <InsertUserID>10</InsertUserID>
      <InsertUserName>sample string 12</InsertUserName>
      <IsSysDoc>true</IsSysDoc>
      <Name>sample string 3</Name>
      <OrderNumber>sample string 16</OrderNumber>
      <OriginalFileName>sample string 6</OriginalFileName>
      <ShipmentDocumentID>1</ShipmentDocumentID>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <SysDocType>sample string 15</SysDocType>
      <SystemFileName>sample string 7</SystemFileName>
      <VisibleToCustomers>true</VisibleToCustomers>
    </ShipmentDocumentItem>
  </Documents>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ShipmentDocumentResp>