Transcoding Code

What is the Transcoding Code?

The transcoding code is a “translator” that allows Qapla’ to correctly interpret the data coming from your CMS, only for:

  • Shopify
  • Prestashop
  • Magento
  • Magento 2

Often the name of a courier registered on your site (e.g., “Express Courier”) does not exactly match the identifier used by Qapla’ (e.g., “GLS-Italy”). Without transcoding, the system might assign the shipment to the wrong courier, preventing the correct import of the order or the tracking of the shipment.

What is it specifically used for?

  1. Pre-assignment for Order Import: Ensures that an order imported from the CMS is already associated with the correct courier.
  2. Pre-assignment for Shipment Import: Fundamental to import the shipment with the correct courier and follow the tracking progress.

To set it up, access your Qapla’ account in the section: Channels > [Channel Name] > Courier > [Courier Name] > Transcoding code

Attention!

  • The system only removes leading and trailing spaces from the value received from the platform (e.g., ” BRT ” becomes “BRT”).
  • If the code on the platform is “ROYAL MAIL” (space in the middle), enter the value in the transcoding code field exactly as it appears on the platform.
  • The comparison between the transcoding code and the value received from the platform is case-sensitive; for example, if the platform sends “Bartolini”, the code “BARTOLINI” will not match. Enter the code exactly as it appears on the platform.
  • Multiple values: If you need to enter multiple codes for the same courier, separate them with a comma and no spaces, example: BARTOLINI,BRT,BRT-IT

Transcoding codes on Shopify

It is possible to automatically import the pre-assigned courier on Shopify.
To properly configure this function go to: Channels > [Channel Name] > Import > Orders > Courier pre-assignment > Pre-assign courier importing it from Shopify

Set the transcoding codes:

Information: Qapla’ reads the value from the shipping_lines > code field. If this field is empty, it uses the shipping_lines > carrier_identifier field as an alternative.

  1. Check the orders on Shopify to analyze the shipping_lines > carrier_identifier > “code” field.
  2. Each value present in the “code” or “carrier_identifier” field corresponds to the courier code needed to associate with the couriers available on your channel/account.
    The courier code will need to be entered in the Transcoding code field in the courier configuration section.
  3. It is recommended to verify the actual import and the correct assignment of the courier on one or more orders after saving the configuration, to ensure that the value mapping is correct.

Transcoding codes on Prestashop

It is possible to automatically import the pre-assigned courier on Prestashop.
To properly configure this function go to: Channels > [Channel Name] > Import > Orders > Courier pre-assignment > Pre-assign courier importing it from Prestashop

Set the transcoding codes:

  1. Check the Carrier IDs present on your PrestaShop platform. Each carrier ID has a courier code.
  2. Each carrier ID configured and used on your platform needs to be associated with the couriers available on your channel/account.
    The courier code will need to be entered in the Transcoding code field in the courier configuration section.
    For example, if in PrestaShop the courier with ID 3 is named “Express Courier”, Qapla’ will look for a match with “Express Courier”. Therefore, enter the courier name in uppercase as the transcoding code, not the ID number.
  3. It is recommended to verify the actual import and the correct assignment of the courier on one or more orders after saving the configuration, to ensure that the value mapping is correct.

Transcoding codes on Magento and Magento 2

It is possible to automatically import the pre-assigned courier on Magento and Magento 2.
To properly configure this function go to: Channels > [Channel Name] > Import > Orders > Courier pre-assignment > Pre-assign courier importing it from Magento/Magento 2

It is possible to automatically import the chosen courier on Magento during checkout. However, in the case of Magento, this configuration requires some specific attention, since the platform does not return structured courier codes via webservice.
Unlike other platforms (e.g., PrestaShop), Magento does not provide a unique courier identifier via API, but transmits two generic text fields:

  • “shipping_method”, example: tablerate_bestway
  • “shipping_description”, example: Express courier

The “shipping_description” field represents the description visible to the customer during checkout, and it is not a unique code, but a simple string. This value can vary over time, based on the merchant’s configuration on Magento.
Multiple shipping methods (shipping_method) can correspond to different couriers, and it is not always possible to distinguish with certainty the courier actually selected.
Since these are free texts, the interpretation of the correct courier requires a specific mapping.
To properly configure this function:

  1. Analyze some real orders present on your Magento platform, so as to verify the values present in the “shipping_description” field.
  2. Based on what is found, it will be possible to proceed with the insertion in the Transcoding code field in the courier configuration section. If you wish to associate multiple strings, you can enter them separated by a comma, without spaces. Example: “Express courier,Standard shipping,GLS Courier”
  3. It is recommended to verify the actual import and the correct assignment of the courier on one or more orders after saving the configuration, to ensure that the value mapping is correct.

To import shipments from Magento/Magento 2
Qapla’ reads the “carrier_code” field of the shipment and automatically converts it to uppercase. If the “carrier_code” is “custom”, the `title` field is used (also in uppercase).

 

Need help?If you need assistance, contact Qapla’s Customer Care at support@qapla.it