bpost API library is a PHP library which permit to your PHP application to communicate with the bpost API.
composer require antidot-be/bpost-api-library/* Call the Composer autoloader */require'../vendor/autoload.php';
useBpost\BpostApiClient\Bpost;
useBpost\BpostApiClient\Bpost\Order;
useBpost\BpostApiClient\Bpost\Order\Address;
useBpost\BpostApiClient\Bpost\Order\Box;
useBpost\BpostApiClient\Bpost\Order\Box\AtBpost;
useBpost\BpostApiClient\Bpost\Order\Box\AtHome;
useBpost\BpostApiClient\Bpost\Order\Box\CustomsInfo\CustomsInfo;
useBpost\BpostApiClient\Bpost\Order\Box\International;
useBpost\BpostApiClient\Bpost\Order\Box\Option\Insured;
useBpost\BpostApiClient\Bpost\Order\Box\Option\Messaging;
useBpost\BpostApiClient\Bpost\Order\Line;
useBpost\BpostApiClient\Bpost\Order\PugoAddress;
useBpost\BpostApiClient\Bpost\Order\Receiver;
useBpost\BpostApiClient\Bpost\ProductConfiguration\Product;
useBpost\BpostApiClient\BpostException;
usePsr\Log\LoggerInterface;
$apiUrl = "https://api-parcel.bpost.be/services/shm/";
$apiUsername = "107423";
$apiPassword = "MyGreatApiPassword";
$bpost = newBpost($apiUsername, $apiPassword, $apiUrl);
/* We set the receiver postal address, without the name */$receiverAddress = newAddress();
$receiverAddress->setStreetName("Rue du Grand Duc");
$receiverAddress->setNumber(13);
$receiverAddress->setPostalCode(1040);
$receiverAddress->setLocality("Etterbeek");
$receiverAddress->setCountryCode("BE"); // ISO2/* We set the receiver postal address, without the name */$receiver = newReceiver();
$receiver->setAddress($receiverAddress);
$receiver->setName("Alma van Appel");
$receiver->setPhoneNumber("+32 2 641 13 90");
$receiver->setEmailAddress("alma@antidot.com");
$orderReference = "ref_0123456789"; // An unique order reference$order = newOrder($orderReference);
/** * A order line is an order item, like a article */$order->addLine(
newLine("Article description", 1)
);
$order->addLine(
newLine("Some others articles", 5)
);
/** * A box is used to split your shipping in many packages * The box weight must be littlest than to 30kg */$box = newBox();
/** * Available boxes for national box: * - AtHome: Delivered at the given address * - AtBpost: Delivered in a bpost office * - BpostOnAppointment: Delivered in a shop * * Available boxes for international box: * - International: Delivered at the given address */$atHome = newAtHome();
$atHome->setProduct(Product::PRODUCT_NAME_BPACK_24H_BUSINESS);
$atHome->setReceiver($receiver);
/* Add options */$atHome->addOption(
newInsured(
Insured::INSURANCE_TYPE_ADDITIONAL_INSURANCE,
Insured::INSURANCE_AMOUNT_UP_TO_2500_EUROS
)
);
$box->setNationalBox($atHome);
$order->addBox($box);We use the variables set before.
$bpost->createOrReplaceOrder($order); // The order is created with status Box::BOX_STATUS_PENDING$bpost->modifyOrderStatus($orderReference, Box::BOX_STATUS_OPEN);$order = $bpost->fetchOrder($orderReference);
$boxes = $order->getBoxes();
$lines = $order->getLines();$labels = $bpost->createLabelForOrder(
$orderReference,
Bpost::LABEL_FORMAT_A6, // $formatfalse, // $withReturnLabelstrue// $asPdf
);
foreach ($labelsas$label) {
$barcode = $label->getBarcode();
$mimeType = $label->getMimeType(); // Label::LABEL_MIME_TYPE_*$bytes = $label->getBytes();
file_put_contents("$barcode.pdf", $bytes);
}$labels = $bpost->createLabelForOrder(
$boxBarcode,
Bpost::LABEL_FORMAT_A6, // $formatfalse, // $withReturnLabelstrue// $asPdf
);
foreach ($labelsas$label) {
$barcode = $label->getBarcode(); // Can be different than $boxBarcode if this is a return label$mimeType = $label->getMimeType(); // Label::LABEL_MIME_TYPE_*$bytes = $label->getBytes();
file_put_contents("$barcode.pdf", $bytes);
}$labels = $bpost->createLabelInBulkForOrders(
array(
$orderReference1,
$orderReference2,
),
Bpost::LABEL_FORMAT_A6, // $formatfalse, // $withReturnLabelstrue// $asPdf
);
foreach ($labelsas$label) {
$barcode = $label->getBarcode(); // Can be different than $boxBarcode if this is a return label$mimeType = $label->getMimeType(); // Label::LABEL_MIME_TYPE_*$bytes = $label->getBytes();
file_put_contents("$barcode.pdf", $bytes);
}$geo6Partner = '999999';
$geo6AppId = 'A001';
$geo6 = newGeo6($geo6Partner, $geo6AppId);$points = $geo6->getNearestServicePoint(
'Grand Place', // Street name'3', // Street number'1000', // Zip code'fr', // Language: 'fr' or 'nl'3, // Point types: Sum of some Geo6::POINT_TYPE_*5// Points number
);
foreach ($pointsas$point) {
$distance = $point['distance']; // float/** @var Poi $poi */$poi = $point['poi'];
}/** @var Poi $poi */$poi = $geo6->getServicePointDetails(
200000, // Point ID'fr', // Language: 'fr' or 'nl'3// Point types: Sum of some Geo6::POINT_TYPE_*
);$url = $geo6->getServicePointPageUrl(
200000, // Point ID'fr', // Language: 'fr' or 'nl'3// Point types: Sum of some Geo6::POINT_TYPE_*
);You can read the CONTRIBUTING.md file