{ "openapi" : "3.0.1", "info" : { "contact" : { }, "license" : { "name" : "Apache 2.0 License", "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "servers" : [ { "url" : "http://api-etiquetage.colis.intra.laposte.fr/sls-ws/SlsServiceRest" } ], "paths" : { "/checkGenerateLabel" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "checkGenerateLabel", "description" : "Data control without label generationContrôle des données sans génération d'étiquette", "operationId" : "checkGenerateLabel_1", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckGenerateLabelRequest" } } } }, "responses" : { "200" : { "description" : "Traitement OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenerateLabelV2Response" } } } }, "400" : { "description" : "Functional errorErreur fonctionnel" }, "403" : { "description" : "Token KO or Unauthorized access. (sid non-existent or customer account inactive or customer terminated)Token KO ou Accès non autorisé. (sid inexistant ou compte client inactif ou client résilié)" }, "500" : { "description" : "Technical error or server errorErreur Technique ou erreur serveur" }, "422" : { "description" : "The JSON input to the service is badly formattedLe JSON en entrée du service est mal formatté" } } } }, "/generateLabel" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "generateLabel", "description" : "This method is provided to create shipments in relation to the following solutions, regardless of the product or associated destination:

Offre France: Colissimo Domicile, Point Retrait, Retour,
Offre Internationale: Colissimo Expert, Domicile, Point Retrait, Retour,
Offre Outre-Mer: Colissimo Domicile and Colissimo Eco.


The products currently concerned are listed in the paragraph III. 1 Products available. La Poste - Colissimo may modify this list.

Important: it is preferable not to send an optional field when it is blank.Cette méthode est proposée pour créer les expéditions relevant des offres suivantes, quels que soient le produit ou la destination associés :Remarque : il est recommandé de ne pas envoyer un champ facultatif plutôt que de l’envoyer vide.

Fonction principale d'affranchissement :
Génère une annonce informatique du colis et ses documents associés(étiquette et déclarations douanières)
Réponse:
Ce service retourne une Map contenant un objet json et 0 à 3 tableaux d'octets.
La Map retournée est un objet MultipartBody.
L'objet json est sauvegardé avec la clé \"jsonInfos\" et est de type \"application-json\".
Les trois tableaux d'octets sont chacun sauvegardé avec les clés : proforma, label et cn23, et sont de type \"application/octet-stream\".
Exemple de client en cxf :

WebClient client = WebClient.create(URL);
client.type(\"application/json\").accept(\"multipart/mixed\");
MultipartBody bodyResponse = client.post(ObjetJsonRequete, MultipartBody.class);

A ce niveau, chaque objet sauvegardé dans la Map MultipartBody est récupéré grace à sa clé.
Pour le tableau d'octets \"label\", on utilise le code ci-dessous:

DataHandler dataHandler = bodyResponse.getAttachment(\"label\").getDataHandler();
InputStream is = dataHandler.getInputStream();
L'objet jsonInfos a le format ci-dessous:
{
  \"messages\":Array[Message],
  \"parcelNumber\":String,
  \"parcelNumberPartner\":String
}

Message
{
  \"id\":String,
  \"type\":String,
  \"messageContent\":String
}", "operationId" : "generateLabel_1", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "numéro de contrat", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenerateLabelRequestV31" } } } }, "responses" : { "200" : { "description" : "Traitement OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenerateLabelV2Response" } } } }, "400" : { "description" : "Functional errorErreur fonctionnel" }, "403" : { "description" : "Token KO or Unauthorized access. (sid non-existent or customer account inactive or customer terminated)Token KO ou Accès non autorisé. (sid inexistant ou compte client inactif ou client résilié)" }, "500" : { "description" : "Technical error or server errorErreur Technique ou erreur serveur" }, "422" : { "description" : "The JSON input to the service is badly formattedLe JSON en entrée du service est mal formatté" } } } }, "/generateCN23" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "generateCN23", "description" : "Méthode permettant de générer le document douanier CN23Method for generating the CN23 customs document", "operationId" : "generateCN23_1", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenerateCN23Request" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } } } } } }, "/getListMailBoxPickingDates" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "getListMailBoxPickingDates", "description" : "The method getListMailBoxPickingDates() indicates whether an address is eligible for shipment from a mailbox and, if so, what the date and time are of the
parcel pick-up from this address.

This method will be used to validate the eligibility of the geographic address for a pick-up from a mailbox the next day, which then makes it possible to enter the pick-up date in the tag mailBoxPickingDate in the block Service when the subsequent shipping announcement is issued using the method GenerateLabel.La méthode getListMailBoxPickingDates() permet de savoir si une adresse est éligible à un dépôt de colis retour en boîte aux lettres et de connaître la date et heure du prochain emport de colis à cette adresse.

Cette méthode sera utilisée pour valider l’éligibilité de l’adresse géographique pour un emport en boîte aux lettres le lendemain, ce qui permettra ensuite de renseigner cette date d’emport dans la balise mailBoxPickingDate du Bloc Service lors de l’annonce ultérieure de l’expédition au moyen de la méthode GenerateLabel.", "operationId" : "getListMailBoxPickingDates_2", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetListMailBoxPickingDatesRetourRequest" } } } }, "responses" : { "200" : { "description" : "Traitement OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetListMailBoxPickingDatesResponse" } } } } } } }, "/getLabel" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "getLabel", "operationId" : "getLabel_1", "parameters" : [ { "name" : "login", "in" : "header", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\".", "schema" : { "type" : "string" } }, { "name" : "password", "in" : "header", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\".", "schema" : { "type" : "string" } }, { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } }, { "name" : "accountNumber", "in" : "header", "description" : "N6
accountNumberaccountNumber", "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "getLabelRequest", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetLabelRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Traitement OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } } } } } }, "/SlsInternalService/checkInfoPlanPickup" : { "post" : { "tags" : [ "SlsInternalService : Services destinés aux applications internes" ], "operationId" : "checkInfoPlanPickup_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckInfoPlanPickupInternalRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json;charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CheckInfoPlanPickupResponse" } } } } } } }, "/SlsInternalService/getListMailBoxPickingDates" : { "post" : { "tags" : [ "SlsInternalService : Services destinés aux applications internes" ], "operationId" : "getListMailBoxPickingDates", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetListMailBoxPickingDatesRetourRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json;charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ListMailBoxPickingDatesRetourOnlineResponse" } } } } } } }, "/SlsInternalService/planPickup" : { "post" : { "tags" : [ "SlsInternalService : Services destinés aux applications internes" ], "operationId" : "planPickup_1", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PlanPickupRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json;charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/PlanPickupResponse" } } } } } } }, "/generateBordereauByParcelsNumbers" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "generateBordereauByParcelsNumbers", "description" : "Remarque : les colis dans le document doivent tous avoir été généré par le même compte. Si nécessaire, il est possible de faire autant d'appels au service que de compte.Note: the packages in the document must all have been generated by the same account. If necessary, it is possible to make multiple calls as there are accounts.", "operationId" : "generateBordereauByParcelsNumbers_1", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenerateBordereauByParcelsNumbersRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } } } } } }, "/generateToken" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "generateToken", "description" : "This method generates a token and associated documents if the customer wishes to secure the printing of these return labels.

The token and documents will enable customers to re-print a label at a post office or pick points.", "operationId" : "generateToken_1", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "numéro de contrat", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenerateLabelRequest" } } } }, "responses" : { "200" : { "description" : "Traitement OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Response" } } } }, "400" : { "description" : "Functional errorErreur fonctionnel" }, "403" : { "description" : "Token KO or Unauthorized access. (sid non-existent or customer account inactive or customer terminated)Token KO ou Accès non autorisé. (sid inexistant ou compte client inactif ou client résilié)" }, "500" : { "description" : "Technical error or server errorErreur Technique ou erreur serveur" }, "422" : { "description" : "The JSON input to the service is badly formattedLe JSON en entrée du service est mal formatté" } } } }, "/getProductInter" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "getProductInter", "description" : "This function, exclusively dedicated to international shipments, provides the return options compatible with the requested destination (e.g. \"paid return\", \"do not return\").

The return option entered is transmitted to our international partners to indicate what action is required if the parcel cannot be delivered to the addressee Cette fonction, dédiée exclusivement aux envois internationaux, fournit les options de retour compatibles avec la destination demandée (par exemple : « retour payant », « ne pas retourner »).

L’option de retour saisie est transmise à nos partenaires internationaux afin de leur indiquer l’action à réaliser dans le cas où le colis ne pourrait être remis à son destinataire", "operationId" : "getProductInter_1", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetProductInterRequest" } } } }, "responses" : { "200" : { "description" : "Traitement OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetProductInterResponse" } } } }, "400" : { "description" : "Functional errorErreur fonctionnel" }, "403" : { "description" : "Token KO or Unauthorized access. (sid non-existent or customer account inactive or customer terminated)Token KO ou Accès non autorisé. (sid inexistant ou compte client inactif ou client résilié)" }, "500" : { "description" : "Technical error or server errorErreur Technique ou erreur serveur" }, "422" : { "description" : "The JSON input to the service is badly formattedLe JSON en entrée du service est mal formatté" } } } }, "/planPickup" : { "post" : { "tags" : [ "SlsServiceWS : documentation" ], "summary" : "planPickup", "description" : "The method planPickup () allows you to make a request for picking up a return parcel deposited by the sender in their mailbox. The parcel needs to have been previously announced with La Poste. This method will be used to confirm firmly the pick-up on the chosen date, after first announcing the shipment by means of the method GenerateLabel. This method is compatible with product code CORE (8R Colissimo Retour France) and CORF (CQ Colissimo Retour International)La méthode planPickup() permet de faire une demande d’emport d’un colis retour déposé par l’expéditeur dans sa boîte aux lettres.
Le colis doit avoir été préalablement annoncé auprès de La Poste.
Cette méthode sera utilisée pour confirmer de manière ferme l’emport à la date voulue, après avoir annoncé en premier lieu l’expédition au moyen de la méthode GenerateLabel.
Cette méthode est compatible avec le code produit CORE (8R Colissimo Retour France) et CORF (CQ Colissimo Retour International)", "operationId" : "planPickup_2", "parameters" : [ { "name" : "apiKey", "in" : "header", "description" : "apiKey L'apiKey ", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PlanPickupRequest" } } } }, "responses" : { "200" : { "description" : "Traitement OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PlanPickupResponse" } } } } } } } }, "components" : { "schemas" : { "Address" : { "required" : [ "countryCode", "zipCode" ], "type" : "object", "properties" : { "companyName" : { "type" : "string", "description" : "AN35
companyName

For return postage (product code CORE 8R, CORI 7R or 5R), the company name is mandatory for the recipient.Raison sociale.

Pour un affranchissement retour (code produit CORE 8R, CORI 7R ou 5R), la raison sociale est obligatoire pour le destinataire" }, "lastName" : { "type" : "string", "description" : "A1...35
Last name.
Mandatory to send a parcel unless zipcode is a cedex CodeNom.

Obligatoire pour envoyer un colis sauf si le code postal est un code cedex" }, "firstName" : { "type" : "string", "description" : "A1...29
First name.
Mandatory for out-of-home delivery (product code HD)Prénom.

Obligatoire pour un envoi hors domicile (code produit HD)" }, "line0" : { "type" : "string", "description" : "AN1...35
Floor, hallway, stairs, apartment.

Important: this line does not appear on labels being sent to Switzerland.Etage, couloir, escalier, appart." }, "line1" : { "type" : "string", "description" : "AN1...35
Entrance, bulding, residence.

Important: this line does not appear on labels being sent to Switzerland.Entrée, bâtiment, immeuble, résidence." }, "line2" : { "type" : "string", "description" : "AN1...35
Number and route label.

Example: « 5 rue du Bellay »

must contain at least one character Numéro et libellé de voie.

Exemple : « 5 rue du Bellay »

doit comporter impérativement au moins un caractère" }, "line3" : { "type" : "string", "description" : "AN1...35
Place said or other mention.

Important: this line does not appear on labels being sent to Switzerland.Lieu dit ou autre mention." }, "countryCode" : { "type" : "string", "description" : "A2
ISO country code on 2 letters.
Example: « FR » for FranceCode ISO du pays sur 2 lettres.

Ex : « FR » pour la France " }, "city" : { "type" : "string", "description" : "AN1...35
Town.

Can be left blank (or else filled in by a chain of some sort, possibly not adequate) if the tag zipCode is filled with a Cedex code. *Ville.

Peut être laissée vide (ou aussi bien renseignée par une chaîne quelconque, éventuellement non appropriée) si la balise zipCode est renseignée par un code Cedex. * " }, "zipCode" : { "type" : "string", "description" : "AN5
Postal code.
If the postcode matches a Cedex code then:
Code postal.

Si le code postal correspond à un code Cedex alors :

" }, "phoneNumber" : { "type" : "string", "description" : "AN10...12
Phone Number.
Numéro de téléphone." }, "mobileNumber" : { "type" : "string", "description" : "AN
The cell phone number is strongly recommended to improve the chances of delivery to the recipient (it is used to send tracking notifications by SMS).
Checks performed :It must be filled in for the following packages :

For any international shipment, it is necessary to use the telephone prefix specific to the country in which your recipient is located.

The digits of the number must not follow an incremental sequence (e.g., 123456789), otherwise the WebService will return an error.
Le numéro de portable est fortement recommandé pour améliorer les chances de livraison au destinataire (il est notamment utilisé pour l'envoi des notifications de suivi par SMS).
Contrôles effectués :Il doit être renseigné obligatoirement pour les colis suivants :

Pour tout envoi à l'international, il est nécessaire d’utiliser le préfixe téléphonique spécifique au pays dans lequel se trouve votre destinataire.

les chiffres du numéro ne doivent pas se suivre de manière incrémentale (ex. : 123456789), sinon le WebService retournera une erreur." }, "doorCode1" : { "type" : "string", "description" : "AN1...8
Door code 1.
Doesn’t appear on the CN23 document.Code porte 1.

N’apparaît pas sur la CN23." }, "doorCode2" : { "type" : "string", "description" : "AN1...8
Door code 2.
Doesn’t appear on the CN23 document.Code porte 2.

N’apparaît pas sur la CN23." }, "intercom" : { "type" : "string", "description" : "AN1...30
Interphone.

Doesn’t appear on the CN23 document.Interphone.

N’apparaît pas sur la CN23." }, "email" : { "type" : "string", "description" : "AN5...80
Mandatory if the tag productCode is HD.

Email Address.
Used for follow-up notifications to the sender.
Expected form: Text@Text.Text.Obligatoire pour les envois hors domiciles

Adresse courriel.

Utilisé pour les notifications de suivi à l’expéditeur.

Forme attendue : Texte@Texte.Texte " }, "language" : { "type" : "string", "description" : "A2
By default, the local language of the sending country.
Language of the notification e-mail to the sender.
Used for tracking notifications by email or SMS.
The information is transmitted to local partners who can exploit it or not.Langue du mail de notification à l’expéditeur.

Utilisée pour les retours de colis avec le code produit CORI (7R) si la balise returnType est renseignée.

Utilisée pour les notifications de suivi par email ou SMS.
Par défaut : FR

Langues disponibles : ES, IT, NL, EN, DE. " }, "stateOrProvinceCode" : { "type" : "string", "description" : "AN2
State or province code. Required for the United States.Code de l'état ou de la province. Obligatoire pour les Etats Unis." } }, "description" : "SUB
" }, "Addressee" : { "required" : [ "address" ], "type" : "object", "properties" : { "addresseeParcelRef" : { "type" : "string", "description" : "AN1...15
Recipient order reference.
It allows the destination reference to be displayed only on the label. This data is not reflected in the Colissimo IT System and will not be visible in OSC. Its size must not exceed 15. Référence de commande du destinataire
Elle permet d'afficher la référence destinataire seulement sur l'étiquette. Cette donnée n'est pas remontée dans le SI Colissimo et ne sera pas visible dans OSC. Sa taille ne doit pas excéder 15." }, "codeBarForReference" : { "type" : "boolean", "description" : "B
Default: false
Used for Colissimo Retour only (tag productCode is CORE).
Allows to indicate (or not) the reference of the order of the recipient in the form of a bar code on the label of the package.
Enter \"true\" (or \"1\") to show the value of the tag addresseeParcelRef as a barcode on the parcel label.Par défaut, renseigner \"false \" (ou \"0\")." }, "serviceInfo" : { "type" : "string", "description" : "AN
Used for Colissimo Retour only (tag productCode is CORE).
Name of the department in the company.
Example: \"Returns department\"." }, "promotionCode" : { "type" : "string", "description" : "AN
Not used (La Poste internal use only)Non utilisé (usage interne à la poste uniquement)" }, "address" : { "$ref" : "#/components/schemas/Address" } }, "description" : "SUB
" }, "Article" : { "required" : [ "description", "quantity", "value", "weight" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "AN1…64
Detailed description of the article. Appears on CN23 document.
Must be in English for the US and for shipments with the DDP option.Description détaillée de l’article.
Apparaît sur le fichier CN23.
Obligatoirement en anglais pour les US et pour les envois avec l'option DDP" }, "quantity" : { "type" : "integer", "description" : "N
Number of articles of this type. Appears on CN23 document.Nombre d’articles de ce type.
Apparaît sur le fichier CN23. ", "format" : "int32" }, "weight" : { "type" : "number", "description" : "N
Unitary net weight of the articles in kg. Appears on CN23 document.Poids net unitaire des articles en kg.
Apparaît sur le fichier CN23. ", "format" : "float" }, "value" : { "type" : "number", "description" : "N
Unitary value of articles in EUROS.
Appears on CN23 document.Valeur unitaire des articles en EURO.
Apparaît sur le fichier CN23.", "format" : "float" }, "hsCode" : { "type" : "string", "description" : "N6, N8 ou N10
Mandatory if is 3 (commercial shipment).
Mandatory for 7R and 5R return products. Then its size must be 6 or 11.

Tariff number corresponding to the article. It will be necessary to indicate 6, 8 or 10 digits for the international shipments requiring a customs declaration.

Appears on CN23 document.Numéro tarifaire correspondant à l’article.

Il faudra indiquer 6, 8 ou 10 chiffres pour les envois à l’international nécessitant une déclaration douanière.
Un code erreur 30519 apparaîtra dans la réponse du Web Service si la balise est mal renseignée.

Obligatoire si category vaut 3 (envoi commercial).

Obligatoire pour les produits retours 7R et 5R. Il doit être de taille 6 ou 11

Apparaît sur le fichier CN23. " }, "originCountry" : { "type" : "string", "description" : "A2
ISO code of the country of origin of the article.

Mandatory for 7R and 5R return products. It must be identical for all declared articles.

Mandatory if category = 3 (commercial shipment).

Country name appears on CN23 document.

If filled in, check that the country code is A2 otherwise set FR by default.
If the country code is different from the format A2, the WS sls will return an error.Code ISO du pays d’origine de l’article.

Obligatoire pour les produits retours 7R et 5R. Il doit être identique pour tous les articles déclarés

Obligatoire si category=3 (envoi commercial)

Le nom du pays apparait en entier sur le fichier CN23.

Si non vide, vérifier que le code pays est sur A2 sinon mettre FR par défaut.

Si le code pays est différent du format A2, le WS sls retournera une erreur" }, "originCountryLabel" : { "type" : "string", "description" : "LabelLibellé" }, "currency" : { "type" : "string", "description" : "AN3
Set EUR by default if empty

Mandatory for 7R and 5R return products.

The currency must be the same for all declared articles. It must belong to the list {USD, EUR, CHF, GBP, CNY, JPY, CAD, AUD}. If the currency is different from the list above, the Web Service will return an error.|Devise.

Fixé par défaut en EUR si vide

Obligatoire pour les produits de retour 7R et 5R.

La devise doit être la même pour tous les articles déclarés. Elle doit appartenir à la liste {USD, EUR, CHF, GBP, CNY, JPY, CAD, AUD}. Si la devise est différente de la liste ci-dessus, le service web renverra une erreur." }, "artref" : { "type" : "string", "description" : "AN1...35
Mandatory for 7R and 5R return products.

Article reference, serial number.Référence de l’article, numéro de série.

Obligatoire pour les produits retours inter (7R) hors UE et 5R (OM)." }, "originalIdent" : { "type" : "string", "description" : "A1
Mandatory for 7R and 5R return products.

Key for identifying the outgoing invoice and the parcel related to the article.

Link up the parcel number with its sequencing:
Clé permettant d’identifier la facture aller et le colis lié à l’article.

Obligatoire pour les produits retours inter (7R) hors UE et 5R(OM).
Appairer le numéro de colis avec son ordonnancement :
" }, "vatAmount" : { "type" : "number", "description" : "N
VAT on itemsTVA des articles", "format" : "float" }, "customsFees" : { "type" : "number", "description" : "N
Customs duties on itemsDroits Douane des articles", "format" : "float" } }, "description" : "SUB
The block can be repeated up to 100 times.Le bloc article peut être répété jusqu’à 100 fois." }, "Category" : { "type" : "object", "properties" : { "value" : { "type" : "integer", "description" : "N1
Mandatory for products subject to a CN23 form.
Type of shipment.Nature de l'envoi.
Obligatoire pour les produits soumis à la CN23.", "format" : "int32" } }, "description" : "SUB
Mandatory for products subject to a CN23 form.

Block containing the tag related to the nature of the shipment.Bloc contenant la balise liée à la nature de l’envoi.

Obligatoire pour les produits soumis à la CN23." }, "CheckGenerateLabelRequest" : { "required" : [ "letter" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "password" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "letter" : { "$ref" : "#/components/schemas/Letter" }, "outputFormat" : { "$ref" : "#/components/schemas/OutputFormat" }, "fields" : { "$ref" : "#/components/schemas/Fields" }, "customizationFields" : { "$ref" : "#/components/schemas/CustomizationFields" } } }, "Contents" : { "type" : "object", "properties" : { "article" : { "type" : "array", "description" : "SUB
The block can be repeated up to 100 times.Le bloc article peut être répété jusqu’à 100 fois.", "items" : { "$ref" : "#/components/schemas/Article" } }, "category" : { "$ref" : "#/components/schemas/Category" }, "original" : { "type" : "array", "description" : "SUB
Bloc contenant le (ou les) set(s) de données Original.
Obligatoire pour les produits retours inter (7R) hors UE et 5R (OM).
Au plus 5 sets de données Original sont agréés.
Les colis sont identifiés selon l’ensemble ", "items" : { "$ref" : "#/components/schemas/Original" } }, "explanations" : { "type" : "string", "description" : "AN1…35
A renseigner si la catégorie « retour de marchandise » ou « Autre » est choisie (cf. 0)" } }, "description" : "This block represents the type of shipment and list of articles to declare.
Mandatory if articles are eligible for the CN23 form.Ce bloc représente la nature de l’envoi et liste des articles à déclarer.
Obligatoire si les envois sont éligibles à la CN23. " }, "CustomizationField" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "x" : { "type" : "integer", "format" : "int32" }, "y" : { "type" : "integer", "format" : "int32" }, "taille" : { "type" : "string" }, "value" : { "type" : "string" } } }, "CustomizationFields" : { "type" : "object", "properties" : { "reference" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomizationTemplate" } }, "customizationField" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomizationField" } } }, "description" : "SUB
Ce bloc peut être utilisé pour personnaliser la partie inféririeure de l'étiquette
", "xml" : { "name" : "customizationFields" } }, "CustomizationTemplate" : { "type" : "object", "properties" : { "customizableReferenceKey" : { "type" : "integer", "format" : "int32" }, "customizableReferenceValue" : { "type" : "string" } } }, "CustomsDeclarations" : { "type" : "object", "properties" : { "includeCustomsDeclarations" : { "type" : "boolean", "description" : "B
Default: false
Allows to include, in the response of the web service, the generation of a CN23 document in PDF format, relating to the articles declared in the web service request.

The CN23 document:

\"includeCustomsDeclarations = 1\" tag is mandatory for shipments eligible for dematerialization of customs documents (DDP option or DOM TOM shipment).Permet d’inclure, dans la réponse du web service, la génération d’un document CN23 au format PDF portant sur les articles déclarés dans la requête web service.

Par défaut vaut \"true\" (ou \"1\") pour inclure le document CN23 dans la réponse du web service.

Indiquez \"false\" (ou \"0\") pour ne pas inclure le document CN23 dans la réponse du web service.

La balise « includeCustomsDeclarations = 1 » est obligatoire pour les envois éligibles à la dématérialisation des documents douaniers (option DDP ou envoi Outre-Mer). " }, "numberOfCopies" : { "type" : "integer", "description" : "N
Number of CN23 to print
If the tag is not filled in, 4 copies of CN23 will be printed.
The number goes from 1 included to 4 copies max.
Note: international returns do not take into account the value entered here, due to their specific format.Nombre de CN23 à imprimer Si la balise n’est pas renseignée 4 exemplaires de CN23 seront imprimés. Le nombre va de 1 compris à 4 exemplaires max.
Remarque : les produits retours internationaux ne tiennent pas compte de par leur format spécifique de la valeur renseignée ici.", "format" : "int32" }, "contents" : { "$ref" : "#/components/schemas/Contents" }, "importersReference" : { "type" : "string", "description" : "AN1…35
Importer's reference, TVA number
Appears on the CN23 document for shipments.
Not used for returns.Référence de l’importateur, Numéro de TVA.

Apparaît sur le fichier CN23 pour les envois.
N’est pas utilisé pour les retours. " }, "importersContact" : { "type" : "string", "description" : "AN35
Importer's contact (tel./e-mail).
Doesn’t appear on CN23 document.Contact (tél./e-mail) de l’importateur.
N’apparaît pas sur le fichier CN23." }, "officeOrigin" : { "type" : "string", "description" : "AN35
Office origin.
Doesn’t appear on CN23 document.Bureau d’origine.
N’apparaît pas sur le fichier CN23." }, "comments" : { "type" : "string", "description" : "AN35
Observations
Appears on CN23 document.Observations
Apparaît sur le fichier CN23" }, "description" : { "type" : "string", "description" : "AN1.. ??
Mandatory in the case of a DDP shipment
Generic description of articles in English.
Example: Textile items, Shoes, Music instrument, Hair dryer, etc.Description générique des articles en anglais.
Obligatire dans le cas d’un envoi DDP
Exemple : Textile items, Shoes, Music instrument, Hair dryer, etc " }, "invoiceNumber" : { "type" : "string", "description" : "AN1...35
Identifier of related invoice document.
Appears in the « N° de la facture » field on the CN23 document.Identifiant du document facture lié.
Apparaît dans le champ « N° de la facture » sur la CN23." }, "licenceNumber" : { "type" : "string", "description" : "AN1…35
Identifier of the related import license document.
Appears in the « N° de la/les licences » field on the CN23 document.Identifiant du document de licence d’importation lié.
Apparaît dans le champ « N° de la/les licences » sur la CN23." }, "certificatNumber" : { "type" : "string", "description" : "AN1…35
Identifier of the related certificate number document.

Appears in the « N° du/des certificats » field on the CN23 document.Identifiant du document de certificat lié.
Apparaît dans le champ « N° du/des certificats » sur la CN23." }, "importerAddress" : { "$ref" : "#/components/schemas/Address" } }, "description" : "SUB
These parameters are mandatory only for destinations requiring a CN23 customs declaration.Ces paramètres ne sont obligatoires que pour les destinations nécessitant une déclaration douanière de type CN23." }, "Field" : { "required" : [ "key", "value" ], "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "A
Key word to be informedMot clef à renseigner" }, "value" : { "type" : "string", "description" : "AN32
The expected value is the order identifier in the SI Colissimo.Valeur attendue dans l'ordre identifié du SI Colissimo" } } }, "Fields" : { "type" : "object", "properties" : { "field" : { "type" : "array", "description" : "Package size in centimeters: length, width and height
\r\nLength <= 274 cm
\r\nLength + circumference (2 x height + 2 x width) <= 330 cm
\r\n \r\n \r\n LENGTH\r\n 30\r\n \r\n \r\n WIDTH\r\n 20\r\n \r\n \r\n HEIGHT\r\n 10\r\n \r\n \r\nCustomer Barcode
\r\nAdding a custom barcode in GEOLABEL standard labels cf. chapter \"Available Shipment options/Customer Barcode\" (maximum 17 alpha-numeric and 25 numeric characters)
\r\n \r\n \r\n PRINT_CUSTOMER_BARCODE\r\n 1\r\n \r\n \r\n CUSTOMER_BARCODE\r\n REF12345678\r\n \r\n\r\nIF PRINT_CUSTOMER_BARCODE = 1, print the barcode with the value of the field CUSTOMER_BARCODE (see example of labels II.5.1.7)
\r\nIF PRINT_CUSTOMER_BARCODE = 2, print the barcode with the value of the parcel number (see example of labels II.5.1.8)
\r\n
\r\n
\r\nLabel with visible client tag
\r\nOn standard GEOLABEL labels in 10x15 and PDF format, it is possible to add a customized 15 characters text below the label.
\r\nThe PRINT_CUSTOMER_LABEL field allows the text to be displayed or not, and the CUSTOMER_LABEL field specifies the text.
\r\n \n \r\n PRINT_CUSTOMER_LABEL\r\n 1\r\n \r\n \n \n \r\n CUSTOMER_LABEL\r\n ABCDEFG\r\n \r\n \n
\r\nNote: it is not possible to display a personalized barcode and a personalized text at the same time.
\r\n
\r\nNote 2: the personalized text will not appear on the label when reprinted by getlabel (or on a La Poste vending machine).
\r\n
\r\nCN23 format
\r\nAddition of a specific CN23 format :
\r\n \n \r\n OUTPUT_PRINT_TYPE_CN23\r\n ZPL_10x12_203dpi\r\n \r\n \nFormat/value allowed :
\r\nZPL_10x12_203dpi
\r\nZPL_10x12_300dpi
\r\nDPL_10x12_203dpi
\r\nDPL_10x12_300dpi
\r\nPDF_10x12_300dpi
\r\nPDF_A4_300dpi
\r\n“Unique Label” (UL) including label and CN23 on the same page
\r\naccepted formats are :
\r\nZPL_10x15_203dpi_UL
\r\nZPL_10x15_300dpi_UL
\r\nDPL_10x15_203dpi_UL
\r\nDPL_10x15_300dpi_UL
\r\nPDF_10x15_300dpi_UL
\r\nPDF_A4_300dpi_UL
\r\n \n \r\n OUTPUT_PRINT_TYPE_CN23\r\n PDF_10x15_300dpi_UL\r\n \r\n \nThe parcel (output_print_type_CN23) format and parcel format (outputprinting type) has to be the same in order to use the unique label feature :
\r\nIf the parcel is not eligible for CN23, then the label format will be printed
\r\n(OutputFormat block: outputprinting type field).
\r\nIf more than 3 items are entered in the CN23 section, they will not be displayed in the item list, but included in the total value and weight.
\r\nThis option overrides the customization features :
\r\n- Add a customer label (PRINT_CUSTOMER_LABEL)
\r\n- Adding a customer reference CAB (PRINT_CUSTOMER_BARCODE)

\r\nGroup your Parcel
\r\n
\r\n- The additional input parameters of the WS SLS for tracked parcels are as follows:
\r\n•\tTracking parcel flag
\r\n•\tTotal number of packages
\r\n•\tIteration (order number of the package)
\r\n
\r\n
\r\n \r\n TYPE_MULTI_PARCEL\r\n FOLLOWER\r\n \r\n \r\n PARCEL_ITERATION_NUMBER\r\n 2\r\n \r\n \r\n TOTAL_NUMBER_PARCEL\r\n 5\r\n \r\n
\r\n- The additional input parameters of the WS SLS for the master parcel are
\r\n•\tMaster parcel flag
\r\n•\tIteration (order number of the package)
\r\n•\tTotal number of packages
\r\nLimitation of 5 parcels in total
\r\n•\tList of follow-up packages
\r\n \r\n \r\n \n TYPE_MULTI_PARCEL\r\n MASTER\r\n \r\n \r\n PARCEL_ITERATION_NUMBER\r\n 2\r\n \r\n \r\n TOTAL_NUMBER_PARCEL\r\n 5\r\n \r\n \r\n LIST_FOLLOWER_PARCEL\r\n\t\t\t\t 8Q53764663714/8Q53764663721/8Q53764663738/8Q53764663748/8Q53764663758\r\n \r\n
\r\nBuyNowPayLater
\r\nThis input is used to notify transaction id attached to a parcel as part of the Colissimo
\r\npay offer for deferred and fractioned payment.
\r\nThis id parameter is truncated at 50 characters
\r\n \n \r\n BNPL\r\n ID de transaction\r\n \r\n \nCUSER_INFO_TEXT
\r\nResearch label for OSC. The label can be unique or shared between multiple parcels in order to search for a list of parcels with the same reference, for example.
\r\n \n \r\n CUSER_INFO_TEXT\r\n xxxxxxxxxxxxxxxxxx\r\n \r\n \nCUSER_INFO_TEXT_4
\r\nPartner reference (if given by your Colissimo contacts). Specific to the use of the service by our partners.
\r\n \n \r\n CUSER_INFO_TEXT_4\r\n xxxxxxxxxxxxxxxxxx\r\n \r\n \n
\r\nEORI (Economics Operators Registration and Identification)
\r\n
EORI numbers of the sender and/or recipient, which will appear on the customs declaration.\r\n * Use the 'EORI_ADDRESSEE' field for the recipient's EORI.\r\n
\n * Use the 'EORI' field for the sender's EORI (mandatory for shipments to the US).\r\n \n \n EORI\n 1234567\n \n \n EORI_ADRESSEE\n 1234567\n \nTaille du colis en centimètres: longueur, largeur et hauteur
\r\nLongueur <= 274 cm
\r\nLongueur + curconférence (2 x hauteur + 2 x largeur) <= 330 cm
\r\n \r\n \r\n LENGTH\r\n 30\r\n \r\n \r\n WIDTH\r\n 20\r\n \r\n \r\n HEIGHT\r\n 10\r\n \r\n \r\nCode barre personnalisé
\r\nAjouter un code barre personnalisé sur les étiquettes standards GEOLABEL conf. chapitre \"Option d'envoi/Code barres client\" (maximum 17 caractères alpha numériques et 25 numériques)
\r\n \r\n \r\n PRINT_CUSTOMER_BARCODE\r\n 1\r\n \r\n \r\n CUSTOMER_BARCODE\r\n REF12345678\r\n \r\n\r\nIF PRINT_CUSTOMER_BARCODE = 1, affiche le code barre avec la valeur du champ CUSTOMER_BARCODE (voir les exemples d'etiquettes)
\r\nIF PRINT_CUSTOMER_BARCODE = 2, affiche le code barre avec la valeur du numéro de colis (voir les exemples d'etiquettes)
\r\n
\r\n
\r\nEtiquette avec référence client
\r\nSur les étiquettes standard GEOLABEL au format 10x15 et PDF , il est possible d'ajouter un texte personnalisé de 15 caractères maximum sous les étiquettes.
\r\nLe champ PRINT_CUSTOMER_LABEL permet d'afficher ou non le texte, et le champ CUSTOMER_LABEL précise le texte.
\r\n \n \r\n PRINT_CUSTOMER_LABEL\r\n 1\r\n \r\n \n \n \r\n CUSTOMER_LABEL\r\n ABCDEFG\r\n \r\n \n
\r\nRemarque : il n'est pas possible d'afficher en même temps un code à barre personnalisé et un texte personnalisé
\r\n
\r\nRemarque 2 : le texte personnalisé n'apparaîtra pas sur l'étiquette en cas de réimpression par getlabel (ou sur un automate La Poste).
\r\n
\r\nCN23 format
\r\nFormats spécifiques pour la CN23 :
\r\n \n \r\n OUTPUT_PRINT_TYPE_CN23\r\n ZPL_10x12_203dpi\r\n \r\n \nFormats possibles :
\r\nZPL_10x12_203dpi
\r\nZPL_10x12_300dpi
\r\nDPL_10x12_203dpi
\r\nDPL_10x12_300dpi
\r\nPDF_10x12_300dpi
\r\nPDF_A4_300dpi
\r\nune étiquette unique (UL) incluant la CN23 sur la même page
\r\nles formats acceptés sont :
\r\nZPL_10x15_203dpi_UL
\r\nZPL_10x15_300dpi_UL
\r\nDPL_10x15_203dpi_UL
\r\nDPL_10x15_300dpi_UL
\r\nPDF_10x15_300dpi_UL
\r\nPDF_A4_300dpi_UL
\r\n \n \r\n OUTPUT_PRINT_TYPE_CN23\r\n PDF_10x15_300dpi_UL\r\n \r\n \nLe format de la CN23 (output_print_type_CN23) et format de l'étiquette (outputprinting type) doit être le même pour bénéficier de la fonctionnalité d'étiquette unifiée:

\r\nSi le colis n'est pas éligile à la CN23, le format affiché sera
\r\n(OutputFormat block: outputprinting type field).
\r\nSi il y a plus de 3 articles, la CN23 affichera que les 3 premiers mais les totaux seront pour l'ensemble des articles
\r\nCette option écrase les personalisations suivantes :
\r\n- Ajout d'une étiquette personalisée (PRINT_CUSTOMER_LABEL)
\r\n- Ajout d'une référence CAB personalisée (PRINT_CUSTOMER_BARCODE)

\r\nGroupage de colis
\r\n
\r\n- Les paramètres additionnels du service sls pour tracer les colis sont les suivants :
\r\n•\tEtiquette de traçage du colis
\r\n•\tNombre total de packages
\r\n•\tIteration (numéro du package)
\r\n
\r\n
\r\n \r\n TYPE_MULTI_PARCEL\r\n FOLLOWER\r\n \r\n \r\n PARCEL_ITERATION_NUMBER\r\n 2\r\n \r\n \r\n TOTAL_NUMBER_PARCEL\r\n 5\r\n \r\n
\r\n- Les paramètres additionnels du service sls pour les colis master sont les suivants :
\r\n•\tEtiquette du colis master
\r\n•\tNombre total de packages
\r\n•\tIteration (numéro du package)
\r\n• Limitation à 5 colis
\r\n•\tListe des packages suivis
\r\n \r\n \r\n \n TYPE_MULTI_PARCEL\r\n MASTER\r\n \r\n \r\n PARCEL_ITERATION_NUMBER\r\n 2\r\n \r\n \r\n TOTAL_NUMBER_PARCEL\r\n 5\r\n \r\n \r\n LIST_FOLLOWER_PARCEL\r\n\t\t\t\t 8Q53764663714/8Q53764663721/8Q53764663738/8Q53764663748/8Q53764663758\r\n \r\n
\r\nBuyNowPayLater
\r\nCette saisie permet de notifier l'identifiant de la transaction attachée à un colis Colissimo
\r\noffre payante en paiement différé et fractionné.
\r\nCe paramètre id est tronqué à 50 caractères
\r\n \n \r\n BNPL\r\n ID de transaction\r\n \r\n \nCUSER_INFO_TEXT
\r\nRéférence de recherche pour OSC. La référence peut être unique ou partagée sur plusieurs colis, afin de permettre de rechercher une liste de colis ayant la même référence par exemple.
\r\n \n \r\n CUSER_INFO_TEXT\r\n xxxxxxxxxxxxxxxxxx\r\n \r\n \nCUSER_INFO_TEXT_4
\r\nRéférence partenaire (si communiquée par vos interlocuteurs Colissimo). Spécifique à l'utilisation du service par nos partenaires.
\r\n \n \r\n CUSER_INFO_TEXT_4\r\n xxxxxxxxxxxxxxxxxx\r\n \r\n \n
\r\nEORI (Economics Operators Registration and Identification)
\r\n
Numéros EORI de l'expéditeur et/ou du destinataire qui seront visibles notamment sur la déclaration douanière.\r\n * Utiliser le champs 'EORI_ADDRESSEE' pour l'EORI du destinataire\r\n
\n * Utiliser le champs 'EORI' pour l'EORI de l'expéditeur (obligatoire pour les envois vers les US).\r\n \n \n EORI\n 1234567\n \n \n EORI_ADRESSEE\n 1234567\n \n", "items" : { "$ref" : "#/components/schemas/Field" } }, "customField" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Field" } } }, "description" : "SUB
Ce bloc peut être utilisé pour renseigner l’identifiant

-Gestion des utilisateurs
-Colissimo Pass ID
- GST
- EORI " }, "Letter" : { "required" : [ "addressee", "parcel", "service" ], "type" : "object", "properties" : { "service" : { "$ref" : "#/components/schemas/Service" }, "parcel" : { "$ref" : "#/components/schemas/ParcelRequestV2" }, "customsDeclarations" : { "$ref" : "#/components/schemas/CustomsDeclarations" }, "sender" : { "$ref" : "#/components/schemas/Sender" }, "addressee" : { "$ref" : "#/components/schemas/Addressee" }, "codSenderAddress" : { "$ref" : "#/components/schemas/Address" } }, "description" : "SUB
This block contains tags and blocks related to the shipment (options, parcel, sender, addressee, customs).
List sub-bocks (described below):
Ce bloc contient des balises et blocs liés à l’expédition (options, colis, expéditeur, destinataire, douanes).

Liste des sous-blocs (décrits plus bas) :
" }, "Original" : { "type" : "object", "properties" : { "originalIdent" : { "type" : "string", "description" : "A1
Mandatory for 7R and 5R return products.

Key for identifying the invoice and outgoing parcel related to the article.
Link up the parcel number with its sequencing:
Clé permettant d’identifier la facture et colis aller liés à l’article.

Obligatoire pour les produits retours inter (7R) hors UE et 5R(OM).

Appairer le numéro de colis avec son ordonnancement :
" }, "originalInvoiceNumber" : { "type" : "string", "description" : "AN1...35
Mandatory for a return parcel.

Original invoice number for a return parcel.Numéro de la facture d’origine du colis.

Obligatoire pour un colis Retour." }, "originalInvoiceDate" : { "type" : "string", "description" : "AN10
Mandatory for a return parcel.

Original invoice date for a return parcel. YYYY-MM-DD format is expected. The date must be before or the same as today’s dateDate de la facture d’origine du colis.

Obligatoire pour un colis Retour.

Format attendu AAAA-MM-JJ.

Doit être antérieure ou égale à la date du jour.", "format" : "date-time" }, "originalParcelNumber" : { "type" : "string", "description" : "AN1...35
Mandatory for a return parcel.

Original parcel number.Numéro de colis d’origine.

Obligatoire pour un colis Retour. " } }, "description" : "Mandatory for 7R and 5R return products.

Block containing Original data set(s).
Up to 5 Original data sets are approved. Packages are identified all together with the 5 Original sets Bloc contenant le (ou les) set(s) de données Original.

Obligatoire pour les produits retours inter (7R) hors UE et 5R (OM).

Au plus 5 sets de données Original sont agréés.

Les colis sont identifiés selon l’ensemble " }, "OutputFormat" : { "required" : [ "outputPrintingType", "x", "y" ], "type" : "object", "properties" : { "x" : { "type" : "integer", "description" : "N-9999…9999
By default, enter \"false\" (or \"0\").
Allows horizontal adjustment of printing on the label (expressed in points):
Par défaut, mettre à \"false\" (ou \"0\").
Permet d’ajuster le décalage horizontal de l’impression sur l’étiquette (exprimé en points):
", "format" : "int32" }, "y" : { "type" : "integer", "description" : "N-120…120
By default, enter \"false\" (or \"0\").
Allows vertical adjustment of printing on the label (expressed in points):
Par défaut, mettre à \"false\" (ou \"0\").
Permet d’ajuster le décalage vertical de l’impression sur l’étiquette (exprimé en points) :
", "format" : "int32" }, "outputPrintingType" : { "type" : "string", "description" : "L
Label printing format.Format d'impression des étiquettes." }, "dematerialized" : { "type" : "boolean", "description" : "B
Not used (La Poste internal use only)Non utilisé (utilisation interne à La Poste uniquement)" }, "returnType" : { "type" : "string", "description" : "L
Used if the tag productCode is CORE (8R) or CORF (CQ).

Defines the label transmission mode. By default, the label is sent in the Web Service response only.
Possible values:
Définit le mode de transmission de l’étiquette. Utilisé pour le Colissimo Retour uniquement.Par défaut, l’étiquette est envoyée uniquement dans la réponse du Web Service. Valeurs possibles :
" }, "printCODDocument" : { "type" : "boolean", "description" : "B
Allow you to print the CRBT document

Default: falsePermettre d’imprimer le document CRBT
Par défaut : false" } }, "description" : "SUB
This block contains the sub-tags linked to the format of the data sent by the Web ServiceCe bloc contient les balises liées au format des éditions renvoyées par le Web Service." }, "ParcelRequestV2" : { "required" : [ "weight" ], "type" : "object", "properties" : { "parcelNumber" : { "type" : "string", "description" : "AN13
Not used (La Poste internal use only)Non utilisé (utilisation interne à La Poste uniquement)" }, "insuranceAmount" : { "type" : "integer", "description" : "N
Not used (La Poste internal use only)Non utilisé (utilisation interne à La Poste uniquement)", "format" : "int32" }, "insuranceValue" : { "type" : "integer", "description" : "N
Insured value

By default, enter \"0\".

If the insurance option is chosen, enter the amount of the desired insurance level by selecting among one of the 6 levels below .
The amount must be written in cents. Example: 500000 for 5,000 EUR.

If the value entered does not match one of the 6 levels of insurance available, the value will be changed the level in which the entered amount is located. Example: 16200 for 162 EUR will become 30000 for 300 EUR.

6 optional insurance levels:

Maximum= 5000€.Valeur assurée.

Par défaut, renseigner \"0\".
Si l’option d’assurance est choisie, renseigner le montant du niveau d’assurance souhaité parmi les 6 niveaux proposés. Le montant doit être exprimé en centimes. Exemple : 500000 pour 5000 EUR.

Si la valeur renseignée ne correspond pas à l’un des 6 niveaux d’assurance, la valeur affichée sera celle du niveau dans lequel le montant renseigné se situe. Exemple : 16200 soit 162 EUR, deviendra 30000 EUR soit 300 EUR.

6 niveaux d’assurance optionnelle :

Maximum= 5000€.", "format" : "int32" }, "recommendationLevel" : { "type" : "string", "description" : "LevelNiveau" }, "weight" : { "type" : "number", "description" : "N
Weight of parcel in kg.
Example: \"5.50\".

parameter \"weight\":
The status of the customer account: a terminated customer account will not allow labels to be generated. Poids du colis en kg.
Exemple : \"5.50\". ", "format" : "float" }, "nonMachinable" : { "type" : "boolean", "description" : "B
Default: false
Parcel format.
If productCode is HD, enter \"false\" (or \"0\") by default.
Enter \"true\" (or \"1\") to indicate that parcel format is non-standard (non-machinable).Format du colis.
Si la balise productCode a les codes HD renseigner \"false\" (ou \"0\") par défaut.
Passer à \"true\" (ou \"1\") pour indiquer que le format du colis est non standard (non mécanisable). " }, "returnReceipt" : { "type" : "boolean", "description" : "B
Default: false
Advice of receiptAvis de réception.

Par défaut, renseigner \"false \" (ou \"0\"). " }, "instructions" : { "type" : "string", "description" : "AN1...35
Additional information:
Example for a delivery: \"to the left of interior gate\".Permet d’afficher sur l’étiquette :

Exemple pour une livraison : « à gauche au portail intérieur ». " }, "pickupLocationId" : { "type" : "string", "description" : "N6
Pick-up location identifier for Colissimo out of home delivery.
This tag:
If the network code is \"X00\", the block must be set.Identifiant du point de retrait pour une livraison Colissimo hors domicile.

Cette balise :

Si le code réseau est \"X00\", il sera obligatoire de renseigner le bloc fields. " }, "ftd" : { "type" : "boolean", "description" : "B
Default: false
For overseas shipments
Mandatory, to be filled in by \"true\" (or \"1\"), for shipments to Overseas France only.Pour les envois vers l'outre-mer

Par défaut, renseigner \"false \" (ou \"0\").

Obligatoire, à renseigner par \"true \" (ou \"1\"), pour les envois vers l’Outre-Mer uniquement. " }, "ddp" : { "type" : "boolean", "description" : "B
Default: false
- For international shipments
Indicate \"1\" if the package is ddpPour les envois vers l’international

Indiquer « 1 » si le colis est ddp,

Par défaut, renseigner « 0 » (zéro) " }, "disabledDeliveryBlockingCode" : { "type" : "string", "description" : "Prerequisite: you must have activated the \"Code Bloquant\" service on the Colissimo Box.

Indicates whether delivery should be made without a blocking code (if no value is entered, eligible parcels will be delivered with a blocking code).

1 = true: Deactivates the blocking code
0 = False: Does not deactivate the blocking code
Empty = False: Does not deactivate the blocking codePrérequis : avoir activé le service \"Code Bloquant\" sur la Colissimo Box

Indique si la livraison doit se faire sans code bloquant. (Si aucune valeur n'est renseignée, les colis éligibles seront livrés avec code bloquant)

1 = true : Désactive le code bloquant
0 = False : Ne désactive pas le code bloquant
Vide = False : Ne désactive pas le code bloquant" }, "cod" : { "type" : "boolean", "description" : "B
Default: false
Indicates whether delivery should be made on a reimbursable basis.Indique si la livraison doit se faire contre remboursement.

Par défaut, renseigner \"0\" (zéro).

Passer à \"true\" (ou \"1\") si la livraison doit se faire contre remboursement. " }, "codcurrency" : { "type" : "string", "description" : "COD currencyCOD devise" }, "codamount" : { "type" : "integer", "description" : "N
Default: false (or 0)
Mandatory if the value of the tag COD is \"true\" (or \"1\").
Amount expected for cash on delivery.Montant attendu pour une livraison contre remboursement.

Par défaut, renseigner \"false\" (ou \"0\").

Obligatoire si la valeur de la balise COD est \"true\" (ou \"1\"). ", "format" : "int32" } }, "description" : "SUB
" }, "Sender" : { "type" : "object", "properties" : { "senderParcelRef" : { "type" : "string", "description" : "AN1...17
Sender Order Number.
It displays the customer reference only on the label. This data is not reflected in the Colissimo IT System and will not be visible in OSC.Référence de commande de l’expéditeur.
Elle permet d’afficher la référence client seulement sur l’étiquette.
Cette donnée n’est pas remontée dans le SI Colissimo et ne sera pas visible dans l'outil de Suivi Colis. " }, "address" : { "$ref" : "#/components/schemas/Address" } }, "description" : "SUB
" }, "Service" : { "required" : [ "depositDate", "productCode" ], "type" : "object", "properties" : { "productCode" : { "type" : "string", "description" : "L
Code indicating the desired product.
Example: code CORE for Colissimo Return.
If the tag is:
Code désignant l’offre produit souhaitée.

Exemple : code CORE pour Colissimo Retour.

Si la balise vaut : " }, "depositDate" : { "type" : "string", "description" : "D
Scheduled deposit date in the La Poste network.Example: \"2022-06-25\".Date de dépôt prévisionnelle dans le réseau La Poste.

Exemple : \"2022-06-25\"", "format" : "date-time" }, "mailBoxPicking" : { "type" : "boolean", "description" : "B
Default: false
Used if the tag is CORE (8R) or CORF (CQ).

Use if the former recipient of the parcel wishes to return it by placing it in his mailbox (offer “return mailbox”).
Enter \"true\" (or \"1\") so that the parcel, returned by its former recipient, can be collected by a Colissimo agent from the mailbox of the former recipient.Demander la collecte du colis retourné à partir d'une boîte aux lettres (retour BAL).

Utilisé pour autoriser le retour des colis en boîte aux lettres.

Utilisé pour le code CORE (8R)
et CORF (CQ).

Par défaut, renseigner \"false\" (ou \"0\").

Doit valoir \"true\" (ou \"1\") pour que le colis retourné par son ancien destinataire puisse être collecté par un agent de Colissimo à partir de la boîte aux lettres de l’ancien destinataire. " }, "mailBoxPickingDate" : { "type" : "string", "description" : "D
Used if the tag is CORE (8R) or CORF (CQ).
Mandatory only if mailBoxPicking is \"true\" (or \"1\").
Date requested for picking up from the mailbox.
Example: \"2022-06-25\".
To find out the next available date, call the getListMailBoxPickingDates method.
Date d’emport en boîte aux lettres demandée.

Utilisé pour le code CORE (8R) et CORF (CQ).

Obligatoire (et pris en compte) seulement si mailBoxPicking vaut \"true\" (ou \"1\").

Exemple : 2015-12-23
Pour connaître la prochaine date possible, appeler la méthode getListMailBoxPickingDates . ", "format" : "date-time" }, "vatCode" : { "type" : "integer", "description" : "N
Not used (La Poste internal use only)Non utilisé (utilisation interne à La Poste uniquement)", "format" : "int32" }, "vatPercentage" : { "type" : "integer", "description" : "N
Not used (La Poste internal use only)Non utilisé (utilisation interne à La Poste uniquement)", "format" : "int32" }, "vatAmount" : { "type" : "integer", "description" : "N
Not used (La Poste internal use only)Non utilisé (utilisation interne à La Poste uniquement)", "format" : "int32" }, "transportationAmount" : { "type" : "integer", "description" : "N
Default: false

Basic shipping price (carriage costs) without any options. In euro cents.

Example: 4530 for 45.30€.
Does not appear in the CN23 form.
Prix du transport de base (frais de port) sans les options éventuelles.

En centièmes d’euro
Exemple : 4530 pour 45,30€.
Par défaut, passer à \"0\".
N’apparaît pas dans le formulaire CN23. ", "format" : "int32" }, "totalAmount" : { "type" : "integer", "description" : "N
Mandatory for parcels requiring a CN23 declaration.
Basic shipping price increased by the price of shipment options. In euro cents.
Example: 4530 for 45.30€.
Appears in the CN23 form in the \"Frais de port\" field.Prix du transport de base augmenté du prix des options de l’envoi.

Obligatoire pour les colis nécessitant une déclaration CN23.

En centièmes d’euro.
Exemple : 4530 pour 45,30€.
Apparaît dans le formulaire CN23 dans le champ « Frais de port ». ", "format" : "int32" }, "orderNumber" : { "type" : "string", "description" : "AN1…30
Customer's order number.
Does not appear on the label but will be included in the Colissimo IT System.
Returned in tracking information.
Can be useful for searching for parcels using this field in the OSC tracking system (appears in the \"réf. client.\" field).Référence de commande du client.

N’apparait pas sur l’étiquette mais est intégré dans le SI Colissimo.
Renvoyée dans les fichiers de suivi de colis (EDI-Retour).

Peut être utile pour rechercher des colis selon ce champ dans l'outil de Suivi Colis (apparaît dans le champ « réf. client »). " }, "commercialName" : { "type" : "string", "description" : "AN
Commercial name of the shipper.
The tag is:
This name will be displayed in e-mail notifications sent to the parcel addressees.Nom commercial du chargeur.

Cette balise :

Ce nom sera affiché dans les notifications par e-mail faites aux destinataires des colis. " }, "returnTypeChoice" : { "type" : "integer", "description" : "L
Indicates whether the parcel must be returned to the sender in case of non-delivery of the parcel.
Mandatory for certain international parcels, according to the applicable tariff areas.Indique si le colis doit être retourné à l’expéditeur en cas de non distribution du colis.

Obligatoire pour certains colis à l’international selon les zones tarifaires applicables. ", "format" : "int32" }, "reseauPostal" : { "type" : "string", "description" : "B
This parameter enables the possibility to choose the network responsible of the shipping (DPD or the local postal network), for international shipments.
Ce paramètre permet de choisir le réseau postal responsable de la livraison (DPD ou réseau postal local) pour tout envoi de colis à l’international parmi les pays concernés et sur les produits concernés.



Le code erreur 30027 s’affiche lorsqu’un réseau postal (DPD ou réseau postal local) est choisit pour un produit qui ne comporte par l’option sélectionnée. " } }, "description" : "SUB
" }, "GenerateLabelRequest" : { "required" : [ "letter", "outputFormat" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "password" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "outputFormat" : { "$ref" : "#/components/schemas/OutputFormat" }, "letter" : { "$ref" : "#/components/schemas/Letter" }, "fields" : { "$ref" : "#/components/schemas/Fields" }, "customizationFields" : { "$ref" : "#/components/schemas/CustomizationFields" } } }, "GenerateCN23Request" : { "required" : [ "letter" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "password" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "letter" : { "$ref" : "#/components/schemas/Letter" }, "fields" : { "$ref" : "#/components/schemas/Fields" } } }, "GetListMailBoxPickingDatesRetourRequest" : { "required" : [ "sender" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "password" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "sender" : { "$ref" : "#/components/schemas/GetListMailBoxPickingDatesSender" } } }, "GetListMailBoxPickingDatesSender" : { "required" : [ "zipCode" ], "type" : "object", "properties" : { "line0" : { "type" : "string", "description" : "AN35
Floor, corridor, stairwell, flat numberEtage, couloir, escalier, appartement." }, "line1" : { "type" : "string", "description" : "AN35
Entrance, building, residence. Entrée, bâtiment, immeuble, résidence." }, "line2" : { "type" : "string", "description" : "AN35
Number and street name.

Example: \"5 rue du Bellay\"Numéro et libellé de voie.

Example: \\\"5 rue du Bellay\\\"" }, "line3" : { "type" : "string", "description" : "AN35
Named place or other mentionLieu-dit ou autre mention." }, "city" : { "type" : "string", "description" : "AN35
MunicipalityCommune." }, "zipCode" : { "type" : "string", "description" : "AN5
PostcodeCode postal." }, "countryCode" : { "type" : "string", "description" : "A2
Only the \"FR\" value is authorised.
Country code.Code pays.
Seule la valeur « FR » est autorisée." } }, "description" : "SUB
Block containing sender's addressBloc contenant les coordonnées du déposant en retour." }, "GetLabelInternalRequest" : { "required" : [ "outputPrintingType", "parcelNumber" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string" }, "password" : { "type" : "string" }, "parcelNumber" : { "type" : "string" }, "outputPrintingType" : { "type" : "string" } } }, "CheckInfoPlanPickupResponse" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" } }, "isValid" : { "type" : "boolean" } } }, "Message" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string" }, "messageContent" : { "type" : "string" } } }, "CheckInfoPlanPickupInternalRequest" : { "required" : [ "parcelNumber", "sender" ], "type" : "object", "properties" : { "parcelNumber" : { "type" : "string" }, "mailBoxPickingDate" : { "type" : "string", "format" : "date-time" }, "sender" : { "$ref" : "#/components/schemas/PlanPickupSender" } } }, "PlanPickupSender" : { "required" : [ "zipCode" ], "type" : "object", "properties" : { "companyName" : { "type" : "string", "description" : "AN35
Company nameRaison sociale." }, "lastName" : { "type" : "string", "description" : "AN35
Last nameNom." }, "firstName" : { "type" : "string", "description" : "AN29
First namePrénom." }, "line0" : { "type" : "string", "description" : "AN35
Floor, corridor, stairwell, flat numberEtage, couloir, escalier, appartement." }, "line1" : { "type" : "string", "description" : "AN35
Entrance, building, residence. Entrée, bâtiment, immeuble, résidence." }, "line2" : { "type" : "string", "description" : "AN35
Number and street name.

Example: \"5 rue du Bellay\"Numéro et libellé de voie.

Example: \\\"5 rue du Bellay\\\"" }, "line3" : { "type" : "string", "description" : "AN35
Named place or other mentionLieu-dit ou autre mention." }, "city" : { "type" : "string", "description" : "AN35
MunicipalityCommune." }, "zipCode" : { "type" : "string", "description" : "AN5
PostcodeCode postal." }, "countryCode" : { "type" : "string", "description" : "A2
Only the \"FR\" value is authorised.
Country code.Code pays.

Seule la valeur « FR » est autorisée." }, "email" : { "type" : "string", "description" : "AN80
Email address.
Used for sending tracking notifications to addressees.Adresse courriel.

Utilisé pour les notifications de suivi aux destinataires." }, "phoneNumber" : { "type" : "string", "description" : "AN15
TelephoneTéléphone." } }, "description" : "SUB
Block containing sender's addressBloc contenant les coordonnées du déposant en retour." }, "ListMailBoxPickingDatesRetourOnlineResponse" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" } }, "mailBoxPickingDateMaxHour" : { "type" : "string" }, "mailBoxPickingDates" : { "type" : "array", "items" : { "type" : "string", "format" : "date-time" } }, "validityTime" : { "type" : "string" } } }, "PlanPickupResponse" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" } } } }, "PlanPickupRequest" : { "required" : [ "mailBoxPickingDate", "parcelNumber", "sender" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "password" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "parcelNumber" : { "type" : "string", "description" : "AN13
Parcel numberNuméro de colis." }, "mailBoxPickingDate" : { "type" : "string", "description" : "D
Requested pick-up date.

Example: \"2022-06-25\"Date d’emport demandée.

Example: \\\"2022-06-25\\\"", "format" : "date-time" }, "sender" : { "$ref" : "#/components/schemas/PlanPickupSender" } } }, "ActivationDataFlavor" : { "type" : "object", "properties" : { "mimeType" : { "type" : "string" }, "humanPresentableName" : { "type" : "string" } } }, "AddressPCH" : { "type" : "object", "properties" : { "line0" : { "type" : "string" }, "line1" : { "type" : "string" }, "line2" : { "type" : "string" }, "line3" : { "type" : "string" }, "zipCode" : { "type" : "string" }, "city" : { "type" : "string" }, "countryCode" : { "type" : "string" } } }, "AddressPickupLocation" : { "type" : "object", "properties" : { "line1" : { "type" : "string" }, "line2" : { "type" : "string" }, "line3" : { "type" : "string" }, "line4" : { "type" : "string" }, "zipCode" : { "type" : "string" }, "city" : { "type" : "string" }, "countryCode" : { "type" : "string" }, "countryLabel" : { "type" : "string" } } }, "BelgiumLabel" : { "type" : "object", "properties" : { "codeVAS" : { "$ref" : "#/components/schemas/CodeVAS" }, "identification" : { "type" : "string" }, "codeBarre" : { "type" : "string" }, "returnAddress" : { "$ref" : "#/components/schemas/ReturnAddressBelgium" } } }, "CodeVAS" : { "type" : "object", "properties" : { "mention" : { "type" : "string" }, "deliveryMode" : { "type" : "string" }, "reserve" : { "type" : "string" }, "signature" : { "type" : "string" } } }, "CommandInfo" : { "type" : "object", "properties" : { "commandClass" : { "type" : "string" }, "commandName" : { "type" : "string" } } }, "CommandMap" : { "type" : "object", "properties" : { "mimeTypes" : { "type" : "array", "items" : { "type" : "string" } } } }, "DataHandler" : { "type" : "object", "properties" : { "dataSource" : { "$ref" : "#/components/schemas/DataSource" }, "name" : { "type" : "string" }, "inputStream" : { "type" : "object" }, "content" : { "type" : "object" }, "commandMap" : { "$ref" : "#/components/schemas/CommandMap" }, "transferDataFlavors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivationDataFlavor" } }, "preferredCommands" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CommandInfo" } }, "allCommands" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CommandInfo" } }, "contentType" : { "type" : "string" }, "outputStream" : { "type" : "object" } } }, "DataSource" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "inputStream" : { "type" : "object" }, "contentType" : { "type" : "string" }, "outputStream" : { "type" : "object" } } }, "ElementVisual" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "shortcut" : { "type" : "string" }, "position" : { "type" : "string" } } }, "GenerateLabelV2Response" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MessageRest" } }, "labelXmlV2Reponse" : { "$ref" : "#/components/schemas/XmlV2Response" }, "labelV2Response" : { "$ref" : "#/components/schemas/LabelV2Response" } } }, "LabelV2Response" : { "type" : "object", "properties" : { "label" : { "$ref" : "#/components/schemas/DataHandler" }, "cn23" : { "$ref" : "#/components/schemas/DataHandler" }, "parcelNumber" : { "type" : "string" }, "parcelNumberPartner" : { "type" : "string" }, "pdfUrl" : { "type" : "string" }, "fields" : { "$ref" : "#/components/schemas/Fields" } } }, "MessageRest" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string" }, "messageContent" : { "type" : "string" }, "replacementValues" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReplacementValue" } } } }, "PickupLocation" : { "type" : "object", "properties" : { "pointId" : { "type" : "string" }, "name" : { "type" : "string" }, "address" : { "$ref" : "#/components/schemas/AddressPickupLocation" }, "groupRouting" : { "type" : "string" }, "serviceLabel" : { "type" : "string" }, "sortDistribution" : { "type" : "string" }, "routingZipCode" : { "type" : "string" }, "netWork" : { "type" : "string" }, "idPartenaire" : { "type" : "string" }, "routingFileVersion" : { "type" : "string" } } }, "ReplacementValue" : { "type" : "object", "properties" : { "field" : { "type" : "string" }, "value" : { "type" : "string" }, "key" : { "type" : "string" }, "translatable" : { "type" : "boolean" } } }, "ReturnAddressBelgium" : { "type" : "object", "properties" : { "mention" : { "type" : "string" }, "line1" : { "type" : "string" }, "line2" : { "type" : "string" } } }, "Routing" : { "type" : "object", "properties" : { "destinationCountry" : { "type" : "string" }, "serviceText" : { "type" : "string" }, "depotDest" : { "type" : "string" }, "serviceMark" : { "type" : "string" }, "sortOrigin" : { "type" : "string" }, "groupingPriorityLabel" : { "type" : "string" }, "sortDest" : { "type" : "string" }, "barcodeId" : { "type" : "string" }, "routingVersion" : { "type" : "string" }, "destinationCountryText" : { "type" : "string" }, "partnerType" : { "type" : "string" }, "barcodePostcode" : { "type" : "string" }, "buAlphaStr" : { "type" : "string" }, "buCode" : { "type" : "string" }, "getcSort" : { "type" : "string" }, "destinationDepot" : { "type" : "string" }, "destinationDepotCountry" : { "type" : "string" }, "destinationDepotStr" : { "type" : "string" }, "getdSort" : { "type" : "string" }, "groupingPriority" : { "type" : "string" }, "networkCode" : { "type" : "string" }, "getoSort" : { "type" : "string" }, "partnerCode" : { "type" : "string" }, "getsSort" : { "type" : "string" }, "version" : { "type" : "string" }, "getdCountry" : { "type" : "string" }, "getdDepotCountry" : { "type" : "string" }, "getdDepot" : { "type" : "string" }, "getdDepotStr" : { "type" : "string" } } }, "Site" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "name" : { "type" : "string" }, "address" : { "$ref" : "#/components/schemas/AddressPCH" }, "rdepot" : { "type" : "string" } } }, "SwissLabel" : { "type" : "object", "properties" : { "injectionSite" : { "type" : "string" }, "signatureOption" : { "type" : "boolean" }, "codeSwissPost" : { "type" : "string" }, "swissParcelNumber" : { "type" : "string" } } }, "XmlV2Response" : { "type" : "object", "properties" : { "parcelNumber" : { "type" : "string" }, "parcelNumberPartner" : { "type" : "string" }, "contractNumber" : { "type" : "string" }, "sitePCH" : { "$ref" : "#/components/schemas/Site" }, "pickupLocation" : { "$ref" : "#/components/schemas/PickupLocation" }, "sender" : { "$ref" : "#/components/schemas/Sender" }, "addressee" : { "$ref" : "#/components/schemas/Addressee" }, "routing" : { "$ref" : "#/components/schemas/Routing" }, "zoneRouting" : { "$ref" : "#/components/schemas/ZoneRouting" }, "belgiumLabel" : { "$ref" : "#/components/schemas/BelgiumLabel" }, "barCodePCH" : { "type" : "string" }, "numberPCH" : { "type" : "string" }, "barCodeCityssimo" : { "type" : "string" }, "barCodeRouting" : { "type" : "string" }, "numberRouting" : { "type" : "string" }, "swissLabel" : { "$ref" : "#/components/schemas/SwissLabel" }, "hazmat" : { "$ref" : "#/components/schemas/DataHandler" }, "elementVisual" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ElementVisual" } }, "cabAztec" : { "type" : "string" }, "fields" : { "$ref" : "#/components/schemas/Fields" } } }, "ZoneCABRoutage" : { "type" : "object", "properties" : { "barCodeRouting" : { "type" : "string" }, "parcelNumberRouting" : { "type" : "string" } } }, "ZoneInfosRoutage" : { "type" : "object", "properties" : { "trackingNumberRouting" : { "type" : "string" }, "controlKeyTrackingNumber" : { "type" : "string" }, "getrDepot" : { "type" : "string" }, "identificationDestination1" : { "type" : "string" }, "identificationDestination2" : { "type" : "string" }, "serviceMark" : { "type" : "string" }, "typeServiceLivraison" : { "type" : "string" }, "sortOrigin" : { "type" : "string" }, "sortDest" : { "type" : "string" }, "routingVersion" : { "type" : "string" }, "datePrinting" : { "type" : "string" }, "hourPrinting" : { "type" : "string" }, "numberVersionWS" : { "type" : "string" }, "msort" : { "type" : "string" } } }, "ZoneRouting" : { "type" : "object", "properties" : { "zoneCABRoutage" : { "$ref" : "#/components/schemas/ZoneCABRoutage" }, "zoneInfosRoutage" : { "$ref" : "#/components/schemas/ZoneInfosRoutage" } } }, "EntityTag" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "weak" : { "type" : "boolean" } } }, "Link" : { "type" : "object", "properties" : { "uriBuilder" : { "$ref" : "#/components/schemas/UriBuilder" }, "rel" : { "type" : "string" }, "rels" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string" }, "params" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "type" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } }, "MediaType" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "subtype" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "wildcardType" : { "type" : "boolean" }, "wildcardSubtype" : { "type" : "boolean" } } }, "MultivaluedMapStringObject" : { "type" : "object", "properties" : { "empty" : { "type" : "boolean" } }, "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } }, "MultivaluedMapStringString" : { "type" : "object", "properties" : { "empty" : { "type" : "boolean" } }, "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "NewCookie" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" }, "version" : { "type" : "integer", "format" : "int32" }, "path" : { "type" : "string" }, "domain" : { "type" : "string" }, "comment" : { "type" : "string" }, "maxAge" : { "type" : "integer", "format" : "int32" }, "expiry" : { "type" : "string", "format" : "date-time" }, "secure" : { "type" : "boolean" }, "httpOnly" : { "type" : "boolean" }, "sameSite" : { "type" : "string", "enum" : [ "NONE", "LAX", "STRICT" ] } } }, "Response" : { "type" : "object", "properties" : { "mediaType" : { "$ref" : "#/components/schemas/MediaType" }, "status" : { "type" : "integer", "format" : "int32" }, "cookies" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/NewCookie" } }, "length" : { "type" : "integer", "format" : "int32" }, "location" : { "type" : "string", "format" : "uri" }, "language" : { "type" : "object", "properties" : { "language" : { "type" : "string" }, "displayName" : { "type" : "string" }, "country" : { "type" : "string" }, "variant" : { "type" : "string" }, "script" : { "type" : "string" }, "unicodeLocaleAttributes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "unicodeLocaleKeys" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "displayLanguage" : { "type" : "string" }, "displayScript" : { "type" : "string" }, "displayCountry" : { "type" : "string" }, "displayVariant" : { "type" : "string" }, "extensionKeys" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "iso3Language" : { "type" : "string" }, "iso3Country" : { "type" : "string" } } }, "date" : { "type" : "string", "format" : "date-time" }, "lastModified" : { "type" : "string", "format" : "date-time" }, "closed" : { "type" : "boolean" }, "metadata" : { "type" : "object", "properties" : { "empty" : { "type" : "boolean" } }, "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } }, "allowedMethods" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "statusInfo" : { "$ref" : "#/components/schemas/StatusType" }, "links" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Link" } }, "entityTag" : { "$ref" : "#/components/schemas/EntityTag" }, "stringHeaders" : { "type" : "object", "properties" : { "empty" : { "type" : "boolean" } }, "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "headers" : { "type" : "object", "properties" : { "empty" : { "type" : "boolean" } }, "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } }, "entity" : { "type" : "object" } } }, "StatusType" : { "type" : "object", "properties" : { "reasonPhrase" : { "type" : "string" }, "family" : { "type" : "string", "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] }, "statusCode" : { "type" : "integer", "format" : "int32" } } }, "UriBuilder" : { "type" : "object" }, "GenerateBordereauByParcelsNumbersRequest" : { "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "N6
Account numberNuméro de compte" }, "password" : { "type" : "string", "description" : "AN
Passwordmot de passe" }, "generateBordereauParcelNumberList" : { "$ref" : "#/components/schemas/generateBordereauParcelNumberList" }, "fields" : { "$ref" : "#/components/schemas/Fields" } } }, "generateBordereauParcelNumberList" : { "required" : [ "parcelsNumbers" ], "type" : "object", "properties" : { "parcelsNumbers" : { "type" : "array", "description" : "List of parcel numbersListe de numéros de colis", "items" : { "type" : "string", "description" : "List of parcel numbersListe de numéros de colis" } } }, "description" : "List of parcel numbersListe de numéros de colis" }, "GetLabelRequest" : { "type" : "object", "properties" : { "parcelNumber" : { "type" : "string", "description" : "AN13
Parcel numberNuméro de colis." }, "outputPrintingType" : { "type" : "string", "description" : "L
Label printing format.Format d'impression des étiquettes." } } }, "GetListMailBoxPickingDatesResponse" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" } }, "mailBoxPickingDateMaxHour" : { "type" : "string" }, "mailBoxPickingDates" : { "type" : "array", "items" : { "type" : "string", "format" : "date-time" } }, "validityTime" : { "type" : "string" } } }, "GetProductInterResponse" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" } }, "product" : { "type" : "array", "items" : { "type" : "string" } }, "partnerType" : { "type" : "string" }, "returnTypeChoice" : { "type" : "array", "items" : { "type" : "string" } } } }, "GetProductInterRequest" : { "required" : [ "productCode" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "password" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "productCode" : { "type" : "string", "description" : "A
" }, "insurance" : { "type" : "boolean", "description" : "B
Assured Value.

By default, enter \"false\" (or \"0\").Valeur Assurée.

Par défaut passer à \"false\" (ou \"0\"). " }, "nonMachinable" : { "type" : "boolean", "description" : "B
Parcel format.

By default, enter \"false\" (or \"0\").

Enter \"true\" (or \"1\") to indicate that the parcel format is nonstandard (non-machinable). Format du colis.

Par défaut, passer à \"false\" (ou \"0\").

Passer à \"true\" (ou \"1\") pour indiquer que le format du colis est non standard (non mécanisable). " }, "returnReceipt" : { "type" : "boolean", "description" : "B
Advice of receipt.

By default, enter \"false\" (or \"0\"). Avis de réception.

Par défaut, passer à \"false\" (ou \"0\"). " }, "countryCode" : { "type" : "string", "description" : "A2
ISO code of the country of destination.

Example: \"DE\" for Germany.Code ISO du pays de destination

Exemple : « DE » pour Allemagne. " }, "zipCode" : { "type" : "string", "description" : "AN
Addressee postcode.Code postal de destination." }, "city" : { "type" : "string", "description" : "AN35
Not used (La Poste internal use only)Non utilisé (usage interne à la poste seulement)" } } }, "GenerateLabelRequestV3" : { "required" : [ "letter", "outputFormat" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "password" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "outputFormat" : { "$ref" : "#/components/schemas/OutputFormat" }, "letter" : { "$ref" : "#/components/schemas/Letter" }, "fields" : { "$ref" : "#/components/schemas/Fields" }, "customizationFields" : { "$ref" : "#/components/schemas/CustomizationFields" } } }, "GenerateLabelRequestV31" : { "required" : [ "letter", "outputFormat" ], "type" : "object", "properties" : { "contractNumber" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "password" : { "type" : "string", "description" : "AN
Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\"." }, "outputFormat" : { "$ref" : "#/components/schemas/OutputFormat" }, "letter" : { "$ref" : "#/components/schemas/LetterRequestV31" }, "fields" : { "$ref" : "#/components/schemas/Fields" }, "customizationFields" : { "$ref" : "#/components/schemas/CustomizationFields" } } }, "LetterRequestV31" : { "required" : [ "addressee", "parcel", "service" ], "type" : "object", "properties" : { "service" : { "$ref" : "#/components/schemas/Service" }, "parcel" : { "$ref" : "#/components/schemas/ParcelRequestV31" }, "customsDeclarations" : { "$ref" : "#/components/schemas/CustomsDeclarations" }, "sender" : { "$ref" : "#/components/schemas/Sender" }, "addressee" : { "$ref" : "#/components/schemas/Addressee" }, "codSenderAddress" : { "$ref" : "#/components/schemas/Address" } }, "description" : "SUB
This block contains tags and blocks related to the shipment (options, parcel, sender, addressee, customs).
List sub-bocks (described below):
Ce bloc contient des balises et blocs liés à l’expédition (options, colis, expéditeur, destinataire, douanes).

Liste des sous-blocs (décrits plus bas) :
" }, "ParcelRequestV31" : { "required" : [ "weight" ], "type" : "object", "properties" : { "parcelNumber" : { "type" : "string", "description" : "AN13
Not used (La Poste internal use only)Non utilisé (utilisation interne à La Poste uniquement)" }, "insuranceAmount" : { "type" : "integer", "description" : "N
Not used (La Poste internal use only)Non utilisé (utilisation interne à La Poste uniquement)", "format" : "int32" }, "insuranceValue" : { "type" : "integer", "description" : "N
Insured value

By default, enter \"0\".

If the insurance option is chosen, enter the amount of the desired insurance level by selecting among one of the 6 levels below .
The amount must be written in cents. Example: 500000 for 5,000 EUR.

If the value entered does not match one of the 6 levels of insurance available, the value will be changed the level in which the entered amount is located. Example: 16200 for 162 EUR will become 30000 for 300 EUR.

6 optional insurance levels:

Maximum= 5000€.Valeur assurée.

Par défaut, renseigner \"0\".
Si l’option d’assurance est choisie, renseigner le montant du niveau d’assurance souhaité parmi les 6 niveaux proposés. Le montant doit être exprimé en centimes. Exemple : 500000 pour 5000 EUR.

Si la valeur renseignée ne correspond pas à l’un des 6 niveaux d’assurance, la valeur affichée sera celle du niveau dans lequel le montant renseigné se situe. Exemple : 16200 soit 162 EUR, deviendra 30000 EUR soit 300 EUR.

6 niveaux d’assurance optionnelle :

Maximum= 5000€.", "format" : "int32" }, "recommendationLevel" : { "type" : "string", "description" : "LevelNiveau" }, "weight" : { "type" : "number", "description" : "N
Weight of parcel in kg.
Example: \"5.50\".

parameter \"weight\":
The status of the customer account: a terminated customer account will not allow labels to be generated. Poids du colis en kg.
Exemple : \"5.50\". ", "format" : "float" }, "nonMachinable" : { "type" : "boolean", "description" : "B
Default: false
Parcel format.
If productCode is HD, enter \"false\" (or \"0\") by default.
Enter \"true\" (or \"1\") to indicate that parcel format is non-standard (non-machinable).Format du colis.
Si la balise productCode a les codes HD renseigner \"false\" (ou \"0\") par défaut.
Passer à \"true\" (ou \"1\") pour indiquer que le format du colis est non standard (non mécanisable). " }, "returnReceipt" : { "type" : "boolean", "description" : "B
Default: false
Advice of receiptAvis de réception.

Par défaut, renseigner \"false \" (ou \"0\"). " }, "instructions" : { "type" : "string", "description" : "AN1...35
Additional information:
Example for a delivery: \"to the left of interior gate\".Permet d’afficher sur l’étiquette :

Exemple pour une livraison : « à gauche au portail intérieur ». " }, "pickupLocationId" : { "type" : "string", "description" : "N6
Pick-up location identifier for Colissimo out of home delivery.
This tag:
If the network code is \"X00\", the block must be set.Identifiant du point de retrait pour une livraison Colissimo hors domicile.

Cette balise :

Si le code réseau est \"X00\", il sera obligatoire de renseigner le bloc fields. " }, "ftd" : { "type" : "boolean", "description" : "B
Default: false
For overseas shipments
Mandatory, to be filled in by \"true\" (or \"1\"), for shipments to Overseas France only.Pour les envois vers l'outre-mer

Par défaut, renseigner \"false \" (ou \"0\").

Obligatoire, à renseigner par \"true \" (ou \"1\"), pour les envois vers l’Outre-Mer uniquement. " }, "ddp" : { "type" : "boolean", "description" : "B
Default: false
- For international shipments
Indicate \"1\" if the package is ddpPour les envois vers l’international

Indiquer « 1 » si le colis est ddp,

Par défaut, renseigner « 0 » (zéro) " }, "disabledDeliveryBlockingCode" : { "type" : "string", "description" : "Prerequisite: you must have activated the \"Code Bloquant\" service on the Colissimo Box.

Indicates whether delivery should be made without a blocking code (if no value is entered, eligible parcels will be delivered with a blocking code).

1 = true: Deactivates the blocking code
0 = False: Does not deactivate the blocking code
Empty = False: Does not deactivate the blocking codePrérequis : avoir activé le service \"Code Bloquant\" sur la Colissimo Box

Indique si la livraison doit se faire sans code bloquant. (Si aucune valeur n'est renseignée, les colis éligibles seront livrés avec code bloquant)

1 = true : Désactive le code bloquant
0 = False : Ne désactive pas le code bloquant
Vide = False : Ne désactive pas le code bloquant" }, "hazmatFlag" : { "type" : "boolean", "description" : "Indicates whether the package contains a hazardous materialIndique si le colis contient une matière dangereuse" }, "hazmatCategory" : { "type" : "string", "description" : "Code (as defined in the contract) of the hazardous material categoryCode (comme définit dans le contrat) de la catégorie de matière dangereuse" }, "hazmatPrintLogo" : { "type" : "boolean", "description" : "Indicates whether the hazardous materials logo should be printed after the label. The logo will be printed in a 10x10 format only.Indique si le logo de matières dangereuses doit être imprimé après l’étiquette. Le logo sera imprimé dans un format 10x10 uniquement." }, "postCommand" : { "type" : "boolean" }, "cod" : { "type" : "boolean", "description" : "B
Default: false
Indicates whether delivery should be made on a reimbursable basis.Indique si la livraison doit se faire contre remboursement.

Par défaut, renseigner \"0\" (zéro).

Passer à \"true\" (ou \"1\") si la livraison doit se faire contre remboursement. " }, "codcurrency" : { "type" : "string", "description" : "COD currencyCOD devise" }, "codamount" : { "type" : "integer", "description" : "N
Default: false (or 0)
Mandatory if the value of the tag COD is \"true\" (or \"1\").
Amount expected for cash on delivery.Montant attendu pour une livraison contre remboursement.

Par défaut, renseigner \"false\" (ou \"0\").

Obligatoire si la valeur de la balise COD est \"true\" (ou \"1\"). ", "format" : "int32" } }, "description" : "SUB
" } } } }