Get parcel paperwork

Retrieve the labels and customs documents of a specific parcel in an Allocated consignment.

Note: You can also use this operation if the consignment lifecycle status is Printed or Ready to manifest.

Tip: To generate the labels or documents from the strings included in a successful response, you must first decode the strings by using a Base64 encoder/decoder and then send them to a network printer.

SecurityBasicAuth
Request
path Parameters
consignmentCode
required
string

Consignment identifier generated by Metapack.

parcelCode
required
string

Parcel code.

query Parameters
type
string

Specify the type of paperwork to be generated. Select label to generate a labels string in the response. Select documentation to generate a customs (customs documentation) string in the response. Select all to generate a labels string and a customs string in the response. Select paperless to generate a paperless output string in the response. Select label-and-paperless to generate both label and paperless strings in the response. Select all-and-paperless to generate label, customs and paperless strings in the response.
Note: not all carrier services support paperless documents, please check with your Metapack contact.

Enum: "label" "documentation" "all" "paperless" "label-and-paperless" "all-and-paperless"
format
string

Specify the paperwork format to be generated. Select pdf to generate the customs string in PDF format. Select zpl to generate the labels string in Zebra Programming Language (ZPL) format. Select png to generate a label as a PNG file.

Enum: "pdf" "zpl" "png"
dimension
string
Default: "6X4"

Specify the dimensions of the document. Enter either a4 or the page dimensions in inches using mxn format, where m and n are either integers or decimal numbers. For example, 6x4.

resolution
integer
Default: 200

Specify the resolution of the label in dots per inch (DPI). Select 200 to generate the label in 200 DPI. Select 300 to generate the label in 300 DPI.

Enum: 200 300
Responses
200

Parcel paperwork strings

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict - Wrong state for printing

500

Internal Server Error

get/consignments/{consignmentCode}/parcels/{parcelCode}/paperwork
Request samples 
Response samples 
application/json
{
  • "paperwork": {
    },
  • "links": [
    ]
}