### Customer Barcode - Examples
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Provides examples of shipping labels that include a customer barcode.
```text
Exemple d'étiquette avec code barre client, référence client
Exemple d'étiquette avec le numéro de colis code barre client
```
--------------------------------
### Generate Token for Secure Returns - Example
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Demonstrates how to generate a token for secure returns using the `postgenerateToken` method. This is useful for implementing secure return processes.
```text
Exemple d’étiquette Retour sécurisé avec generateToken
```
--------------------------------
### Introduction and Setup
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Provides an overview of the API, prerequisites, and important considerations for development.
```APIDOC
## Introduction
This section covers the object of the document, prerequisites for using the API, scalability of the Web Service, handling of accented and non-Latin characters, response format, test labels, security recommendations (HTTPS), and development best practices.
### Prerequisites
Ensure you have the necessary credentials and understand the basic requirements for accessing the Colissimo API.
### Security
It is recommended to use the HTTPS protocol for secure communication with the API.
```
--------------------------------
### Get Product Information Response Sample (JSON)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
This JSON structure represents the response received after requesting product information. It contains a list of messages, which can include status updates or errors, an array of product strings, the partner type, and a list of return type choices available for the requested product.
```json
{
"messages": [
{
"id": "string",
"type": "string",
"messageContent": "string"
}
],
"product": [
"string"
],
"partnerType": "string",
"returnTypeChoice": [
"string"
]
}
```
--------------------------------
### Deposit Slip - Examples
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Illustrative examples of Colissimo deposit slips.
```text
Exemples de bordereaux de dépôt
```
--------------------------------
### Label Examples - Colissimo Flash (F - With Signature)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Example of a Colissimo Flash label for France (F) with signature required, using the 6V service.
```text
Exemple d'étiquette Colissimo Flash F – avec signature 6V
```
--------------------------------
### Label Examples - Unified Label (with CN23)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
An example of a unified shipping label that includes the CN23 customs declaration form.
```text
Exemple d’étiquette unifiée (comprenant la CN23)
```
--------------------------------
### Label Examples - National Pickup Point Delivery
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
An example of a national shipping label for delivery to a pickup point.
```text
Exemple d'étiquette nationale pour la livraison en point relais commerçant
```
--------------------------------
### Colissimo API generateToken Request Body Example (JSON)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
This JSON object represents a sample request body for the 'generateToken' endpoint. It includes required fields like 'outputFormat' and 'letter', along with optional fields for 'fields' and 'customizationFields'. The 'letter' object itself contains nested structures for 'service', 'parcel', 'sender', 'addressee', and 'customsDeclarations'.
```json
{
"contractNumber": "_AN_",
"outputFormat": {},
"letter": {
"service": {},
"parcel": {},
"sender": {},
"addressee": {},
"customsDeclarations": {}
},
"fields": {},
"customizationFields": {}
}
```
--------------------------------
### Get Bordereau By Number SOAP Request Sample
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
This is a sample SOAP request to the getBordereauByNumber endpoint. It includes the necessary envelope and body structure to specify the bordereau number for which the details are requested. An example API key is also provided in the header.
```xml
31
-HEADER "apiKey : AE991A721E9111925E0347A4592BDAE0"
```
--------------------------------
### Label Examples - International (Australia)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
An example of an international shipping label for delivery to Australia.
```text
Exemple d'étiquette pour livraison internationale (Australie)
```
--------------------------------
### API Endpoint: `postgetProductInter`
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Retrieves information about international products.
```APIDOC
## POST /getProductInter
### Description
This endpoint retrieves information about available international shipping products and their associated details.
### Method
POST
### Endpoint
`/getProductInter`
### Parameters
No specific parameters are detailed in the provided text for this endpoint, suggesting it might return a default list or require authentication.
### Request Example
```json
{
"query": "international products"
}
```
### Response
#### Success Response (200)
- **products** (array) - A list of international shipping products.
- **code** (string) - The product code.
- **name** (string) - The name of the product.
- **description** (string) - A description of the product.
#### Response Example
```json
{
"products": [
{
"code": "INTL_EXPRESS",
"name": "International Express",
"description": "Fast delivery for international shipments."
}
]
}
```
```
--------------------------------
### API Methods - postplanPickup
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Documentation for the `postplanPickup` API method, used for scheduling package pickups.
```text
postplanPickup
```
--------------------------------
### Label Examples - National Return (GeoLabel)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
An example of a national return shipping label in the GeoLabel format.
```text
Exemple d'étiquette retour nationale (format GeoLabel)
```
--------------------------------
### Label Examples - National Return (Non-GeoLabel)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
An example of a national return shipping label in a non-GeoLabel format.
```text
Exemple d'étiquette retour nationale (format non GeoLabel)
```
--------------------------------
### API Methods - postgetProductInter
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Documentation for the `postgetProductInter` API method, likely used to retrieve information about international products.
```text
postgetProductInter
```
--------------------------------
### Response Samples
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Provides sample response structures for successful API calls, including detailed information about shipment labels and routing.
```APIDOC
## Response Samples
### Description
This section details the structure of successful API responses, particularly for generating shipping labels and related information.
### Method
GET (Implied, as this is a response sample)
### Endpoint
N/A (Response sample only)
### Parameters
N/A
### Request Example
N/A
### Response
#### Success Response (200)
- **messages** (array) - An array of message objects, each containing an id, type, messageContent, and replacementValues.
- **id** (string) - Unique identifier for the message.
- **type** (string) - Type of the message (e.g., 'INFO', 'ERROR').
- **messageContent** (string) - The content of the message.
- **replacementValues** (array) - An array of objects for dynamic message content.
- **field** (string) - The field to be replaced.
- **value** (string) - The replacement value.
- **key** (string) - A key for the replacement value.
- **translatable** (boolean) - Indicates if the value is translatable.
- **labelXmlV2Reponse** (object) - Contains detailed information for the shipping label.
- **parcelNumber** (string) - The unique parcel number.
- **parcelNumberPartner** (string) - Partner's parcel number.
- **contractNumber** (string) - The contract number associated with the shipment.
- **sitePCH** (object) - Information about the pickup point.
- **code** (string) - Code of the pickup site.
- **name** (string) - Name of the pickup site.
- **address** (object) - Address details of the pickup site.
- **line0** (string) - Address line 0.
- **line1** (string) - Address line 1.
- **line2** (string) - Address line 2.
- **line3** (string) - Address line 3.
- **zipCode** (string) - Zip code.
- **city** (string) - City.
- **countryCode** (string) - Country code.
- **rdepot** (string) - Depot code.
- **pickupLocation** (object) - Details about the pickup location.
- **pointId** (string) - ID of the pickup point.
- **name** (string) - Name of the pickup location.
- **address** (object) - Address of the pickup location.
- **line1** (string) - Address line 1.
- **line2** (string) - Address line 2.
- **line3** (string) - Address line 3.
- **line4** (string) - Address line 4.
- **zipCode** (string) - Zip code.
- **city** (string) - City.
- **countryCode** (string) - Country code.
- **countryLabel** (string) - Country label.
- **groupRouting** (string) - Group routing information.
- **serviceLabel** (string) - Service label.
- **sortDistribution** (string) - Sort distribution code.
- **routingZipCode** (string) - Routing zip code.
- **netWork** (string) - Network information.
- **idPartenaire** (string) - Partner ID.
- **routingFileVersion** (string) - Routing file version.
- **sender** (object) - Information about the sender.
- **senderParcelRef** (string) - Sender's parcel reference.
- **address** (object) - Sender's address.
- **companyName** (string) - Company name.
- **lastName** (string) - Last name.
- **firstName** (string) - First name.
- **line0** (string) - Address line 0.
- **line1** (string) - Address line 1.
- **line2** (string) - Address line 2.
- **line3** (string) - Address line 3.
- **countryCode** (string) - Country code.
- **city** (string) - City.
- **zipCode** (string) - Zip code.
- **phoneNumber** (string) - Phone number.
- **mobileNumber** (string) - Mobile number.
- **doorCode1** (string) - Door code 1.
- **doorCode2** (string) - Door code 2.
- **intercom** (string) - Intercom details.
- **email** (string) - Email address.
- **language** (string) - Language preference.
- **stateOrProvinceCode** (string) - State or province code.
- **addressee** (object) - Information about the addressee.
- **addresseeParcelRef** (string) - Addressee's parcel reference.
- **codeBarForReference** (boolean) - Indicates if barcode is for reference.
- **serviceInfo** (string) - Service information.
- **promotionCode** (string) - Promotion code.
- **address** (object) - Addressee's address (same structure as sender's address).
- **routing** (object) - Routing information.
- **destinationCountry** (string) - Destination country code.
- **serviceText** (string) - Service text.
- **depotDest** (string) - Destination depot.
- **serviceMark** (string) - Service mark.
- **sortOrigin** (string) - Origin sort code.
- **groupingPriorityLabel** (string) - Grouping priority label.
- **sortDest** (string) - Destination sort code.
- **barcodeId** (string) - Barcode ID.
- **routingVersion** (string) - Routing version.
- **destinationCountryText** (string) - Destination country text.
- **partnerType** (string) - Partner type.
- **zoneRouting** (object) - Zone routing information.
- **zoneCABRoutage** (object) - CAB routing details.
- **barCodeRouting** (string) - Routing barcode.
- **parcelNumberRouting** (string) - Routing parcel number.
- **zoneInfosRoutage** (object) - Zone information for routing.
- **trackingNumberRouting** (string) - Routing tracking number.
- **controlKeyTrackingNumber** (string) - Tracking number control key.
- **getrDepot** (string) - GETR depot.
- **identificationDestination1** (string) - Destination identification 1.
- **identificationDestination2** (string) - Destination identification 2.
- **serviceMark** (string) - Service mark.
- **typeServiceLivraison** (string) - Delivery service type.
- **sortOrigin** (string) - Origin sort code.
- **sortDest** (string) - Destination sort code.
- **routingVersion** (string) - Routing version.
- **datePrinting** (string) - Printing date.
- **hourPrinting** (string) - Printing hour.
- **numberVersionWS** (string) - Web service version number.
- **msort** (string) - Msort code.
- **belgiumLabel** (object) - Specific label information for Belgium.
- **codeVAS** (object) - Value-added services code.
- **mention** (string) - Mention.
- **deliveryMode** (string) - Delivery mode.
- **reserve** (string) - Reserve information.
- **signature** (string) - Signature requirement.
- **identification** (string) - Identification code.
- **codeBarre** (string) - Barcode.
- **returnAddress** (object) - Return address details.
- **mention** (string) - Mention.
- **line1** (string) - Address line 1.
- **line2** (string) - Address line 2.
- **barCodePCH** (string) - PCH barcode.
- **numberPCH** (string) - PCH number.
- **barCodeCityssimo** (string) - Cityssimo barcode.
- **barCodeRouting** (string) - Routing barcode.
- **numberRouting** (string) - Routing number.
- **swissLabel** (object) - Specific label information for Switzerland.
- **injectionSite** (string) - Injection site.
- **signatureOption** (boolean) - Indicates if signature option is enabled.
- **codeSwissPost** (string) - Swiss Post code.
- **swissParcelNumber** (string) - Swiss parcel number.
- **hazmat** (object) - Hazardous materials information.
- **dataSource** (object) - Data source details.
- **name** (string) - Name of the data source.
- **inputStream** (object) - Input stream object.
- **contentType** (string) - Content type.
- **outputStream** (object) - Output stream object.
- **name** (string) - Name of the hazardous material.
- **inputStream** (object) - Input stream object.
- **content** (object) - Content object.
- **commandMap** (object) - Command map object.
- **mimeTypes** (array) - Array of mime types.
#### Response Example
```json
{
"messages": [
{
"id": "string",
"type": "string",
"messageContent": "string",
"replacementValues": [
{
"field": "string",
"value": "string",
"key": "string",
"translatable": true
}
]
}
],
"labelXmlV2Reponse": {
"parcelNumber": "string",
"parcelNumberPartner": "string",
"contractNumber": "string",
"sitePCH": {
"code": "string",
"name": "string",
"address": {
"line0": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string"
},
"rdepot": "string"
},
"pickupLocation": {
"pointId": "string",
"name": "string",
"address": {
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"countryLabel": "string"
},
"groupRouting": "string",
"serviceLabel": "string",
"sortDistribution": "string",
"routingZipCode": "string",
"netWork": "string",
"idPartenaire": "string",
"routingFileVersion": "string"
},
"sender": {
"senderParcelRef": "string",
"address": {
"companyName": "string",
"lastName": "string",
"firstName": "string",
"line0": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"countryCode": "string",
"city": "string",
"zipCode": "string",
"phoneNumber": "string",
"mobileNumber": "string",
"doorCode1": "string",
"doorCode2": "string",
"intercom": "string",
"email": "string",
"language": "string",
"stateOrProvinceCode": "string"
}
},
"addressee": {
"addresseeParcelRef": "string",
"codeBarForReference": true,
"serviceInfo": "string",
"promotionCode": "string",
"address": {
"companyName": "string",
"lastName": "string",
"firstName": "string",
"line0": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"countryCode": "string",
"city": "string",
"zipCode": "string",
"phoneNumber": "string",
"mobileNumber": "string",
"doorCode1": "string",
"doorCode2": "string",
"intercom": "string",
"email": "string",
"language": "string",
"stateOrProvinceCode": "string"
}
},
"routing": {
"destinationCountry": "string",
"serviceText": "string",
"depotDest": "string",
"serviceMark": "string",
"sortOrigin": "string",
"groupingPriorityLabel": "string",
"sortDest": "string",
"barcodeId": "string",
"routingVersion": "string",
"destinationCountryText": "string",
"partnerType": "string"
},
"zoneRouting": {
"zoneCABRoutage": {
"barCodeRouting": "string",
"parcelNumberRouting": "string"
},
"zoneInfosRoutage": {
"trackingNumberRouting": "string",
"controlKeyTrackingNumber": "string",
"getrDepot": "string",
"identificationDestination1": "string",
"identificationDestination2": "string",
"serviceMark": "string",
"typeServiceLivraison": "string",
"sortOrigin": "string",
"sortDest": "string",
"routingVersion": "string",
"datePrinting": "string",
"hourPrinting": "string",
"numberVersionWS": "string",
"msort": "string"
}
},
"belgiumLabel": {
"codeVAS": {
"mention": "string",
"deliveryMode": "string",
"reserve": "string",
"signature": "string"
},
"identification": "string",
"codeBarre": "string",
"returnAddress": {
"mention": "string",
"line1": "string",
"line2": "string"
}
},
"barCodePCH": "string",
"numberPCH": "string",
"barCodeCityssimo": "string",
"barCodeRouting": "string",
"numberRouting": "string",
"swissLabel": {
"injectionSite": "string",
"signatureOption": true,
"codeSwissPost": "string",
"swissParcelNumber": "string"
},
"hazmat": {
"dataSource": {
"name": "string",
"inputStream": {},
"contentType": "string",
"outputStream": {}
},
"name": "string",
"inputStream": {},
"content": {},
"commandMap": {
"mimeTypes": [
"string"
]
}
}
}
}
```
```
--------------------------------
### Label Examples - International with DDP
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
An example of an international shipping label that includes the Delivery Duty Paid (DDP) option.
```text
Exemple de label international avec l'offre DDP
```
--------------------------------
### API Endpoint: `postplanPickup`
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Plans a parcel pickup.
```APIDOC
## POST /planPickup
### Description
This endpoint allows you to schedule a pickup for your parcels from a specified address.
### Method
POST
### Endpoint
`/planPickup`
### Parameters
#### Request Body
- **pickupAddress** (object) - Required - The address where the pickup should occur.
- **street** (string) - Required - Street address.
- **city** (string) - Required - City.
- **postalCode** (string) - Required - Postal code.
- **country** (string) - Required - Country code (e.g., 'FR').
- **pickupDate** (string) - Required - The desired date for the pickup (YYYY-MM-DD).
- **pickupTimeSlot** (string) - Optional - The preferred time slot for the pickup (e.g., 'MORNING', 'AFTERNOON').
- **parcelCount** (integer) - Required - The estimated number of parcels to be picked up.
### Request Example
```json
{
"pickupAddress": {
"street": "1 Rue de la Paix",
"city": "Paris",
"postalCode": "75001",
"country": "FR"
},
"pickupDate": "2023-10-27",
"pickupTimeSlot": "AFTERNOON",
"parcelCount": 5
}
```
### Response
#### Success Response (200)
- **confirmationId** (string) - A confirmation ID for the scheduled pickup.
- **message** (string) - A confirmation message.
#### Response Example
```json
{
"confirmationId": "PICKUP12345",
"message": "Pickup scheduled successfully."
}
```
```
--------------------------------
### Label Examples - National Home Delivery (No Signature)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
An example of a national shipping label for home delivery without requiring a signature.
```text
Exemple d'étiquette nationale pour livraison à domicile sans signature
```
--------------------------------
### Sandbox Environment
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Information regarding the Sandbox environment for testing API integrations.
```APIDOC
## Sandbox Environment
This section details the Sandbox environment for testing the SLS Web Service.
### Sandbox Access URL
Provides the specific URL for accessing the Sandbox environment.
### Sandbox Limitations
Outlines any limitations or constraints of the Sandbox environment compared to the production environment.
```
--------------------------------
### Label Examples - Colissimo Flash (F - No Signature - 6G)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Example of a Colissimo Flash label for France (F) without signature, using the 6G service.
```text
Exemple Colissimo Flash Etiquette F - sans signature - 6G
```
--------------------------------
### Générer un code Aztec PNG depuis Cab2D avec Bash (Linux)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Ce script Bash permet de créer un fichier binaire 'cab_data.bin' à partir d'une chaîne de texte Cab2D, en utilisant des séquences d'échappement comme \\x1d. Ce fichier binaire est ensuite utilisé par la commande zint CLI pour générer un code Aztec PNG.
```bash
generate_cab.sh #!/bin/bash
content=' 'contenu de cab2dText '
echo -e "${content//x/x}" > cab_data.bin
```
--------------------------------
### Available Products and Options
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Details on the available shipping products, required information, and various shipping options.
```APIDOC
## Products Available
This section details the range of products and services offered by Colissimo.
### Product Codes
List and explanation of available product codes.
### Information Required per Parcel Type
Specifies the necessary information required based on the type of parcel being shipped.
### International and Overseas Shipments
Information regarding shipments to international destinations or French overseas territories.
### Customs Declaration (CN23)
Details on the CN23 customs declaration document required for international shipments.
### EORI and GST
Explanation of EORI (Economic Operators Registration and Identification) and GST (Australian Tax Identification) requirements.
## Shipping Options
This section details the various options available for customizing shipments.
### Insurance Value (``)
How to specify an insured value for the shipment.
### Cash on Delivery (COD) (``, ``)
Configuration for Cash on Delivery services.
### Proof of Delivery (``)
How to request a proof of delivery.
### Non-Machinable (``)
Option for parcels that cannot be processed by standard machinery.
### Delivery Duty Paid (DDP)
Details on the Delivery Duty Paid option, including its parameters and application for international shipments.
```
--------------------------------
### Utilisation de Zint CLI pour générer un code Aztec PNG
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Cette commande utilise l'outil en ligne de commande 'zint' pour générer un code Aztec PNG à partir d'un fichier binaire d'entrée. Elle spécifie le type de symbologie (Aztec Code), le fichier d'entrée et le nom du fichier de sortie.
```bash
zint -b 92 -i cab_data.bin -o code_aztec.png
```
--------------------------------
### planPickup
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Works with the Colissimo France Return product. Allows scheduling a return package pickup from the sender's mailbox without needing a postman to travel.
```APIDOC
## POST /planPickup
### Description
Works with the Colissimo France Return product. Allows scheduling a return package pickup from the sender's mailbox without needing a postman to travel.
### Method
POST
### Endpoint
/planPickup
### Parameters
#### Request Body
* **pickupRequest** (object) - Required - Contains the details for scheduling the pickup.
- **parcelId** (string) - Required - The ID of the parcel to be picked up.
- **pickupDate** (string) - Required - The desired date for pickup (YYYY-MM-DD).
- **pickupTimeSlot** (object) - Required - The desired time slot for pickup.
- **startTime** (string) - Required - The start time of the slot (HH:MM).
- **endTime** (string) - Required - The end time of the slot (HH:MM).
- **senderAddress** (object) - Required - Information about the sender's address.
- **line1** (string) - Required - Sender's address line 1.
- **city** (string) - Required - Sender's city.
- **postalCode** (string) - Required - Sender's postal code.
- **countryCode** (string) - Required - Sender's country code (e.g., "FR").
### Request Example
```json
{
"pickupRequest": {
"parcelId": "RET12345ABC",
"pickupDate": "2023-10-28",
"pickupTimeSlot": {
"startTime": "14:00",
"endTime": "17:00"
},
"senderAddress": {
"line1": "789 Pine Ln",
"city": "Marseille",
"postalCode": "13001",
"countryCode": "FR"
}
}
}
```
### Response
#### Success Response (200)
- **confirmationNumber** (string) - The confirmation number for the scheduled pickup.
- **message** (string) - A confirmation message.
#### Response Example
```json
{
"confirmationNumber": "PICKUPCONF789XYZ",
"message": "Pickup scheduled successfully."
}
```
```
--------------------------------
### US Shipping EORI Field Example
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Example of how to provide the EORI (Economic Operators Registration and Identification) number for shipments to the United States, a requirement for shipping without DDP.
```xml
EORI
1234567
```
--------------------------------
### Secure Return - generateToken Method
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Introduces the `generateToken` method for creating secure codes for return shipments, offering flexibility and fraud reduction by allowing label printing at the drop-off point.
```APIDOC
## Secure Return
### Description
The `generateToken` method generates a secure code for return shipments, replacing traditional labels. This innovative solution provides flexibility, allowing label printing at the drop-off point without prior knowledge of the parcel number, and helps reduce fraud.
### Prerequisites and Activation:
1. **Activate the service in your Colissimo Box:**
* Log in to your Colissimo Box space.
* Navigate to the "Return" tab.
* Activate the "Secure Return by Secure Code" option.
2. **Verify product eligibility:**
* Compatible with Colissimo return offers in France.
* Some products may not be eligible (error code 948).
3. **Use the `Generatetoken` method to obtain the secure code.**
4. **Customer Communication:**
* Share the secure code with your customer.
* Provide clear instructions on using the code, explain the drop-off process at the post office, and inform about the secure code's validity period (10 days).
5. **Code Management:**
* Keep a record of generated codes.
* Define a validity period for the codes.
```
--------------------------------
### Colissimo International Country Code Examples
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Examples demonstrating the correct usage of the countryCode tag for international shipments. It highlights the importance of using specific codes for territories and special regions.
```xml
CN
MQ
GL
```
--------------------------------
### API Methods - postgenerateToken
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Documentation for the `postgenerateToken` API method, used for generating security tokens, possibly for returns.
```text
postgenerateToken
```
--------------------------------
### Shipping Options - Proof of Delivery
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Details the use of the `` tag to request a proof of delivery.
```xml
...
```
--------------------------------
### GET /getLabelInternal/{parcelNumber}
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Retrieves a duplicate label for the purpose of the 'Retour Online' redesign. Requires the parcel number as a path parameter.
```APIDOC
## GET /getLabelInternal/{parcelNumber}
### Description
Retrieves a duplicate label for the purpose of the 'Retour Online' redesign. Requires the parcel number as a path parameter.
### Method
GET
### Endpoint
https://www.applications.colissimo.entreprise.laposte.fr/getLabelInternal/{parcelNumber}
### Parameters
#### Path Parameters
- **parcelNumber** (string) - Required - The parcel number for which to retrieve the label.
### Response
#### Success Response (200)
OK
#### Error Response
- **400** - Bad Request: Functional error.
- **500** - Internal Server Error: Technical or server error.
```
--------------------------------
### GET /getProductInter
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Retrieves international shipping return options compatible with the requested destination. This is crucial for informing international partners on how to handle undeliverable packages.
```APIDOC
## GET /getProductInter
### Description
Retrieves international shipping return options compatible with the requested destination (e.g., 'return for a fee', 'do not return'). The selected return option is communicated to international partners to specify actions for undeliverable packages.
### Method
GET
### Endpoint
/getProductInter
### Parameters
#### Header Parameters
- **apiKey** (string) - Required - The API key for authentication.
#### Query Parameters
- **insurance** (boolean) - Optional - Insured value. Defaults to false (or 0).
- **nonMachinable** (boolean) - Optional - Package format. Defaults to false (or 0). Set to true (or 1) for non-standard (non-machinable) package formats.
- **returnReceipt** (boolean) - Optional - Return receipt. Defaults to false (or 0).
- **countryCode** (string) - Required - ISO country code of the destination (e.g., 'DE' for Germany).
- **zipCode** (string) - Required - Destination postal code.
- **city** (string) - Optional - Not used (internal use by La Poste only).
#### Request Body
- **contractNumber** (string) - Optional - Deprecated. Use apikey instead.
- **password** (string) - Optional - Deprecated. Use apikey instead.
- **productCode** (string) - Required
### Request Example
```json
{
"contractNumber": "AN",
"password": "AN",
"productCode": "YOUR_PRODUCT_CODE",
"insurance": false,
"nonMachinable": false,
"returnReceipt": false,
"countryCode": "DE",
"zipCode": "10115",
"city": "Berlin"
}
```
### Response
#### Success Response (200)
- **mediaType** (object) - Details about the media type.
- **closed** (boolean) - Indicates if the response is closed.
- **status** (integer) - The status code of the response.
- **cookies** (object) - Cookies associated with the response.
- **length** (integer) - The length of the response body.
- **location** (string) - The URL for redirection.
- **language** (object) - Language details of the response.
- **date** (string) - The date of the response.
- **lastModified** (string) - The last modified date of the resource.
- **metadata** (object) - Metadata associated with the response.
- **allowedMethods** (array) - Allowed HTTP methods.
- **links** (array) - Links related to the response.
- **statusInfo** (object) - Detailed status information.
- **entityTag** (object) - Entity tag for caching.
- **stringHeaders** (object) - String representation of headers.
- **headers** (object) - Headers associated with the response.
- **entity** (object) - The main entity of the response.
#### Response Example
```json
{
"mediaType": {
"type": "string",
"subtype": "string",
"parameters": {
"property1": "string",
"property2": "string"
},
"wildcardType": true,
"wildcardSubtype": true
},
"closed": true,
"status": 200,
"cookies": {
"property1": {
"name": "string",
"value": "string",
"version": 0,
"path": "string",
"domain": "string",
"comment": "string",
"maxAge": 0,
"expiry": "2019-08-24T14:15:22Z",
"secure": true,
"httpOnly": true,
"sameSite": "NONE"
}
},
"length": 0,
"location": "http://example.com",
"language": {
"language": "string",
"displayName": "string",
"country": "string",
"variant": "string",
"script": "string",
"unicodeLocaleAttributes": [
"string"
],
"unicodeLocaleKeys": [
"string"
],
"displayLanguage": "string",
"displayScript": "string",
"displayCountry": "string",
"displayVariant": "string",
"extensionKeys": [
"string"
],
"iso3Language": "string",
"iso3Country": "string"
},
"date": "2019-08-24T14:15:22Z",
"lastModified": "2019-08-24T14:15:22Z",
"metadata": {
"empty": true,
"property1": [
{}
],
"property2": [
{}
]
},
"allowedMethods": [
"string"
],
"links": [
{
"uriBuilder": {},
"rel": "string",
"rels": [
"string"
],
"title": "string",
"params": {
"property1": "string",
"property2": "string"
},
"type": "string",
"uri": "http://example.com"
}
],
"statusInfo": {
"reasonPhrase": "string",
"family": "INFORMATIONAL",
"statusCode": 0
},
"entityTag": {
"value": "string",
"weak": true
},
"stringHeaders": {
"empty": true,
"property1": [
"string"
],
"property2": [
"string"
]
},
"headers": {
"empty": true,
"property1": [
{}
],
"property2": [
{}
]
},
"entity": {}
}
```
```
--------------------------------
### Products - Secure Returns
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Information regarding the secure returns service offered by Colissimo.
```text
Retour sécurisé
```
--------------------------------
### Accessing the SLS Web Service
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Details on how to access the SLS Web Service, including URLs, versions, and authentication methods.
```APIDOC
## Accessing the SLS Web Service
This section describes how to access the SLS Web Service, including the available methods, access URLs and versions, and API authentication.
### URLs and Versions
Details on the specific URLs for accessing different versions of the SLS Web Service will be provided here.
### API Authentication
Information on how to authenticate your requests to the API, likely involving API keys or tokens.
```
--------------------------------
### GET /SlsInternalService/getBordereauByNumber/{bordereauNumber}
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Retrieves a deposit slip (bordereau) by its number. Requires the bordereau number as a path parameter and a token and partner client code in the header.
```APIDOC
## GET /SlsInternalService/getBordereauByNumber/{bordereauNumber}
### Description
Retrieves a deposit slip (bordereau) by its number. Requires the bordereau number as a path parameter and a token and partner client code in the header.
### Method
GET
### Endpoint
https://www.applications.colissimo.entreprise.laposte.fr/SlsInternalService/getBordereauByNumber/{bordereauNumber}
### Parameters
#### Path Parameters
- **bordereauNumber** (string) - Required - The number of the bordereau to retrieve.
#### Header Parameters
- **token** (string) - Required - Authentication token.
- **partnerClientCode** (string) - Required - The partner client code.
### Response
#### Success Response (200)
Traitement OK
### Request Example (SOAP)
```xml
31
```
Header Example:
`apiKey : AE991A721E9111925E0347A4592BDAE0`
```
--------------------------------
### generateToken
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
Generates a secure demo token for testing purposes.
```APIDOC
## POST /generateToken
### Description
This method allows the generation of a secure demo token.
### Method
POST
### Endpoint
/generateToken
### Parameters
No specific parameters are required for this endpoint.
### Request Example
(No request body is typically sent for this endpoint)
### Response
#### Success Response (200)
- **token** (string) - The generated secure demo token.
#### Response Example
```json
{
"token": "DEMO_SECURE_TOKEN_12345"
}
```
```
--------------------------------
### Get Label Internal Endpoint URL
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
This is the URL for the getLabelInternal endpoint, which is used to retrieve a duplicate label. It requires the parcel number as a path parameter. This endpoint is part of the ServiceInternalWS.
```http
https://www.applications.colissimo.entreprise.laposte.fr/getLabelInternal/{parcelNumber}
```
--------------------------------
### Plan Pickup Request Sample (JSON)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
This JSON payload is used to schedule a pickup for a return parcel. It requires the parcel number, the desired pickup date and time, and sender details including company name, contact information, and address. The contract number and password are also included, though noted as obsolete in favor of an API key.
```json
{
"contractNumber": "string",
"password": "string",
"parcelNumber": "string",
"mailBoxPickingDate": "2019-08-24T14:15:22Z",
"sender": {
"companyName": "string",
"lastName": "string",
"firstName": "string",
"line0": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"zipCode": "string",
"countryCode": "string",
"email": "string",
"phoneNumber": "string"
}
}
```
--------------------------------
### Get Product Information Request Sample (JSON)
Source: https://www.applications.colissimo.entreprise.laposte.fr/doc-colissimo/redoc-sls/fr/index
This JSON payload is used to request information about a specific Colissimo product. It includes details such as contract number, password, product code, and options like insurance, non-machinable, and return receipt. The country code, zip code, and city are also required for location-specific product details.
```json
{
"contractNumber": "string",
"password": "string",
"productCode": "string",
"insurance": true,
"nonMachinable": true,
"returnReceipt": true,
"countryCode": "string",
"zipCode": "string",
"city": "string"
}
```