Scope
This guide will help you configure your existing BoxNow integration so that you can also generate BoxNow vouchers for Orders received through the Jinius Marketplace.
Prerequisites
- The BoxNow integration for the Jinius Marketplace is currently only available for non-Cypriot Business.
- This guide assumes you already have the integration with BoxNow configured and outlines the small adjustments you need to make to be able to use with the Jinius Marketplace.
- Jinius will provide the required BoxNow API credentials linked to the Jinius account, which 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 to some information:
-
Order ID
-
shipping_pudo_id
This value can be found either from the Jinius Seller UI in the Order details.
Alternatively, it can be be retrieved via API using the Mirakl OR11 request.
Note that in this request you can useshipping_type_code = BOXNOW-LOCKERto specifically retrieve BoxNow orders.
This field contains the BoxNow locker ID selected by the customer during checkout and must be passed to BoxNow when creating the shipment.
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 Order Number is required both for reconciliation between the BoxNow shipment/waybill and the corresponding Jinius Marketplace order, and to ensure it is available on the printed voucher for reference.
Update Tracking Information in Mirakl
After the BoxNow shipment has been successfully created:
Retrieve the generated BoxNow tracking/waybill number.
Update the carrier tracking information for the relevant Mirakl order using the OR23 request, or via the Jinius Seller UI.
The tracking number will then 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 |