Retrieve Parcel Documents

GET {{baseUrl}}/parcels/:id/documents/:type?dpi=72&raw=<boolean>

For international shipments, a commercial invoice, CN23 or CN22 (+CP71) form must be attached (either physically or digitally for some carriers) to the shipment for customs officials to access. The type of document required depends on the shipping method and value of the shipment.

When you Create a parcel, Sendcloud generates the correct type of document for your shipment if you have filled in all the information related to the parcel contents, value, and invoice. Use this endpoint to retrieve these documents in your preferred format.

The supported document types are as follows:

  • air-waybill
  • cn23
  • cn23-default
  • commercial-invoice
  • cp71
  • label
  • qr

Request Params

KeyDatatypeRequiredDescription
dpinumberDPI refers to the printing resolution of your shipping labels. It's important that labels are printed at a high enough resolution to ensure the clarity of address details and the barcode for scanning purposes.
Use following amounts for appropriate result:
<table>
<thead>
&lt;tr&gt;
  &lt;th&gt;File format&lt;/th&gt;
  &lt;th&gt;Default DPI&lt;/th&gt;
  &lt;th&gt;Valid DPI&lt;/th&gt;
&lt;/tr&gt;

</thead> <tbody> <tr> <td>pdf</td> <td>72</td> <td>72</td> </tr> <tr> <td>zpl</td> <td>203</td> <td>203, 300, 600</td> </tr> <tr> <td>png</td> <td>300</td> <td>150, 300</td> </tr> </tbody> </table> | | raw | string | | There have been identified cases where custom documents, internally rendered, will only include some of the necessary information, mainly due to some restrictions. Using the raw query param, one can request to receive the document in the originally received format by the carrier. This temporary solution to the problem allows the normal operations of the affected customers. As such, you can expect this property to be sunsetted shortly once the necessary changes have been implemented. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

&quot;\u003cstring\u003e&quot;