POST api/MailTracking/GetCertifiedReceiptPdf

Gets receipt PDF bytes for a given order number.

Request Information

URI Parameters

None.

Body Parameters

GetCertifiedReceiptPdfRequestModel
NameDescriptionTypeAdditional information
UserId

integer

None.

AuthToken

string

None.

OrderId

The SouthData order number that will be used to retrieve the PDF. OrderId is required and must be a positive number.

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "UserId": 1,
  "AuthToken": "sample string 2",
  "OrderId": 3
}

application/xml, text/xml

Sample:
<GetCertifiedReceiptPdfRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AuthToken>sample string 2</AuthToken>
  <OrderId>3</OrderId>
  <UserId>1</UserId>
</GetCertifiedReceiptPdfRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/octet-stream

Sample:

Sample not available.

Response Information

Resource Description

Response model containing the bytes of the certified tracking receipt pdf for the provided order

GetCertifiedReceiptPdfResponseModel
NameDescriptionTypeAdditional information
FileBytes

Collection of byte

None.

Response Formats

application/json, text/json

Sample:
{
  "FileBytes": "QEA="
}

application/xml, text/xml

Sample:
<GetCertifiedReceiptPdfResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <FileBytes>QEA=</FileBytes>
</GetCertifiedReceiptPdfResponseModel>