1. ShipEngine
  2. ShipEngine Help Center
  3. ShipStation API Carriers

ShipStation API Carriers Italy

Avatar

ShipEngine Content Team

Updated

For ShipStation API accounts based in Italy, you have immediate access to BRT shipping labels with ShipStation API Carriers. There’s no need to create and connect individual carrier accounts. Activate ShipStation API Carriers by adding the billing method you wish to use to purchase your labels and add funds to your ShipStation API Balance.

Requirements

  • Activate ShipStation API Carriers in your ShipStation API Account (steps included in the following section)

  • Add funds to your ShipStation API Balance

    You can add funds using ShipStation API’s add_funds endpoint, which must first be enabled by the ShipStation API Support team. If you'd like to add funds via this endpoint, please submit a request to our support team.

Activate ShipStation API Carriers

To start using ShipStation API Carriers, you must activate it by adding the payment method you wish to use for your labels. Log in to ShipStation API and do the following:

  1. Select Carriers under the Dashboard section of the side navigation.

    Dashboard. Carriers section selected under ShipEngine Setup

  2. Click Connect ShipEngine Accounts

    CONN_ShipEngineCarrierAccts-ConnectShipEngineAcctsBTN_MRK.png

  3. Agree to the carriers' Terms of Service and click Continue.

  4. Add your billing information in the pop-up window, then click the Continue button.

You will now see your available carriers under Setup > Carriers, where you can also find their unique Carrier IDs. You can also make a List Carriers call to view all of your Carrier IDs and available services.

Setup_Carriers_CAEngineCarriers.png

Be sure to also add funds to your ShipStation API Balance so you can start purchasing your labels!

Connecting Your Own Carrier Accounts

You can also connect your own carrier accounts through the My Carrier Accounts section of the Carriers settings page.

Available Features for Italy ShipStation API Carriers

ShipStation API Carriers Italy supports the following standard features:

Key: Green checkmark. Supported feature. Yes. = Supported; Red X mark. Unsupported feature. No. = Not Supported; Grey dash icon. Not applicable. = Does Not Apply

Common Features

Feature

BRT IT from ShipStation API

Poste Italiane from ShipStation API

Domestic Shipping

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

International Shipping

Red X mark. Unsupported feature. No.

Red X mark. Unsupported feature. No.

Electronic Customs Submission

Grey dash icon. Not applicable.

ICON_greencheck.png

Return Labels

Red X mark. Unsupported feature. No.

Green checkmark. Supported feature. Yes.

Void Labels

Green checkmark. Supported feature. Yes.

Red X mark. Unsupported feature. No.

Estimated Rates

Red X mark. Unsupported feature. No.

Green checkmark. Supported feature. Yes.

Carrier Insurance

Green checkmark. Supported feature. Yes.

ICON_greencheck.png

Tracking

Red X mark. Unsupported feature. No.

Green checkmark. Supported feature. Yes.

End of Day (Electronic)

Red X mark. Unsupported feature. No.

Red X mark. Unsupported feature. No.

End of Day (PDF)

Red X mark. Unsupported feature. No.

Red X mark. Unsupported feature. No.

Label Branding

Red X mark. Unsupported feature. No.

Red X mark. Unsupported feature. No.

Label Messages

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

Multi-package Shipping

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

Multiple Accounts

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

Pick-up/Dropoff (PUDO

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

The carrier can be used to create domestic shipping labels.

The carrier can be used to create international shipping labels.

ShipStation API will submit international customs declarations electronically to the carrier.

The carrier can be used to create domestic return labels.

When an API call is made to the Rates endpoint, ShipEngine will return estimated shipping rates for the carrier based on the connected account information and shipment details.

Shipment insurance, provided by the shipment's selected carrier, can be added to the shipment in ShipStation API. This insurance would be in addition to any default coverage already provided by that carrier.

Shipping labels created for this carrier will include a tracking number that can be used to view the shipment status on the carrier's tracking website. Tracking may not be available for all shipping services.

Shipment manifests and End of Day documents are submitted electronically to the carrier by ShipEngine.

Shipment manifests and End of Day documents are generated as PDF files that can be printed along with shipping labels. Because these documents are not electronically submitted, physical copies must be provided to the carrier.

ShipEngine can print your brand logo on shipping labels from carriers that support this feature. Add your logo in the ShipEngine Dashboard.

ShipEngine can include additional information on a shipping label that is specified in the label request, if supported by the carrier.

This carrier can be used to create multi-package shipments, where multiple labels are created for a single shipment and the individual packages are linked together in a single shipment record with a master tracking number.

You can connect this carrier to ShipStation API multiple times using different accounts and choose which account will be used to create each shipment.

The carrier can be used to create domestic shipping labels.

The carrier can be used to create international shipping labels.

ShipStation API will submit international customs declarations electronically to the carrier.

The carrier can be used to create domestic return labels.

When an API call is made to the Rates endpoint, ShipEngine will return estimated shipping rates for the carrier based on the connected account information and shipment details.

Shipment insurance, provided by the shipment's selected carrier, can be added to the shipment in ShipStation API. This insurance would be in addition to any default coverage already provided by that carrier.

Shipping labels created for this carrier will include a tracking number that can be used to view the shipment status on the carrier's tracking website. Tracking may not be available for all shipping services.

Shipment manifests and End of Day documents are submitted electronically to the carrier by ShipEngine.

Shipment manifests and End of Day documents are generated as PDF files that can be printed along with shipping labels. Because these documents are not electronically submitted, physical copies must be provided to the carrier.

ShipEngine can print your brand logo on shipping labels from carriers that support this feature. Add your logo in the ShipEngine Dashboard.

ShipEngine can include additional information on a shipping label that is specified in the label request, if supported by the carrier.

This carrier can be used to create multi-package shipments, where multiple labels are created for a single shipment and the individual packages are linked together in a single shipment record with a master tracking number.

You can connect this carrier to ShipStation API multiple times using different accounts and choose which account will be used to create each shipment.

Available Services

Click to view the available services for ShipStation API Carriers.

BRT IT from ShipStation API

BRT IT Services and Package Types

BRT IT Domestic Services

API Code

Express: Collection - Delivery:

express_coll_del

Express:Drop off - Home

express_dropoff_home

Express: Drop off - Pick Up

express_drpoff_pckup

BRT Express Domestic

brt_express_domestic

Express: Home to Shop (direct to shop)

exp_direct_to_shop

Express: Home to Shop

express_home_to_shop

BRT IT International Services

API Code

BRT Express Export

brt_express_export

BRT Express:Drop off - Home International

brt_express_dropoff_home_international

BRT IT Package Types

API Code

Package

brt_it_package

Additional Features for BRT

The ShipStation API integration with BRT allows for the following additional features:

Feature

Description

Scheduled Pickup Services

Scheduled Pickup available for these services:

  • Express: Drop off - Home

  • Express: Collection - Delivery

  • Brt Express Domestic

  • Express: Home to Shop

Reschedule Pickup Services

To reschedule a pickup service, cancel the scheduled pickup first, then schedule a new pickup request. This will overwrite the original scheduled service request with BRT.

BRT IT Integration Notes

  • The ShipStation API integration with BRT IT does not support the following:

    • Third-party billing

    • Shipping alcohol

    • Shipping dangerous goods.

  • Void Labels: You must wait at least 5 minutes after positive confirmation of label creation to void labels. Otherwise, it will return an error message.

  • Package - SenderParcelType character limit: The package-content description cannot exceed 15 characters.

  • Prohibited Items: See the What can I ship online? page for a list of items and goods that BRT IT prohibits from shipping.

Poste Italiane from ShipStation API

Poste Italiane Available Services and Package Types

Poste Italiane Domestic Services

Shipping Service

API Code

Carrier Code

Service Type

Poste Delivery Business Standard Shop to Home Delivery

poste_italiane_pdb_std_shop_to_home_delivery

APT000902

Shop2Home

Poste Delivery Business Standard Shop to Delivery Points

poste_italiane_pdb_std_shop_to_delivery_points

APT000902, APT000947

Shop2Shop

Poste Delivery Business Standard Shop to Lockers

poste_italiane_pdb_std_shop_to_lockers

APT000902, APT000948

Shop2Shop

Poste Delivery Business Standard Shop to Post Office

poste_italiane_pdb_std_shop_to_post_office

APT000902, APT000949

Shop2Shop

Poste Delivery Business Express Home to Home Delivery

poste_italiane_pdb_exp_home_to_home_delivery

APT000901

Home2Home

Poste Delivery Business Standard Home to Home Delivery

poste_italiane_pdb_std_home_to_home_delivery

APT000902

Home2Home

Poste Italiane Package Types

Name

API Code

Parcel

poste_italiane_parcel_walleted

Poste Italiane from ShipStation Integration Notes

  • The ShipStation API integration with Poste Italiane from ShipStation does not support the following:

    • Third-party billing.

    • Shipping Dangerous Goods

    • Shipping Alcohol

  • Paperless QR code with Multi-parcel: Paperless QR code is not supported for multi-parcel shipments.

  • Paperless QR code for Lockers: Paperless QR code is not available for Poste Delivery Business Standard Shop to Lockers service.

Required Fields

The following fields are required to make a successful label request.

Carrier API Field

ShipStation API Field

Description

weight

packages.weight_details.weight_in_grams

Required for declared items.

Expressed in grams, integer > 0.

height

packages.dimension_details.dimensions_in_centimeters.height

Required for declared items.

Expressed in centimeters, integer > 0.

length

packages.dimension_details.dimensions_in_centimeters.length

Required for declared items.

Expressed in centimeters, integer > 0.

width

packages.dimension_details.dimensions_in_centimeters.width

Required for declared items.

Expressed in centimeters, integer > 0.

zipCode (sender)

ship_from.postal_code

Required

city (sender)

ship_from.city_locality

Required

address (sender)

ship_from.address_lines[0]

Required

nameSurname (sender)

ship_from.name / ship_from.first_name + " " + ship_from.last_name

Required

zipCode (receiver)

ship_to.postal_code

Required

city (receiver)

ship_to.city_locality

Required

address (receiver)

ship_to.address_lines[0]

Required

country (receiver)

ship_to.country_code

Required 

For international, ISO 4 code. Else, fixed value: "ITA1".

countryName (receiver)

ship_to.country_code

Required

For international, country name. Else, fixed value: "Italia".

nameSurname (receiver)

ship_to.name / ship_to.first_name + " " + ship_to.last_name

Required

packages[].weight_in_grams

N/A

Mandatory for package validation.

packages[].dimension_details.dimensions_in_centimeters.height

N/A

Mandatory for package validation.

packages[].dimension_details.dimensions_in_centimeters.length

N/A

Mandatory for package validation.

packages[].dimension_details.dimensions_in_centimeters.width

N/A

Mandatory for package validation.

Character Limits (Field Limitations)

This table describes the character limits (Field Limitations) for Poste Italiane.

Carrier API Field

ShipStation API Field

Character Limit

zipCode (sender/receiver)

ship_from.postal_code / ship_to.postal_code

Max 7 characters. ITA1 must be 5 numeric characters.

city

(sender/receiver)

ship_from.city_locality / ship_to.city_locality

Max 30 characters.

address (sender/receiver)

ship_from.address_lines[0] / ship_to.address_lines[0]

Max 40 characters.

Getting Products to the Carrier

This table shows weight and dimension limitations.

Name

Description

Max Weight/Dimensions (Shop2 services)

For Shop2Home, Shop2Delivery Points, Shop2Lockers, Shop2Post Office:

Max weight = 15 kg,

Largest dimension = 56 cm,

Middle dimension = 37 cm,

Shortest dimension =

36 cm,

Combined/Volume: max_vol (L+2H+2W) = 220.

Max Weight/Dimensions (Home2Home services)

For Poste Delivery Business Express Home to Home Delivery and Poste Delivery Business Standard Home to Home Delivery:

Max weight = 70 kg,

largest dimension = 280 cm,

middle dimension = 170 cm,

max_lwh (L+W+H) = 450.

Volumetric Weight Calculation

Real weight applies only for shipments not exceeding 5 kg and 50 cm x 28 cm x 32 cm.

If any of these are exceeded, volumetric weight will apply for Shop2 services. Volumetric weight does not apply for Home2Home services.

The carrier can be used to create domestic shipping labels.

The carrier can be used to create international shipping labels.

ShipStation API will submit international customs declarations electronically to the carrier.

The carrier can be used to create domestic return labels.

When an API call is made to the Rates endpoint, ShipEngine will return estimated shipping rates for the carrier based on the connected account information and shipment details.

Shipment insurance, provided by the shipment's selected carrier, can be added to the shipment in ShipStation API. This insurance would be in addition to any default coverage already provided by that carrier.

Shipping labels created for this carrier will include a tracking number that can be used to view the shipment status on the carrier's tracking website. Tracking may not be available for all shipping services.

Shipment manifests and End of Day documents are submitted electronically to the carrier by ShipEngine.

Shipment manifests and End of Day documents are generated as PDF files that can be printed along with shipping labels. Because these documents are not electronically submitted, physical copies must be provided to the carrier.

ShipEngine can print your brand logo on shipping labels from carriers that support this feature. Add your logo in the ShipEngine Dashboard.

ShipEngine can include additional information on a shipping label that is specified in the label request, if supported by the carrier.

This carrier can be used to create multi-package shipments, where multiple labels are created for a single shipment and the individual packages are linked together in a single shipment record with a master tracking number.

You can connect this carrier to ShipStation API multiple times using different accounts and choose which account will be used to create each shipment.

Articles in this section

See more
Didn't Find What You Were Looking For? Contact Support