CreateShipmentReturn Grouping Method
This method allows the creation of a shipment and return label, both with or without a consignment note.
Input Parameters
Field Name | Type | Required? | Description |
---|---|---|---|
authData | AuthData | Yes | Authorisation structure |
serviceType | string | Yes | Service type, possible values: ZC Connect Return ZK Domestic Return |
shipmentInfo - billing information | |||
wayBill | string | Nie | Shipment waybill number |
bookCourier | string | Yes | The option of shipping a return shipment with a courier collection |
billing - billing information | |||
shippingPaymentType | string | Yes | Identification of the party to be charged, possible options: RECEIVER - receiver |
billingAccountNumber | integer | Yes | Customer number to be charged |
paymentType | string | Yes | Payment method selection, possible values: BANK_TRANSFER - bank transfer (only for customers with an agreement and SAP number) |
costsCenter | string(20) | No | Cost centre |
specialServices - ordering special services | |||
serviceType | string | No | Special service type, possible values: UBEZP - Shipment insurance - only for domestic shipmentsadditional fees apply |
serviceValue | float | No | Declared value required when ordering the insurance services |
textInstruction | string(32) | No | Name of the return document in the ROD service |
collectOnDeliveryForm | string | No |
Form of the collection amount refund in the COD service, possible values: BANK_TRANSFER - bank transfer (only for customers with an agreement and SAP number) |
shipmentTime - information on the parcel shipment time | |||
labelExpDate | string | Yes | label expiry date |
labelType | string | - | Return label selection, possible values: BLP - BLP label in PDF format LBLP - LBLP label in PDF A4 format ZBLP - BLP label in the format used by Zebra printers ZBLP300 - BLP 300dpi label in the format used by Zebra printers If you use a laser printer – label generated in PDF file – BLP parameter If you use a Zebra thermal printer - label generated in zpl file – ZBLP or ZBLP300 parameter QR_PDF - kod QR w formacie PDF dla przesyłki ZK QR2_IMG - kod QR w formacie PNG o wymiarach 2cm x 2cm dla przesyłki ZK QR4_IMG - kod QR w formacie PNG o wymiarach 4cm x 4cm dla przesyłki ZK QR6_IMG - kod QR w formacie PNG o wymiarach 6cm x 6cm dla przesyłki ZK |
content | string(30) | Yes | Content of the parcel |
comment | string(100) | No | Additional comments to be printed on the consignment note. |
reference | string(20) | No | Shipment reference number |
primaryWaybillNumber | string | No | Original shipment number |
shippingPaymentType | string | Yes | Identification of the party to be charged, possible options: RECEIVER - receiver |
billingAccountNumber | integer | Yes | Customer number to be charged |
shipper and receiver - address details of the sender and recipient | |||
country | string(2) | Yes | Recipient’s country |
isPackstation | bool | No | Delivery to DHL Parcelstation |
isPostfiliale | bool | No | Delivery to DHL Parcelshop |
postnummer | string(10) | No | Customer number - required only for DE with deliveries to parcel lockers |
name | string(60) | Yes | Name (first name and surname or company name) |
postalCode | string | Yes | Postal code |
city | string(17) | Yes | Town/city |
street | string(35) | Yes | Street |
houseNumber | string(10) | Yes | House number The sum of characters in the "apartmentNumber" and "houseNumber" fields shall not exceed 15 characters. |
apartmentNumber | string(10) | No | Apartment number The sum of characters in the "apartmentNumber" and "houseNumber" fields shall not exceed 15 characters. |
pre-delivery notification and contact - details for pre-delivery notification / contact | |||
personName | string(50) | No | Name of contact person |
phoneNumber | string(9) | No | Phone number (9 digits) |
emailAddress | string(60) | No | E-mail address |
pieceList - shipment parcel data | |||
type | string | Yes | Parcel type, possible values: ENVELOPE - envelope shipment PACKAGE - parcel |
weight | integer | Yes | Weight of the parcel (in kilograms), not required for type = ENVELOPE |
width | integer | Yes | Width of the parcel (in centimetres), not required for type = ENVELOPE |
height | integer | Yes | Height of the parcel (in centimetres), not required for type = ENVELOPE |
length | integer | Yes | Length of the parcel (in centimetres), not required for type = ENVELOPE |
quantity | integer | Yes | Quantity of parcels of this type |
nonStandard | bool | No | Indication that the parcel is non-standard (true / false) |
blpPieceId | string(32) | No | Parcel ID (JJD) for BLP label (for customers with their own numbering) |
Output Parameters
Field Name | Type | Required? | Description |
---|---|---|---|
shipmentNotificationNumber | 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
<authData> <username>testan</username> <password>testington</password> </authData> <shipment> <shipmentInfo> <wayBill>12345678910</wayBill> <serviceType>ZC</serviceType> <bookCourier>true</bookCourier> <billing> <shippingPaymentType>RECEIVER</shippingPaymentType> <!-- określenie strony, która zostanie obciążona kosztami, możliwe opcje serviceType: RECEIVER - płaci odbiorca --> <billingAccountNumber>1204663</billingAccountNumber> <paymentType>BANK_TRANSFER</paymentType> <!-- wybór sposobu płatności, możliwe wartości paymentType: BANK_TRANSFER - przelew (tylko dla klientów z umową i numerem SAP) --> <costsCenter>ABC1235</costsCenter> </billing> <specialServices> <item> <serviceType>INSUR</serviceType> <serviceValue>20000</serviceValue> </item> </specialServices> <shipmentTime> <labelExpDate>2017-07-31</labelExpDate> </shipmentTime> <labelType>BLP</labelType> <!-- wybór etykiety zwrotnej, możliwe wartości labelType: BLP - etykieta BLP w formacie PDF LBLP - etykieta BLP w formacie PDF A4 ZBLP - etykieta BLP w formacie drukarek Zebra --> </shipmentInfo> <content>Computer game</content> <comment>handle with care</comment> <reference>REF TESTREF TESTSTOP</reference> <primaryWaybillNumber>order no.</primaryWaybillNumber> <ship> <shipper> <preaviso> <personName>3e General Partnership</personName> <phoneNumber>123456789</phoneNumber> <emailAddress>testomir@gmail.pl</emailAddress> </preaviso> <contact> <personName>3e General Partnership</personName> <phoneNumber>123456789</phoneNumber> <emailAddress>testomir@gmail.pl</emailAddress> </contact> <address> <country>CZ</country> <name>Janek</name> <postalCode>50011</postalCode> <city>Test</city> <street>Test</street> <houseNumber>9</houseNumber> <apartmentNumber>59</apartmentNumber> </address> </shipper> <receiver> <preaviso> <personName>3e General Partnership</personName> <phoneNumber>123456789</phoneNumber> <emailAddress>testomir@gmail.pl</emailAddress> </preaviso> <contact> <personName>3e General Partnership</personName> <phoneNumber>123456789</phoneNumber> <emailAddress>testomir@gmail.pl</emailAddress> </contact> <address> <country>PL</country> <name>Me</name> <postalCode>00001</postalCode> <city>Wawa</city> <street>Lesna</street> <houseNumber>9</houseNumber> <apartmentNumber>59</apartmentNumber> <postnummer>123456789</postnummer> <isPackstation>false</isPackstation> <isPostfiliale>false</isPostfiliale> </address> </receiver> </ship> <pieceList> <item> <type>PACKAGE</type> <!-- typ paczki, możliwe wartości: ENVELOPE - przesyłka kopertowa PACKAGE - paczka --> <weight>20</weight> <width>60</width> <height>40</height> <length>40</length> <quantity>1</quantity> </item> </pieceList> </shipment>