All Collections
How to connect BRT API to ShippyPro
How to connect BRT API to ShippyPro
Updated over a week ago

Here's how to connect your BRT account with Disk B solution (API) to ShippyPro in just a few steps.

Through our BRT connection you will be able to create the final label of the Carrier, without having to generate it again as with the Disk C solution.

The BRT API label will produce a Parcel ID: once the label has been read and confirmed by the Carrier, this will create the final tracking that will be automatically acquired by ShippyPro via API. πŸš€

πŸ“Œ Orders merged via Merge Orders will not be able to receive evening tracking.

Let's see how to proceed immediately. πŸ”Ž


1. Before you start

To connect the BRT carrier to your ShippyPro account, additional activation is required.

  • BRT Client Code

  • The Starting Deposit: this field refers to the branch code, usually represented by the first three digits of your Customer Code.

  • Your referent's email address

  • If you want the transmission of shipments to happen Automatically or Manually (Explicit).

  • The Automatic Confirmation Mode allows you to immediately transmit the shipping information, the Close Work Day is therefore performed automatically once the shipment has been created.

  • The Manual Confirmation Mode (Explicit) allows you to transmit the information to the Carrier at a later time by manually completing the Close Work Day.

πŸ“ŒIf the sandglass remains above the Carrier icon in the Shipped Orders section, make sure that you selected the correct confirmation method requested by the carrier at the time of activation, as our configuration must match the one set by the carrier.

We will contact your referent, you won't have to do anything else! πŸ™Œ

As soon as we receive confirmation we will notify you via email.

2. Connect BRT to ShippyPro

Once you receive the confirmation via email, you should already find the fields in the connection menu correctly filled in with the reference credentials in Carriers > BRT > Edit.

Network 🌐

You will find different Networks based on the destinations. The Tariff Code you enter (3-digit code provided by the Carrier) must correspond to the selected Network:




DPD - Out of Europe

πŸ“Œ Please note: the multi-parcel DPD EuroExpress Network includes a maximum of 5 parcels per shipment.

πŸ“Œ Please note: DPD tracking for shipments to Europe cannot be obtained via API. But do not worry! With BRT tracking you can also track shipments made with the DPD network.

Type of service

From the menu, select the service you will use:

Default = standard service
β€‹β€˜E’ = priority service
β€‹β€˜H’ = 10:30 service
β€‹β€˜H’ = Distribution

Confirm shipment πŸ“¦

With this option you can choose whether to perform a Manual or Automatic Close Work Day.

If you want to activate Manual or Automatic transmission, you need to ask the office you refer to for confirmation and, once you have received confirmation, select it from the ShippyPro connection menu:

πŸ“Œ Please note: automatic transmission is the simplest and fastest method for transmitting your orders to the Carrier, but remember that it doesn't allow to make any edits.

Therefore, once the shipping information has been transmitted, it will not be possible to apply changes. As an alternative, you can create a Manual Shipment.

How do you manually perform the Close Work Day? 🚚

To proceed, select the shipments for which to perform the Close Work Day and click on Carriers > Close Shipments:

Once the Close Work Day has been completed Manually, follow these steps to create the Manifest:

Management of delivery details (optional)

Using this option you can enter the Contingent Collection option for your orders.

If you like, you can create a separate connection dedicated exclusively to Contingent Collections.

Label type πŸ–¨

Finally, select in which format to create your labels. You can choose between PDF and ZPL.

Want to know more about it? Find out how to print labels in both formats by following our special guides:

Flip label orientation vertically is the option that allows you to turn your labels 180 degrees, making your printing process even easier!

How can I print 8 BRT API labels on a single A4 sheet?

You can print 8 BRT labels on a single A4 sheet by selecting your orders from the Shipped Orders section and clicking on Print BRT A4 8 labels.

πŸ“Œ Please note: at the moment BRT does not offer the possibility to add a Notes field on the label.
πŸ“Œ The Address 1 field has a limited space of 35 characters.

3. Additional options

SMS and Email to recipient πŸ“¬

Select Send SMS and Email to recipient to activate notifications to your customers, and the isAlertRequired option.

POD ✍️

You can enable Proof of Delivery by selecting the Enable POD (contact BRT first to enable it) option and asking your BRT referent for the FTP credentials shown immediately after enabling it.

Then select the Assign to date option from the Carrier Options when creating the shipment.

You can also apply the same option via API by inserting it into the Ship call:

"CarrierOptions": [ { "name": "brtassegnoadata", "value": "1" } ]

Returns from Fermopoint 🏬

To use the service, you will first have to have this option enabled by the Carrier, then select the list of BRT services from Carriers > Connection > BRT > Edit the "Return from shop" field and enter the "Return depot" agreed with the Carrier.

Some rules to consider to ship to and from Fermopoints:

  • Weight less than 20 Kg

  • Volume less than 0.2 m3 (longest side less than 1m)

  • Shipments must not be Cash on Delivery or collected invoice

  • They must not have any special delivery instructions (e.g. telephone contracts)

  • Email or "mobile" telephone number of the recipient or sender of the return are required

Various Particularities Management Code

If it is necessary to complete the field:

"various_particularities_management_code", you can proceed directly via the Carrier Options:

4. Rates 🚚

At this point you will need to enter your weight and price lists.

Don't know how to do it? Follow the steps indicated in this guide carefully:

If you use more than one BRT price list, no problem! You will be able to add a new connection for each tariff. ✨

To do this, you don't need to add your BRT credentials again.

Click on the BRT icon again to connect it. Inside the pop up, click on the search bar: Select from a carrier already entered and choose the connection with the same credentials you previously connected.

⚠ Remember, entering the rates is a mandatory step, without them you will not be able to use the service on ShippyPro.

5. Carrier Options βš™οΈ

You can decide to apply an additional option for your shipment at any time by clicking on Carrier Options before selecting the BRT API service.

Below you will find a list of integrated Options:


Assign to Date (only with BRT's authorization on your Account)

Delivery by appointment

Delivery on floor

Delivery to Neighbour

Requested Date

PIN Code (only with BRT's authorization on your Account)

BRT PUDO Fermo PointπŸ“

The Fermo Point solution for BRT is available on ShippyPro, exclusively supported by the REST API solution.

Below you will find the steps required to select the Point:

  • With APIs, it is possible to indicate the FermoPoint ID directly among the CarrierOptions in the Ship call.

  • However, it is possible to select a Fermo Point when creating the shipment in To Ship via the Carrier Options or by selecting it from the map, having previously enabled BRT from the Live Checkout settings on ShippyPro.

πŸ“Œ Remember, shipments via FermoPoint have the following restrictions:

  • Maximum actual kilograms supported: 20 kg

  • Maximum volume supported: 0.2 m3

  • Cash on Delivery is not supported

  • The recipient's telephone number is mandatory

πŸ“Œ The FermoPoint label contains the Company Name and not the name of the recipient.

Find out more about how PUDOs work with BRT by clicking here! 🌍

Pickups 🚚

We offer you the possibility to schedule a pickup with BRT directly from ShippyPro! πŸš€

Find out how by consulting this guide:

How can I track my shipments correctly? πŸ”Ž

  1. The code shown in Shipped Orders represents the 15-digit package ID, automatically created by the Courier.

  2. The tracking number transmitted via our emails consists of 18 characters. BRT first generates an 18-digit code and then updates the tracking to a 12-digit code. This explains the difference between the information available on their site and ShippyPro.

    πŸ“Œ If the order is not present on our portal and there is no connected marketplace, it will not be possible to update it with the second tracking number. In this case, you should create the marketplace on the platform, import the orders (or create them with the PutOrder API) and then ship them using the marketplace order number.

πŸ“Œ Magento does not support our Track & Trace updates, for this reason you will not find them on the marketplace.

How can I use LabelFormat DP5 (infeed mode)? 🏷

To use the LabelFormat DP5, remember that you will have to print the label for the Network DPD.

First of all, it is necessary to ask BRT to activate the DPD INFEED service for the LabelFormat DP5 to work.

After that, if you don't already have it, we recommend adding a new BRT connection with the correct Network without modifying the existing one, and setting the ZPL format, the only one supported using these settings.

In short, create a new BRT connection considering the two parameters below:

Network: DPD

Label type: ZPL

Returns πŸ“¦

To proceed with returns, first select the Return From Shop option from the additional services menu in Carriers > Connection > BRT > Edit:

Then add the 3-digit branch code in the Return Deposit field.

You can then start shipping your returns by following the steps in this guide.

πŸ“Œ If the label you get has a duplicated sender's name on it please get in touch with your BRT representative in order to ask them that the sender name on the label is chosen from originalSenderCompanyName when using return from shop.

6. Useful information:

  • Remember, shipments via DPD (BRT EU) can only be single parcel.

  • It will therefore be necessary, in the case of orders with multiple packages, to create multiple shipments or API calls.

    For Euroexpress, Multi-Collection calls are available for up to a maximum of 5 parcels.

  • On the BRT side, shipments transmitted but not entrusted will remain for a maximum period of 7 calendar days, including the day of creation.

    Afterwards the Carrier will delete them from their systems, so if the package is still with the Sender it will be necessary to create a new label.

⚠️ From 02:00 to 06:30 on Sundays it is possible that the Carrier performs maintenance on its servers, so it may not be possible to create shipments.

For further information on this you can contact your BRT sales referent.

  • If you receive the error ''Error in calculating Wrong (or Nonexistent) ZIP code routing'':

    • for shipments to Ireland, remember to add the EIRE value in the Zip Code field. You'll be able to enter the real Zip Code in the Address 2 field.

    • for shipments to Monaco, please ensure that you have entered Monaco (and not France) as destination country.

  • If the Company Name field is filled in, this will overwrite the Name field and the customer's name will not be visible on the label. The recipient's name will still be sent to the carrier, but it will not be visible on the shipping label.

  • N.B. BRT does not carry out any checks on the data entered in Address 1 and Address 2, therefore, any information present in these fields will be transmitted to the carrier without returning any errors. BRT carries out checks only on the following fields: City, Postcode, Province.

  • If you receive an email from us instructing you to send your orders to the carrier at the end of the day, but you are sure you have already done so, it is possible that you have separate ShippyPro profiles connected to the same BRT account. If this is the case, you must check the type of confirmation (automatic or explicit) set within the relevant connections in all your ShippyPro accounts. If one of these has orders to be transmitted manually, the notification email is sent to all accounts without making distinctions. We also recommend contacting your BRT referent to check the shipment closing method for all profiles and that there are no shipments to close.

  • If you use diskB BRT services via FTP through the Amazon portal, please note that it is not possible to use the API (this means that the carrier will not receive the shipping data).

πŸ” What's Next?

Did this answer your question?