ServiceObject

Click here for a complete list of operations.

GetReturnLabel

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST / HTTP/1.1
Host: test-api.nfk.inpost.pl
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetReturnLabel"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetReturnLabel xmlns="http://tempuri.org/">
      <token>
        <UserName>string</UserName>
        <Password>string</Password>
      </token>
      <getReturnLabelRequest>
        <PackageNo>
          <string>string</string>
          <string>string</string>
        </PackageNo>
        <ConsolidateLabels>boolean</ConsolidateLabels>
        <Format>PDF or ZPL or GIF or EPL or PDFA4 or PDFA4Consolidated or PDFConsolidated or PNG</Format>
      </getReturnLabelRequest>
    </GetReturnLabel>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetReturnLabelResponse xmlns="http://tempuri.org/">
      <GetReturnLabelResult>
        <LabelData>
          <Label>
            <ParcelID>string</ParcelID>
            <MimeFormat>PDF or ZPL or GIF or EPL or PDFA4 or PDFA4Consolidated or PDFConsolidated or PNG</MimeFormat>
            <MimeData>base64Binary</MimeData>
          </Label>
          <Label>
            <ParcelID>string</ParcelID>
            <MimeFormat>PDF or ZPL or GIF or EPL or PDFA4 or PDFA4Consolidated or PDFConsolidated or PNG</MimeFormat>
            <MimeData>base64Binary</MimeData>
          </Label>
        </LabelData>
      </GetReturnLabelResult>
    </GetReturnLabelResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST / HTTP/1.1
Host: test-api.nfk.inpost.pl
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetReturnLabel xmlns="http://tempuri.org/">
      <token>
        <UserName>string</UserName>
        <Password>string</Password>
      </token>
      <getReturnLabelRequest>
        <PackageNo>
          <string>string</string>
          <string>string</string>
        </PackageNo>
        <ConsolidateLabels>boolean</ConsolidateLabels>
        <Format>PDF or ZPL or GIF or EPL or PDFA4 or PDFA4Consolidated or PDFConsolidated or PNG</Format>
      </getReturnLabelRequest>
    </GetReturnLabel>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetReturnLabelResponse xmlns="http://tempuri.org/">
      <GetReturnLabelResult>
        <LabelData>
          <Label>
            <ParcelID>string</ParcelID>
            <MimeFormat>PDF or ZPL or GIF or EPL or PDFA4 or PDFA4Consolidated or PDFConsolidated or PNG</MimeFormat>
            <MimeData>base64Binary</MimeData>
          </Label>
          <Label>
            <ParcelID>string</ParcelID>
            <MimeFormat>PDF or ZPL or GIF or EPL or PDFA4 or PDFA4Consolidated or PDFConsolidated or PNG</MimeFormat>
            <MimeData>base64Binary</MimeData>
          </Label>
        </LabelData>
      </GetReturnLabelResult>
    </GetReturnLabelResponse>
  </soap12:Body>
</soap12:Envelope>