GET api/Document/Shipment/{auth}/{ShipmentGUID}

Request Information

URI Parameters

Name	Description	Type	Additional information
auth		string	Required
ShipmentGUID		string	Required

Body Parameters

None.

Response Information

Resource Description

ShipmentDocumentResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
Documents	Collection of ShipmentDocumentItem	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ShipmentDocumentResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.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-12-28T09:28:46.3141647+00: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-12-28T09:28:46.3141647+00: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>