getCourierDocument
The method allows you to download a parcel document
Input parameters
Output data:
A sample request in PHP:
courier_code | varchar(20) | Courier code |
document_type | varchar(10) | Types:
manifest |
account_id | int | Courier API account id for the courier accounts retrieved from the request getCourierAccounts |
package_ids | array | Array of shipments ID, optional |
package_numbers | array | Array of shipments number (consignment number), optional |
Output data
The method returns the data in JSON format.
status | varchar(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 |
extension | varchar(4) | Document file extension (pdf, zpl, epl, html, etc.). |
document | text | Document encoded with base64 algorithm. |
Sample
Input data:Output data:
A sample request in PHP: