Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

La Poste-Lettre Suivie Guide

Lettre Suivie is a shipping service offered by La Poste that allows shipping domestically within France.

This guide provides developers with the details necessary to build Lettre Suivie shipping capabilities into their ShipStation API workflows.

Requirements

PropertyTypeDescription
nicknamestringrequired
contract_numberstringrequired
cust_account_numberstringrequired
client_idstringoptional
client_secretstringoptional
sales_channelstringoptional

Connect Account

You can connect a Lettre Suivie account using the POST method to the /v1/connections/carriers/ endpoint. At this time, Lettre Suivie cannot be connected via the ShipStation API Dashboard.

Connect via Endpoint

carrier_name: la_poste_lettre_suivie

POST /v1/connections/carriers/:carrier_name

Sample request:

1
2
3
4
5
6
7
8
9
10
11
12
POST /v1/connections/carriers/la_poste_lettre_suivie HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "My Lettre Suivie account",
"contract_number": "123456789",
"cust_account_number": "123abc",
"client_id": "987654",
"client_secret": "123xyz-lkj654"
}

A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.

Rates

Lettre Suivie sends rates to ShipStation API. However, rates do not include surcharges like fuel surcharge, insurance, home delivery, etc.

Service Details

Available Lettre Suivie services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint.

ServiceMax. weightAPI Code
B2C Standard Services3 kgla_poste_lettre_suivie_b2c_std

Lettre Suivie has the following maximum dimensions:

  • Length: 14 cm
  • Width: 9 cm
  • Height: 3 cm
  • The sum of all dimensions (L+W+H) must be less than 90 cm

Return Services

Lettre Suivie does not currently support return services.

Packages

The following carrier package types are available for Lettre Suivie services:

NameAPI CodePackage Attributes
Packagela_poste_lettre_suivie_packageDomestic

Adding Shipment Insurance

Adding shipment insurance is not supported for this carrier.

Review our Parcel Insurance page for details on adding our third-party shipment insurance with ShipStation API.

Label Support

  • Label sizes: 4" x 6"
  • Label formats: PDF, PNG, ZPL

Label Reference Fields

Lettre Suivie does not support any label reference fields.

Multi-Package Labels

Lettre Suivie does not support multi-package shipping.

Label Branding

Lettre Suivie supports adding a logo image to the label. Review our Create Custom Shipping Labels page for details on adding a logo to your ShipStation API account.

Voiding Labels

Lettre Suivie supports voiding labels with ShipStation API.

See our Void a Label page for details about voiding labels with ShipStation API.

Paperless Labels

Lettre Suivie does not support paperless labels.

Delivery Confirmation

Lettre Suivie does not support any delivery confirmation types.

Advanced Options

Lettre Suivie does not currently support any advanced options or shipping of dangerous goods.

Manifests

Lettre Suivie does not require or support creating manifests.

Scheduling Pickups

Lettre Suivie does not support scheduling pickups with ShipStation API.

Service Points (PUDO)

Lettre Suivie does not support shipping to service points.

Tracking

ShipStation API's integration with Lettre Suivie supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipStation API.

Disconnecting Your Lettre Suivie Account

See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipStation API.