API documentation
Method list
Test your request

The method allows you to download a parcel protocol for selected shipments if the protocol is available for chosen courier

Input parameters
courier_codevarchar(20)Courier code
package_idsarrayArray of shipments ID, optional if package_numbers was provided
package_numbersarrayArray of shipments number (consignment number), optional if package_ids was provided
account_idintCourier API account id for the courier accounts retrieved from the request getCourierAccounts

Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
extensionvarchar(4)Protocol file extension (pdf, html).
protocoltextProtocol encoded with base64 algorithm.

Input data:
Output data:
A sample request in PHP: