POST DeliveryTicketDocument/CreateDeliveryTicketDocuments

Creates new delivery ticket documents

Request Information

URI Parameters

Body Parameters

Request object used to identify the Delivery Ticket(s) to create the new documents for

ClsDeliveryDocumentRequest
NameDescriptionTypeAdditional Information
Data

List of delivery ticket identifer records and which documents to create for each

 Collection of ClsDeliveryDocumentRequestItem

Required

List cannot be empty

Request Formats

application/json, text/json

Sample: 
{
  "Data": [
    {
      "DeliveryTicketGuid": "68010187-c2b8-4411-bd99-a141f6fd2edc",
      "DeliverTicketNum": 1,
      "DeliveryTicketLoc": "sample string 1",
      "DeliveryTicketDate": "2025-05-15T10:39:25.6862332+00:00",
      "CreateDeliveryTicketDocument": true,
      "CreateBillOfLadingDocument": true
    },
    {
      "DeliveryTicketGuid": "68010187-c2b8-4411-bd99-a141f6fd2edc",
      "DeliverTicketNum": 1,
      "DeliveryTicketLoc": "sample string 1",
      "DeliveryTicketDate": "2025-05-15T10:39:25.6862332+00:00",
      "CreateDeliveryTicketDocument": true,
      "CreateBillOfLadingDocument": true
    }
  ]
}

application/xml, text/xml

Sample: 
<ClsDeliveryTicketPrint.ClsDeliveryDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory">
  <Data>
    <ClsDeliveryTicketPrint.ClsDeliveryDocumentRequestItem>
      <CreateBillOfLadingDocument>true</CreateBillOfLadingDocument>
      <CreateDeliveryTicketDocument>true</CreateDeliveryTicketDocument>
      <DeliverTicketNum>1</DeliverTicketNum>
      <DeliveryTicketDate>2025-05-15T10:39:25.6862332+00:00</DeliveryTicketDate>
      <DeliveryTicketGuid>68010187-c2b8-4411-bd99-a141f6fd2edc</DeliveryTicketGuid>
      <DeliveryTicketLoc>sample string 1</DeliveryTicketLoc>
    </ClsDeliveryTicketPrint.ClsDeliveryDocumentRequestItem>
    <ClsDeliveryTicketPrint.ClsDeliveryDocumentRequestItem>
      <CreateBillOfLadingDocument>true</CreateBillOfLadingDocument>
      <CreateDeliveryTicketDocument>true</CreateDeliveryTicketDocument>
      <DeliverTicketNum>1</DeliverTicketNum>
      <DeliveryTicketDate>2025-05-15T10:39:25.6862332+00:00</DeliveryTicketDate>
      <DeliveryTicketGuid>68010187-c2b8-4411-bd99-a141f6fd2edc</DeliveryTicketGuid>
      <DeliveryTicketLoc>sample string 1</DeliveryTicketLoc>
    </ClsDeliveryTicketPrint.ClsDeliveryDocumentRequestItem>
  </Data>
</ClsDeliveryTicketPrint.ClsDeliveryDocumentRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsDeliveryDocumentRequest'.

Response Information

Resource Description

Creates new delivery ticket documents

AgvDelTickDocuments
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
ErrorList

List of error messages of the API call.

 Collection of string
WarningList

List of warning messages of the API call.

 Collection of string
Data

The object containing the list of tickets and their corresponding presigned urls

 ClsDeliveryDocumentResponse

Will be "null" when the status is not success.

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": {
    "TicketList": [
      {
        "DeliveryTicketGuid": "969112a4-64a1-4eb2-90c8-6184071e2759",
        "DeliverTicketNum": 1,
        "DeliveryTicketLoc": "sample string 4",
        "DeliveryTicketDate": "2025-05-15T10:39:25.6959366+00:00",
        "DeliveryTicketDocumentUrl": "sample string 5",
        "BillOfLadingDocumentUrl": "sample string 7"
      },
      {
        "DeliveryTicketGuid": "969112a4-64a1-4eb2-90c8-6184071e2759",
        "DeliverTicketNum": 1,
        "DeliveryTicketLoc": "sample string 4",
        "DeliveryTicketDate": "2025-05-15T10:39:25.6959366+00:00",
        "DeliveryTicketDocumentUrl": "sample string 5",
        "BillOfLadingDocumentUrl": "sample string 7"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<AgvDelTickDocuments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Inventory.DeliveryTicket">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory">
    <d2p1:TicketList>
      <d2p1:ClsDeliveryTicketPrint.ClsDeliveryDocumentResponseItem>
        <d2p1:BillOfLadingDocumentUrl>sample string 7</d2p1:BillOfLadingDocumentUrl>
        <d2p1:DeliverTicketNum>1</d2p1:DeliverTicketNum>
        <d2p1:DeliveryTicketDate>2025-05-15T10:39:25.6959366+00:00</d2p1:DeliveryTicketDate>
        <d2p1:DeliveryTicketDocumentUrl>sample string 5</d2p1:DeliveryTicketDocumentUrl>
        <d2p1:DeliveryTicketGuid>969112a4-64a1-4eb2-90c8-6184071e2759</d2p1:DeliveryTicketGuid>
        <d2p1:DeliveryTicketLoc>sample string 4</d2p1:DeliveryTicketLoc>
      </d2p1:ClsDeliveryTicketPrint.ClsDeliveryDocumentResponseItem>
      <d2p1:ClsDeliveryTicketPrint.ClsDeliveryDocumentResponseItem>
        <d2p1:BillOfLadingDocumentUrl>sample string 7</d2p1:BillOfLadingDocumentUrl>
        <d2p1:DeliverTicketNum>1</d2p1:DeliverTicketNum>
        <d2p1:DeliveryTicketDate>2025-05-15T10:39:25.6959366+00:00</d2p1:DeliveryTicketDate>
        <d2p1:DeliveryTicketDocumentUrl>sample string 5</d2p1:DeliveryTicketDocumentUrl>
        <d2p1:DeliveryTicketGuid>969112a4-64a1-4eb2-90c8-6184071e2759</d2p1:DeliveryTicketGuid>
        <d2p1:DeliveryTicketLoc>sample string 4</d2p1:DeliveryTicketLoc>
      </d2p1:ClsDeliveryTicketPrint.ClsDeliveryDocumentResponseItem>
    </d2p1:TicketList>
  </Data>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvDelTickDocuments>