POST api/Document/Shipment/Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
ShipmentGUID	string	None.
Name	string	None.
Description	string	None.
DocumentTypeID	integer	None.
OriginalFileName	string	None.
IncludeWithPickup	boolean	None.
IncludeWithDelivery	boolean	None.
IncludeWithInvoice	boolean	None.
VisibleToCustomers	boolean	None.
FileData	string	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ShipmentGUID": "sample string 2",
  "Name": "sample string 3",
  "Description": "sample string 4",
  "DocumentTypeID": 1,
  "OriginalFileName": "sample string 5",
  "IncludeWithPickup": true,
  "IncludeWithDelivery": true,
  "IncludeWithInvoice": true,
  "VisibleToCustomers": true,
  "FileData": "sample string 10"
}

application/xml, text/xml

Sample:

<CreateShipmentDocumentParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Description>sample string 4</Description>
  <DocumentTypeID>1</DocumentTypeID>
  <FileData>sample string 10</FileData>
  <IncludeWithDelivery>true</IncludeWithDelivery>
  <IncludeWithInvoice>true</IncludeWithInvoice>
  <IncludeWithPickup>true</IncludeWithPickup>
  <Name>sample string 3</Name>
  <OriginalFileName>sample string 5</OriginalFileName>
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <VisibleToCustomers>true</VisibleToCustomers>
  <auth>sample string 1</auth>
</CreateShipmentDocumentParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
IsSuccessful		boolean	None.
ErrorMessage		string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>