Shipments

Fetch QR codes for a shipment

Fetches a QR code for a given shipment request. It is only possible to fetch QR codes for shipments booked with the QR code service.

get/shipments/{id}/qr_code

Request

  • Base URL
    https://sandbox.shipmondo.com/api/public/v3
  • URL
    https://sandbox.shipmondo.com/api/public/v3/shipments/{id}/qr_code
  • Auth
    HTTP basic

Path parameters

idinteger required

ID for the shipment to fetch QR codes for

Query parameters

file_format'png' | 'pdf'

The file format the QR Code will be returned as.

Response

Successful.

qr_codesstring[]

An array containing base64 encoded qr_codes

file_formatstring

The file format for response

Example response

{
  "qr_codes": [
    "JVBERi0xLjUKJc/s/+jXy80KMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI(...)PgpzdGFydHhyZWYKMzI0MgolJUVPRgo="
  ],
  "file_format": "png"
}

Changes

No recorded changes to this operation across all 17 revisions of this API.