Tradera Developer Program

OrderService

Documentation Version 3 > OrderService > GetFreightLabels

GetFreightLabels |WebMethod|

Get freight labels by their order id. The freight labels are pdfs encoded as BASE64 strings. Will only return freight labels for the authorized user.

Returns

The GetFreightLabelsResponse that contains zero or more freight labels.

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 /v3/orderservice.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tradera.com/GetFreightLabels"

<?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:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <AuthorizationHeader xmlns="http://api.tradera.com">
      <UserId>int</UserId>
      <Token>string</Token>
    </AuthorizationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap:Header>
  <soap:Body>
    <GetFreightLabels xmlns="http://api.tradera.com">
      <request>
        <OrderIds>
          <int>int</int>
          <int>int</int>
        </OrderIds>
      </request>
    </GetFreightLabels>
  </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>
    <GetFreightLabelsResponse xmlns="http://api.tradera.com">
      <GetFreightLabelsResult>
        <FreightLabels>
          <FreightLabel>
            <OrderId>int</OrderId>
            <FreightLabelContent>string</FreightLabelContent>
          </FreightLabel>
          <FreightLabel>
            <OrderId>int</OrderId>
            <FreightLabelContent>string</FreightLabelContent>
          </FreightLabel>
        </FreightLabels>
      </GetFreightLabelsResult>
    </GetFreightLabelsResponse>
  </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 /v3/orderservice.asmx HTTP/1.1
Host: api.tradera.com
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:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <AuthorizationHeader xmlns="http://api.tradera.com">
      <UserId>int</UserId>
      <Token>string</Token>
    </AuthorizationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetFreightLabels xmlns="http://api.tradera.com">
      <request>
        <OrderIds>
          <int>int</int>
          <int>int</int>
        </OrderIds>
      </request>
    </GetFreightLabels>
  </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>
    <GetFreightLabelsResponse xmlns="http://api.tradera.com">
      <GetFreightLabelsResult>
        <FreightLabels>
          <FreightLabel>
            <OrderId>int</OrderId>
            <FreightLabelContent>string</FreightLabelContent>
          </FreightLabel>
          <FreightLabel>
            <OrderId>int</OrderId>
            <FreightLabelContent>string</FreightLabelContent>
          </FreightLabel>
        </FreightLabels>
      </GetFreightLabelsResult>
    </GetFreightLabelsResponse>
  </soap12:Body>
</soap12:Envelope>

XHTML CSS