Scope
This guide outlines the adjustments required to your existing BoxNow integration to enable the generation of BoxNow vouchers for orders received through the Jinius Marketplace.
Prerequisites
- The BoxNow integration for the Jinius Marketplace is currently available only to businesses based outside Cyprus.
- This guide assumes that you already have an existing BoxNow integration and outlines the adjustments required to make it compatible with the Jinius Marketplace.
- Jinius will provide the required BoxNow API credentials linked to the Jinius account. These credentials must be used when creating shipments for Jinius Marketplace orders.
For the complete BoxNow integration documentation, please refer to the official documentation here.
Integration Requirements
Retrieve the Order
Before creating the BoxNow voucher for a Jinius Order, you will need some information:
-
Order ID
The Jinius Marketplace order ID.
-
shipping_pudo_id
The BoxNow locker ID selected by the customer during checkout.
This value must be passed to BoxNow when creating the shipment. You can retrieve this value in either of the following ways:-
API: Retrieve the order using the Mirakl OR11 API request.
To retrieve BoxNow orders specifically, useshipping_type_code = BOXNOW-LOCKERas a filter -
Jinius Seller UI: Open the order details and locate the
shipping_pudo_idfield.
-
API: Retrieve the order using the Mirakl OR11 API request.
Creating the BoxNow Shipment
To create a voucher through the BoxNow API you use POST /api/v1/delivery-requests:
Use the BoxNow API credentials provided by Jinius.
Set the destination locker using the value received in
shipping_pudo_id.Include the Mirakl Order Number as the
orderNumberinPOST /api/v1/delivery-requests.Set
"paymentMode": "prepaid"Set the per parcel the
weight: [weight of parcel]Set
"allowReturn": trueto allow the customer to initiate a return using the initial voucher number.Include the Mirakl Order Number on the printed voucher by using the
overwriteSenderShippingLabelInfoparameter:"overwriteSenderShippingLabelInfo": { "row4": "string" }
Important:
The Jinius Marketplace Order Number must be used when creating the BoxNow shipment. It is required to link the BoxNow shipment/waybill to the corresponding Jinius order, ensure the order number appears on the printed voucher, and allow incoming webhooks to identify the correct order and update its status in Mirakl.
Update Tracking Information in Mirakl
Once the BoxNow shipment has been successfully created:
Retrieve the tracking/waybill number generated by BoxNow.
Update the tracking information for the relevant Mirakl order using the Mirakl OR23 API request, or directly through the Jinius Seller UI.
Once updated, the tracking number will be available to the customer through the Jinius Marketplace order tracking experience.
API Flow Summary
Step |
System |
API / Field |
Description |
1 |
Mirakl |
OR11 – List Orders |
Retrieve orders |
2 |
Mirakl |
shipping_type_code |
Identify BoxNow orders (BOXNOW-LOCKER) |
3 |
Mirakl |
shipping_pudo_id |
Retrieve customer-selected BoxNow locker |
4 |
BoxNow |
Create Shipment API |
Create waybill using Jinius BoxNow credentials |
5 |
BoxNow |
Tracking Number |
Receive BoxNow waybill/tracking number |
6 |
Mirakl |
OR23 – Update Tracking Information |
Update order with BoxNow tracking details |