How to connect BRT API to ShippyPro

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.

Kindly note that the old Bartolini connection (Disk C) has been discontinued and is no longer available on ShippyPro. Previously known as SOAP or FTP, the old connection has been replaced by a new API-based connection, which is now the only one integrated with ShippyPro.

 

Let's see how to proceed immediately. 

 

Summary:

  1. Before you start

  2. Connection steps

  3. Supported services

  4. Additional options

  5. Specific requirements

  6. International shipments

  7. Troubleshooting & Errors

1. Before you start

Select the BRT Logo from the Carriers section and if you have already requested your REST API credentials from BRT, flag "I have already requested activation" and go straight to step 2. of this guide!

On the other hand, if you want to connect BRT to your ShippyPro account for the first time and you don't have the credentials yet follow the steps below.

From the Carriers section click on the BRT Logo and flag the "I have to request activation" option:

Fill out the form that will open by entering the required information and then click Send to send the request to BRT:


  • Your BRT sales representative email address
  • BRT Customer Code

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

  • If you want the transmission of shipments to happen Automatically or Manually (Explicit). See an explanation of these options under the chapter Specific Requirements

 

We will send your BRT contact person the request and you will be copied into the conversation with the Carrier and, as soon as BRT accepts the request, you will receive confirmation directly via email.

2. Connection steps

Once you receive the confirmation via email, you can fill in the credentials you obtained from BRT in ShippyPro section Carriers > BRT

 

Here’s how you can fill in the fields in the connection module:

 

 

Username: your BRT account number

Codice cliente ritiro: this field is optional, please fill it in in case you book pickups through ShippyPro. For more information, see this chapter

Password: the password provided by your BRT sales representative after they’ve completed the activation process. Please make sure that there are no spaces!

Deposito di partenza: the first 3 digits of your Customer Code

Label type: select in which format to create your labels. You can choose between PDF and ZPL.

 

DP5 format is only compatible with Network DPD, Direct infeed service. To use this service, please proceed making a separate connection with this type of label and Network DPD.

 

If you want, you can flag the option Flip label orientation vertically to turn your labels 180 degrees, making your printing process even easier!

3. Supported services

 

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:

Italy

DPD

EuroExpress

DPD - Out of Europe

 

Particularities


The multi-parcel DPD EuroExpress Network includes a maximum of 5 parcels per shipment.

DP5 label format - DPD Direct infeed

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.

 

WRONG OR INCONSISTENT DATA Direct Infeed DPD not allowed for SenderCustomerCode


If you receive this error when applying the ZPL DP5 format in your DPD connection, it is possible that this option is not present in your BRT contract. Therefore please check with your BRT contact person whether this service is active. Remember that this option is only valid for the ZPL print format.

 

Type of service

From the menu, select the service you will use:

Standard service

Priority service

10:30 service

Distribution

4. 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" } ]

 

Printing labels options

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.

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.

Returns

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

Then add the Return Depot Code provided by BRT 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.

 

How can the customer book a pickup of a return shipment?

If you have chosen in the Easy Return rules to charge the return shipping costs to your company and not to the end customer, you can show the button to book the pickup in the email with the return instructions. Simply go to Easy Return > Email Template > Vendor Charged and click on "Show Book Pickup Button".

If the option is flagged the customer fills out a return request form which goes directly to BRT, if it is not flagged the customer will be asked to call BRT to book a pick-up.

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 > 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

 

Carrier options

Below you will find a list of integrated Options:

FermoPoint

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.

 

BRT PUDO FermoPoint is not yet available for international shipments in the European network.

 

particularitiesDeliveryManagementCode (Contingent Collection

If you wish to create a shipment with Contingent Collection, you can use the Carrier Option particularitiesDeliveryManagementCode with the code 'RC':

​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.

 

Particularities Hold On Stock Management Code

You can use this Carrier Option to provide specific instructions on how to manage stock holdings with the carrier by entering the desired reason code.:

Pickups

In order to make a pickup with BRT, you must go to Carriers > BRT > Edit and enter the Pickup Account Number, which is provided by BRT, in the connection module.

It consisting of your customer code + a 3-digit sequence.

Once the connection module has been updated, follow this guide to proceed with the schedule of a pickup. 

5. Specific requirements

Rates

BRT does not transmit Live Rates to ShippyPro. If you’re interested in comparing prices, it is therefore mandatory to enter your zones, weight and price lists.

ShippyPro automatically inserts main zones, generic weights and adds the prices in 0 (zero) amount. You will be able to ship with BRT even though you leave the prices in 0, it will not affect your contract with the carrier.

 

Follow the next steps only in case you want to compare prices with other carriers.

Follow the steps indicated in this guide carefully: How to set Carrier Rates

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.

If you wish to change the estimated delivery days shown when choosing the Carrier, you can do so by editing the values of the fields “Delivery days - min” and “Delivery days - max” from Carriers > BRT > Edit Prices.

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 BRT office you refer to for confirmation and, once you have received confirmation, select it from the ShippyPro connection menu:

 

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.

 

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.

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.

 

Tracking

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.

 

Good to know 💡

 

  • Orders merged via Merge Orders will not be able to receive evening tracking.

  • 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.

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

  • If the status of your in-transit shipments is still ‘Unknown’ (or ‘No Events Yet’) in the platform, check that the credentials entered in the BRT connection are correct and that the End of Day setting is aligned with what you previously agreed with the Courier (Manual or Automatic)

 

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

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 connect the marketplace on the platform, import the orders (or create them with the PutOrder API > API folder) and then ship them using the marketplace order number.

​6. International shipments

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, Multiparcel shipments are available for up to a maximum of 5 parcels.

7. Troubleshooting & errors

If you're experiencing any issues with BRT connection or label creation, please visit this link with the most frequently asked questions and troubleshooting: How to fix BRT errors (Italian only)