Get the paperwork of a parcel

If your OMS or WMS operates on carton values instead of consignment codes, you generate labels and customs documentation for a parcel instead of a consignment.

Get parcel paperwork request

You need the following to make a get parcel paperwork request.

Parameter Value Description
status ALLOCATED or
PRINTED or
READY TO MANIFEST		 The consignment lifecycle status.
consignmentCode The consignment identifier generated by Metapack when a consignment is created.
parcelCode The barcode of the parcel.

Using the Get parcel paperwork operation, complete the following steps:

  1. Enter the consignmentCode of the consignment.
  2. Enter the parcelCode of the parcel for which you want to generate paperwork.
  3. Use the query parameters to specify the desired paperwork type and format.

Example request

Copy
Copied
GET /shipping/v1/consignments/{consignmentCode}/parcels/{parcelCode}/paperwork?type=all&dimension=6x4&format=pdf HTTP/1.1
Host: api.metapack.com
API-Key: Basic Base64-encoded <username>:<password>
Content-Type: application/json

Get parcel paperwork response

200 (OK)

A successful response will include one or more paperwork strings, which are used to generate the specified paperwork.

A successful response means the following:

  • If the status of the consignment was ALLOCATED , generating the paperwork and then printing the label will change the status to READY TO MANIFEST . However, if the status of the consignment was ALLOCATED before the paperwork is generated but the label is not printed, the status will not change.
  • If the status of a consignment is PRINTED or READY TO MANIFEST before the paperwork is generated, the status will not change.

Related tasks