Meta API Live shipment call and response
Shipment Service
-
General
CALL
Method:
- POST
URL:
Parameters:
- LabelPrintFormat PDF / ZPL
- LabelPaperFormat A6 / A4
- LabelPrinterStartPosition LOWER_LEFT / UPPER_LEFT / LOWER_RIGHT / UPPER_RIGHT
- debug true
Authorization:
- X_DPD_TOKEN Bearer Token from login service (326-digits)
-
B2B
CALL
Body:
- Object JSON (raw)
[ { "shipmentInfos": { "productCode": "101" }, "numberOfParcels": "1", "sender": { "address": { "name1": "Sender name 1", "name2": " Sender name 2", "country": "BE", "zipCode": "2800", "city": "Mechelen", "street": "Egide Walschaertstraat 20" } }, "receiver": { "address": { "name1": "DPD Hub", "country": "BE", "zipCode": "1800", "city": "Vilvoorde", "street": "Tyraslaan" }, "contact": { "contactPerson": "Mrs Mdm", "email": "contact@dpd.be" }, "comment": "TEST for META API" }, "parcel": [ { "parcelInfos": { "weight": "5000" } } ] } ]
RESPONSE
Body:
- shipmentID MPSID
- parcelId Labelnumbers
- label – base64Data string converting to PDF or ZPL
-
Return
CALL
Body:
- Object JSON (raw)
[ { "shipmentInfos": { "productCode": "332" }, "numberOfParcels": "1", "sender": { "address": { "name1": "Sender name 1", "name2": " Sender name 2", "country": "BE", "zipCode": "2800", "city": "Mechelen", "street": "Egide Walschaertstraat 20" } }, "receiver": { "address": { "name1": "DPD Hub", "country": "BE", "zipCode": "1800", "city": "Vilvoorde", "street": "Tyraslaan" }, "contact": { "contactPerson": "Mrs Mdm", "email": "contact@dpd.be" }, "comment": "TEST for META API" }, "parcel": [ { "parcelInfos": { "weight": "5000" } } ] } ]
RESPONSE
Body:
- shipmentID MPSID
- parcelId Labelnumbers
- label – base64Data string converting to PDF or ZPL
-
B2C Home
CALL
Body:
- Object JSON (raw)
[ { "shipmentInfos": { "productCode": "327" }, "numberOfParcels": "1", "sender": { "address": { "name1": "Sender name 1", "name2": "Sender name 2", "country": "BE", "zipCode": "2800", "city": "Mechelen", "street": "Egide Walschaertstraat 20" } }, "receiver": { "address": { "name1": "DPD Hub", "country": "BE", "zipCode": "1800", "city": "Vilvoorde", "street": "Tyraslaan" }, "contact": { "contactPerson": "Mrs X", "email": "test@dpdgroup.com" }, "comment": "RMP TEST for META API" }, "parcel": [ { "parcelInfos": { "weight": "6000" }, "messages": [ { "messageType": "EMAIL", "messageDestination": "test@dpdgroup.com" } ], "senderParcelRefs": [ "P_2022-02-09_04" ] } ] } ]
RESPONSE
Body:
- shipmentID MPSID
- parcelId Labelnumbers
- label – base64Data string converting to PDF or ZPL
-
B2C Shop
CALL
Body:
- Object JSON (raw)
[ { "customerReferenceNumbers": [ "S_2022-02-09_09" ], "shipmentInfos": { "productCode": "337" }, "sender": { "address": { "name1": "DPD BE SENDER", "street": "Egide Walschaertsstraat 20", "country": "BE", "zipCode": "2800", "city": "Mechelen" } }, "receiver": { "pudoId": "BE10068", "address": { "name1": "DPD BE RECEIVER", "street": "Rue de Liege 25", "country": "BE", "zipCode": "6180", "city": "Courcelles" }, "contact": { "phone1": "0123456789", "email": "test@dpdgroup.com", "contactPerson":"DPD Contact" } }, "numberOfParcels": "1", "parcel": [ { "parcelInfos": { "weight": "6000" }, "messages": [{ "messageType": "SMS", "messageDestination": "0123456789" }], "senderParcelRefs": [ "P_2022-02-09_09" ] } ] } ]
RESPONSE
Body:
- shipmentID MPSID
- parcelId Labelnumbers
- label – base64Data string converting to PDF or ZPL
-
Express / B2B Predict
By changing the product code and adding the mandatory fields to a standard B2B call, the request changes accordingly:
- Express 10 = productcode E10
- add recipient phone number and contact
- Express 12 = productcode E12
- add recipient phone number and contact
- Express 18 = productcode E18
- add recipient phone number and contact
- B2B Predict = productcode B2B MSG OPTION
- add messageType and messageDestination
Example: “messages”: [ { “messageType”: “EMAIL”, “messageDestination”: “test@dpdgroup.com” } ]
- Express 10 = productcode E10