POST api/ShipmentPrint

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserCredential	UserCredential	Required
ClientDetails	ClientDetails	Required
VersionDetails	VersionDetails	Required
TransactionDetails	TransactionDetails	Required
LabelDetails	LabelDetails	Required

Request Formats

application/json, text/json

Sample:

{
  "UserCredential": {
    "UserKey": "sample string 1",
    "UserPassword": "sample string 2",
    "UserPIN": "sample string 3"
  },
  "ClientDetails": {
    "AccountNumber": "sample string 1"
  },
  "VersionDetails": {
    "RequestType": "sample string 1",
    "VersionMinor": 2,
    "VersionMajor": 3
  },
  "TransactionDetails": {
    "TransactionReferenceNumber": "sample string 1"
  },
  "LabelDetails": {
    "BarcodeLabelPrintYN": "sample string 1",
    "AirwayBillLabelPrintYN": "sample string 2",
    "CommercialInvoicePrintYN": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ShipmentPrint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Target.Core.Courier.BL">
  <ClientDetails>
    <AccountNumber>sample string 1</AccountNumber>
  </ClientDetails>
  <LabelDetails>
    <AirwayBillLabelPrintYN>sample string 2</AirwayBillLabelPrintYN>
    <BarcodeLabelPrintYN>sample string 1</BarcodeLabelPrintYN>
    <CommercialInvoicePrintYN>sample string 3</CommercialInvoicePrintYN>
  </LabelDetails>
  <TransactionDetails>
    <TransactionReferenceNumber>sample string 1</TransactionReferenceNumber>
  </TransactionDetails>
  <UserCredential>
    <UserKey>sample string 1</UserKey>
    <UserPIN>sample string 3</UserPIN>
    <UserPassword>sample string 2</UserPassword>
  </UserCredential>
  <VersionDetails>
    <RequestType>sample string 1</RequestType>
    <VersionMajor>3</VersionMajor>
    <VersionMinor>2</VersionMinor>
  </VersionDetails>
</ShipmentPrint>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentPrintResponse

Name	Description	Type	Additional information
ResponseStatus		ResponseStatus	None.
ResponseLabelPrstring		ResponseLabelPrstring	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseStatus": {
    "Status": "sample string 1",
    "StatusDetails": "sample string 2"
  },
  "ResponseLabelPrstring": {
    "BarcodeLabel": "sample string 1",
    "ShipmentLabelFormat": "sample string 2",
    "CommercialInvoiceFormat": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ShipmentPrintResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Target.Core.Courier.BL">
  <ResponseLabelPrstring>
    <BarcodeLabel>sample string 1</BarcodeLabel>
    <CommercialInvoiceFormat>sample string 3</CommercialInvoiceFormat>
    <ShipmentLabelFormat>sample string 2</ShipmentLabelFormat>
  </ResponseLabelPrstring>
  <ResponseStatus>
    <Status>sample string 1</Status>
    <StatusDetails>sample string 2</StatusDetails>
  </ResponseStatus>
</ShipmentPrintResponse>