Overzicht
De Shipment API op api.myparcel.nl dekt zendingen, labels, delivery options, track & trace en webhooks. Orders, adressen en printen hebben eigen API's.
De API-referentie op deze portal wordt gegenereerd uit de gepubliceerde OpenAPI-specs.
Stap 1 · Je API-key ophalen
Open na aanmelden Shopinstellingen → Integratie in de MyParcel-backoffice en kopieer de API-key.
Houd de key op je server. Stuur hem nooit naar de browser.
Stap 2 · Je requests authenticeren
Codeer de key in base64 en stuur hem in de Authorization-header van elke request:
Authorization: bearer <base64-gecodeerde API-key>
Zie Authenticatie voor voorbeelden in shell en PHP.
Stap 3 · Maak je eerste zending
Met de header op zijn plek roep je de Shipment API aan om een zending te maken. De response bevat het ID van de nieuwe zending, waarmee je het label ophaalt.
// POST https://api.myparcel.nl/shipments
// Content-Type: application/vnd.shipment+json;version=1.1;charset=utf-8
// Authorization: bearer <base64-gecodeerde API-key>
{
"data": {
"shipments": [
{
"carrier": 1,
"recipient": {
"cc": "NL",
"person": "J. de Vries",
"street": "Antareslaan",
"number": "31",
"postal_code": "2132JE",
"city": "Hoofddorp"
},
"options": {
"package_type": 1,
"signature": 1
}
}
]
}
}
Download daarna het label als PDF met GET /shipment_labels/{id}. Zie Zendingen voor de response en de labelopties.
Volgende stappen
Pak het pad dat bij jouw integratie past:
- Authenticatie: de key meesturen, en wat een
401betekent. - Delivery options: afhaalpunten, avondbezorging, handtekening.
- Webhooks: krijg een melding zodra een zending van status verandert of een label klaar is.
- PHP SDK / JavaScript SDK: sla de raw HTTP over en gebruik onze libraries.
- WooCommerce, Magento 2, PrestaShop of een andere e-commerce-plugin: installeren, instellen, klaar.