GetReturnByWaybill Method

This method allows the creation of a shipment and return label after providing a consignment note.

Input Parameters

Field Name	Type	Required?	Description
authData	AuthData	Yes	Authorisation structure
itemsToPrint	array	Yes	Array of ItemToPrint type structures (maximum of three structures)

Output Parameters

Field Name	Type	Required?	Description
shipmentNotificationNumber	string	-	Parcel ID
waybill	string	No	Parcel waybill number
shipmentTrackingNumber	string	-	Parcel ID
dispatchNotificationNumber	string	-	Order ID (if courier is booked)
labelType	string	-	Return label type
labelFormat	string	-	MIME label format
labelContent	string	-	Label content (encoded in base64)

Examples of Calls

<getReturnByWaybill>
   <authData>
      <username>testan</username>
      <password>testington</password>
   </authData>
   <itemsToPrint>
        <item>
            <labelType>BLP</labelType>
            <shipmentId>11122221111</shipmentId>
            <waybill>12345678910</waybill>
        </item>
        <item>
            <labelType>ZBLP</labelType>
            <shipmentId>11122221111</shipmentId>
            <waybill>12345678910</waybill>
        </item>
        <item>
            <labelType>ZBLP300</labelType>
            <shipmentId>11122221111</shipmentId>
            <waybill>12345678910</waybill>
        </item>
        <item>
            <labelType>CN</labelType>
            <shipmentId>11122223333</shipmentId>
            <waybill>12345678910</waybill>
        </item>
   </itemsToPrint>
</getReturnByWaybill>

Go back to topic list