GenerateLabelRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/colissimo/main/json-schema/colissimo-generate-label-request-schema.json",
  "title": "GenerateLabelRequest",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/colissimo-sls-openapi.yml#/components/schemas/GenerateLabelRequest",
  "required": [
    "letter",
    "outputFormat"
  ],
  "type": "object",
  "properties": {
    "contractNumber": {
      "type": "string",
      "description": "<i>AN</i> <br/>  <lang><en>Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".</en><fr>Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\".</fr></lang>"
    },
    "password": {
      "type": "string",
      "description": "<i>AN</i> <br/>  <lang><en>Deprecated. Use apikey instead as explained in \"Acess to the Web Service SLS/API Authentication\".</en><fr>Obsolète. Utiliser l'apikey à la place comme expliqué dans \"Accès au Web Service SLS/Authentification API\".</fr></lang>"
    },
    "outputFormat": {
      "$ref": "#/$defs/OutputFormat"
    },
    "letter": {
      "$ref": "#/$defs/Letter"
    },
    "fields": {
      "$ref": "#/$defs/Fields"
    },
    "customizationFields": {
      "$ref": "#/$defs/CustomizationFields"
    }
  },
  "$defs": {
    "Address": {
      "required": [
        "countryCode",
        "zipCode"
      ],
      "type": "object",
      "properties": {
        "companyName": {
          "type": "string",
          "description": "<i>AN35</i> <br/>  <lang><en>companyName <br/><br/>For return postage (product code CORE 8R, CORI 7R or 5R), the company name is mandatory for the recipient.</en><fr>Raison sociale. <br/><br/>Pour un affranchissement retour (code produit CORE 8R, CORI 7R ou 5R), la raison sociale est obligatoire pour le destinataire</fr></lang>"
        },
        "lastName": {
          "type": "string",
          "description": "<i>A1...35</i> <br/>  <lang><en>Last name.<br/>Mandatory to send a parcel unless zipcode is a cedex Code</en><fr>Nom.<br/><br/>Obligatoire pour envoyer un colis sauf si le code postal est un code cedex</fr></lang>"
        },
        "firstName": {
          "type": "string",
          "description": "<i>A1...29</i> <br/>  <lang><en>First name.<br/>Mandatory for out-of-home delivery (product code HD)</en><fr>Prénom.<br/><br/>Obligatoire pour un envoi hors domicile (code produit HD)</fr></lang>"
        },
        "line0": {
          "type": "string",
          "description": "<i>AN1...35</i> <br/>  <lang><en>Floor, hallway, stairs, apartment.<br/><br/><b>Important: this line does not appear on labels being sent to Switzerland.</b></en><fr>Etage, couloir, escalier, appart.</fr></lang>"
        },
        "line1": {
          "type": "string",
          "description": "<i>AN1...35</i> <br/>  <lang><en>Entrance, bulding, residence.<br/><br/><b>Important: this line does not appear on labels being sent to Switzerland.</b></en><fr>Entrée, bâtiment, immeuble, résidence.</fr></lang>"
        },
        "line2": {
          "type": "string",
          "description": "<i>AN1...35</i> <br/>  <lang><en>Number and route label.<br/><br/>Example: « 5 rue du Bellay »<br/><br/>must contain at least one character</en> <fr>Numéro et libellé de voie.<br/><br/> Exemple : « 5 rue du Bellay »<br/><br/>doit comporter impérativement au moins un caractère</fr></lang>"
        },
        "line3": {
          "type": "string",
          "description": "<i>AN1...35</i> <br/>  <lang><en>Place said or other mention.<br/><br/><b>Important: this line does not appear on labels being sent to Switzerland.</b></en><fr>Lieu dit ou autre mention.</fr></lang>"
        },
        "countryCode": {
          "type": "string",
          "description": "<i>A2</i> <br/>  <lang><en>ISO country code on 2 letters.<br/>Example: « FR » for France</en><fr>Code ISO du pays sur 2 lettres.<br/><br/>Ex : « FR » pour la France </fr></lang>"
        },
        "city": {
          "type": "string",
          "description": "<i>AN1...35</i> <br/>  <lang><en>Town.<br/><br/>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. *</en><fr>Ville.<br/><br/> 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. * </fr></lang>"
        },
        "zipCode": {
          "type": "string",
          "description": "<i>AN5</i> <br/>  <lang><en>Postal code.<br/>If the postcode matches a Cedex code then:<br/><ul><li>the tag line2 can be left blank,</li><li>the tag city can be left blank.</li></ul></en><fr>Code postal.<br/><br/> Si le code postal correspond à un code Cedex alors :<br/> <ul> <li>la balise line2 peut être laissée vide,</li> <li>la balise city peut être laissée vide.</li></ul><br/></fr></lang>"
        },
        "phoneNumber": {
          "type": "string",
          "description": "<i>AN10...12</i> <br/> <lang><en>Phone Number.</en><br/><fr>Numéro de téléphone.</fr></lang>"
        },
        "mobileNumber": {
          "type": "string",
          "description": "<i>AN</i> <br/> <lang><en>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).<br/>Checks performed :<ul><li>15 characters maximum</li><li>For Belgium parcel, the format must be exactly : +324NNNNNNNN</li></ul>It must be filled in for the following packages :<ul><li>Domestic out-of-home parcels (productCode=HD)</li><li>Parcels with DDP option</li><li>Parcels to the US</li></ul><br/><br/>For any international shipment, it is necessary to use the telephone prefix specific to the country in which your recipient is located.<br/><br/>The digits of the number must not follow an incremental sequence (e.g., 123456789), otherwise the WebService will return an error.</en><br/><fr>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).<br/>Contrôles effectués :<ul><li>15 caractères maximum</li><li>Pour les envois vers la Belgique, le format doit être exactement : +324NNNNNNNN</li></ul>Il doit être renseigné obligatoirement pour les colis suivants :<ul><li>Colis hors domicile (productCode=HD) nationaux</li><li>Colis avec l'option DDP</li><li>Colis vers les US</li></ul><br/><br/>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.<br/><br/>les chiffres du numéro ne doivent pas se suivre de manière incrémentale (ex. : 123456789), sinon le WebService retournera une erreur.</fr></lang>"
        },
        "doorCode1": {
          "type": "string",
          "description": "<i>AN1...8</i> <br/>  <lang><en>Door code 1.<br/>Doesn’t appear on the CN23 document.</en><fr>Code porte 1.<br/><br/>N’apparaît pas sur la CN23.</fr></lang>"
        },
        "doorCode2": {
          "type": "string",
          "description": "<i>AN1...8</i> <br/>  <lang><en>Door code 2.<br/>Doesn’t appear on the CN23 document.</en><fr>Code porte 2.<br/><br/>N’apparaît pas sur la CN23.</fr></lang>"
        },
        "intercom": {
          "type": "string",
          "description": "<i>AN1...30</i> <br/>  <lang><en>Interphone.<br/><br/>Doesn’t appear on the CN23 document.</en><fr>Interphone.<br/><br/>N’apparaît pas sur la CN23.</fr></lang>"
        },
        "email": {
          "type": "string",
          "description": "<i>AN5...80</i> <br/>  <lang><en>Mandatory if the tag productCode is <b>HD</b>.<br/><br/>Email Address.<br/>Used for follow-up notifications to the sender.<br/>Expected form: Text@Text.Text.</en><fr>Obligatoire pour les envois hors domiciles <br/><br/> Adresse courriel.<br/><br/>Utilisé pour les notifications de suivi à l’expéditeur.<br/><br/>Forme attendue : Texte@Texte.Texte  </fr></lang>"
        },
        "language": {
          "type": "string",
          "description": "<i>A2</i> <br/>  <lang><en>By default, the local language of the sending country.<br/>Language of the notification e-mail to the sender.<br/>Used for tracking notifications by email or SMS.<br/>The information is transmitted to local partners who can exploit it or not.</en><fr>Langue du mail de notification à l’expéditeur.<br/><br/> Utilisée pour les retours de colis avec le code produit <b>CORI</b> (7R) si la balise returnType est renseignée. <br/><br/> Utilisée pour les notifications de suivi par email ou SMS.<br/>Par défaut : FR <br/><br/> Langues disponibles : ES, IT, NL, EN, DE. </fr></lang>"
        },
        "stateOrProvinceCode": {
          "type": "string",
          "description": "<i>AN2</i> <br/>  <lang><en>State or province code. Required for the United States.</en><fr>Code de l'état ou de la province. Obligatoire pour les Etats Unis.</fr></lang>"
        }
      },
      "description": "<i>SUB</i> <br/>  <lang><en></en><fr></fr></lang>"
    },
    "Addressee": {
      "required": [
        "address"
      ],
      "type": "object",
      "properties": {
        "addresseeParcelRef": {
          "type": "string",
          "description": "<i>AN1...15</i> <br/>  <lang><en>Recipient order reference.<br/><b>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. </b></en><fr>Référence de commande du destinataire <br/> 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.</fr></lang>"
        },
        "codeBarForReference": {
          "type": "boolean",
          "description": "<i>B</i> <br/>  <lang><en>Default: false<br/>Used for Colissimo Retour only (tag productCode is <b>CORE</b>).<br/>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.<br/>Enter \"true\" (or \"1\") to show the value of the tag addresseeParcelRef as a barcode on the parcel label.</en><fr>Par défaut, renseigner \"false \" (ou \"0\").</fr></lang>"
        },
        "serviceInfo": {
          "type": "string",
          "description": "<i>AN</i> <br/>  <lang><en>Used for Colissimo Retour only (tag productCode is <b>CORE</b>).<br/>Name of the department in the company.<br/>Example: \"Returns department\".</en><fr></fr></lang>"
        },
        "promotionCode": {
          "type": "string",
          "description": "<i>AN</i> <br/>  <lang><en>Not used (La Poste internal use only)</en><fr>Non utilisé (usage interne à la poste uniquement)</fr></lang>"
        },
        "address": {
          "$ref": "#/$defs/Address"
        }
      },
      "description": "<i>SUB</i> <br/>  <lang><en></en><fr></fr></lang>"
    },
    "Article": {
      "required": [
        "description",
        "quantity",
        "value",
        "weight"
      ],
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "<i>AN1…64</i> <br/>  <lang><en>Detailed description of the article. Appears on CN23 document.<br/>Must be in English for the US and for shipments with the DDP option.</en><fr>Description détaillée de l’article. <br/> Apparaît sur le fichier CN23. <br/>Obligatoirement en anglais pour les US et pour les envois avec l'option DDP</fr></lang>"
        },
        "quantity": {
          "type": "integer",
          "description": "<i>N</i> <br/>  <lang><en>Number of articles of this type. Appears on CN23 document.</en><fr>Nombre d’articles de ce type. <br/> Apparaît sur le fichier CN23. </fr></lang>",
          "format": "int32"
        },
        "weight": {
          "type": "number",
          "description": "<i>N</i> <br/>  <lang><en>Unitary net weight of the articles in kg. Appears on CN23 document.</en><fr>Poids net unitaire des articles en kg. <br/> Apparaît sur le fichier CN23. </fr></lang>",
          "format": "float"
        },
        "value": {
          "type": "number",
          "description": "<i>N</i> <br/>  <lang><en>Unitary value of articles in EUROS.<br/>Appears on CN23 document.</en><fr>Valeur unitaire des articles en EURO. <br/> Apparaît sur le fichier CN23.</fr></lang>",
          "format": "float"
        },
        "hsCode": {
          "type": "string",
          "description": "<i>N6, N8 ou N10</i> <br/>  <lang><en>Mandatory if is 3 (commercial shipment). <br/>Mandatory for 7R and 5R return products. Then its size must be 6 or 11.<br/><br/>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. <br/><br/>Appears on CN23 document.</en><fr>Numéro tarifaire correspondant à l’article. <br/><br/> Il faudra indiquer 6, 8 ou 10 chiffres pour les envois à l’international nécessitant une déclaration douani&egrave;re.  <br/> Un code erreur 30519 apparaîtra dans la réponse du Web Service si la balise est mal renseignée. <br/><br/> Obligatoire si category vaut 3 (envoi commercial). <br/><br/> Obligatoire pour les produits retours 7R et 5R. Il doit être de taille 6 ou 11 <br/><br/> Apparaît sur le fichier CN23. </fr></lang>"
        },
        "originCountry": {
          "type": "string",
          "description": "<i>A2</i> <br/>  <lang><en>ISO code of the country of origin of the article. <br/><br/> Mandatory for 7R and 5R return products. It must be identical for all declared articles.<br/><br/> Mandatory if category = 3 (commercial shipment). <br/><br/>Country name appears on CN23 document. <br/><br/> If filled in, check that the country code is A2 otherwise set FR by default. <br/>If the country code is different from the format A2, the WS sls will return an error.</en><fr>Code ISO du pays d’origine de l’article. <br/><br/> Obligatoire pour les produits retours 7R et 5R. Il doit être identique pour tous les articles déclarés <br/><br/>  Obligatoire si category=3 (envoi commercial) <br/><br/> Le nom du pays apparait en entier sur le fichier CN23. <br/><br/> Si non vide, vérifier que le code pays est sur A2 sinon mettre FR par défaut.  <br/><br/> Si le code pays est différent du format A2, le WS sls retournera une erreur</fr></lang>"
        },
        "originCountryLabel": {
          "type": "string",
          "description": "<lang><en>Label</en><fr>Libellé</fr></lang>"
        },
        "currency": {
          "type": "string",
          "description": "<i>AN3</i> <br/>  <lang><en>Set EUR by default if empty<br/><br/>Mandatory for 7R and 5R return products.<br/><br/>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.|</en><fr>Devise. <br/><br/>Fixé par défaut en EUR si vide<br/><br/>Obligatoire pour les produits de retour 7R et 5R.<br/><br/>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.</fr></lang>"
        },
        "artref": {
          "type": "string",
          "description": "<i>AN1...35</i> <br/>  <lang><en>Mandatory for 7R and 5R return products.<br/><br/>Article reference, serial number.</en><fr>Référence de l’article, numéro de s&eacute;rie. <br/><br/> Obligatoire pour les produits retours inter (7R) hors UE et 5R (OM).</fr></lang>"
        },
        "originalIdent": {
          "type": "string",
          "description": "<i>A1</i> <br/>  <lang><en>Mandatory for 7R and 5R return products. <br/><br/>Key for identifying the outgoing invoice and the parcel related to the article.<br/><br/>Link up the parcel number with its sequencing: <br/><ul><li>if the article belongs to the 1st parcel, indicate A; </li><li>If the article belongs to the 3rd parcel, indicate C;</li><li>etc</li></ul></en><fr>Clé permettant d’identifier la facture aller et le colis lié à l’article. <br/><br/> Obligatoire pour les produits retours inter (7R) hors UE et 5R(OM). <br/> Appairer le numéro de colis avec son ordonnancement : <br/> <ul> <li>si l’article appartient au 1er colis, indiquer A ;</li> <li>si l’article appartient au 3ème colis, indiquer C ;</li> <li>etc …</li> </ul> </fr></lang>"
        },
        "vatAmount": {
          "type": "number",
          "description": "<i>N</i> <br/>  <lang><en>VAT on items</en><fr>TVA des articles</fr></lang>",
          "format": "float"
        },
        "customsFees": {
          "type": "number",
          "description": "<i>N</i> <br/>  <lang><en>Customs duties on items</en><fr>Droits Douane des articles</fr></lang>",
          "format": "float"
        }
      },
      "description": "<i>SUB</i> <br/>  <lang><en>The block can be repeated up to 100 times.</en><fr>Le bloc article peut être répété jusqu’à 100 fois.</fr></lang>"
    },
    "Category": {
      "type": "object",
      "properties": {
        "value": {
          "type": "integer",
          "description": "<i>N1</i> <br/>  <lang><en>Mandatory for products subject to a CN23 form.<br/>Type of shipment.</en><fr>Nature de l'envoi. <br/>Obligatoire pour les produits soumis à la CN23.</fr></lang>",
          "format": "int32"
        }
      },
      "description": "<i>SUB</i> <br/>  <lang><en>Mandatory for products subject to a CN23 form. <br/><br/>Block containing the tag related to the nature of the shipment.</en><fr>Bloc contenant la balise liée à la nature de l’envoi. <br/><br/> Obligatoire pour les produits soumis à la CN23.</fr></lang>"
    },
    "Contents": {
      "type": "object",
      "properties": {
        "article": {
          "type": "array",
          "description": "<i>SUB</i> <br/>  <lang><en>The block can be repeated up to 100 times.</en><fr>Le bloc article peut être répété jusqu’à 100 fois.</fr></lang>",
          "items": {
            "$ref": "#/$defs/Article"
          }
        },
        "category": {
          "$ref": "#/$defs/Category"
        },
        "original": {
          "type": "array",
          "description": "<i>SUB</i> <br/>  <lang><en></en><fr>Bloc contenant le (ou les) set(s) de données Original. <br/> Obligatoire pour les produits retours inter (7R) hors UE et 5R (OM). <br/> Au plus 5 sets de données Original sont agréés.<br/> Les colis sont identifiés selon l’ensemble </fr></lang>",
          "items": {
            "$ref": "#/$defs/Original"
          }
        },
        "explanations": {
          "type": "string",
          "description": "<i>AN1…35</i> <br/>  <lang><en></en><fr>A renseigner si la catégorie « retour de marchandise » ou « Autre » est choisie (cf. 0)</fr></lang>"
        }
      },
      "description": "<lang><en>This block represents the type of shipment and list of articles to declare.<br/>Mandatory if articles are eligible for the CN23 form.</en><fr>Ce bloc représente la nature de l’envoi et liste des articles à déclarer. <br/> Obligatoire si les envois sont éligibles à la CN23. </fr></lang>"
    },
    "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": "#/$defs/CustomizationTemplate"
          }
        },
        "customizationField": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CustomizationField"
          }
        }
      },
      "description": "<i>SUB</i> <br/>  <lang><en></en><fr>Ce bloc peut être utilisé pour personnaliser la partie inféririeure de l'étiquette <br/> </fr></lang>"
    },
    "CustomizationTemplate": {
      "type": "object",
      "properties": {
        "customizableReferenceKey": {
          "type": "integer",
          "format": "int32"
        },
        "customizableReferenceValue": {
          "type": "string"
        }
      }
    },
    "CustomsDeclarations": {
      "type": "object",
      "properties": {
        "includeCustomsDeclarations": {
          "type": "boolean",
          "description": "<i>B</i> <br/>  <lang><en>Default: false<br/>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.<br/><br/>The CN23 document:<br/><ul><li>Is included by default in the web service response (the tag is \"true\" -or \"1\"),</li><li>Is not generated if the value of the tag is \"false\" (or \"0\")</li></ul>  <br/> \"includeCustomsDeclarations = 1\" tag is mandatory for shipments eligible for dematerialization of customs documents (DDP option or DOM TOM shipment).</en><fr>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. <br/><br/> Par défaut vaut \"true\" (ou \"1\") pour inclure le document CN23 dans la réponse du web service.  <br/><br/> Indiquez \"false\" (ou \"0\") pour ne pas inclure le document CN23 dans la réponse du web service. <br/><br/> La balise « includeCustomsDeclarations = 1 » est obligatoire pour les envois éligibles à la dématérialisation des documents douaniers (option DDP ou envoi Outre-Mer). </fr></lang>"
        },
        "numberOfCopies": {
          "type": "integer",
          "description": "<i>N</i> <br/>  <lang><en>Number of CN23 to print<br/>If the tag is not filled in, 4 copies of CN23 will be printed.<br/>The number goes from 1 included to 4 copies max. <br/> Note: international returns do not take into account the value entered here, due to their specific format.</en><fr>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. <br/> Remarque : les produits retours internationaux ne tiennent pas compte de par leur format spécifique de la valeur renseignée ici.</fr></lang>",
          "format": "int32"
        },
        "contents": {
          "$ref": "#/$defs/Contents"
        },
        "importersReference": {
          "type": "string",
          "description": "<i>AN1…35</i> <br/>  <lang><en>Importer's reference, TVA number<br/>Appears on the CN23 document for shipments.<br/>Not used for returns.</en><fr>Référence de l’importateur, Numéro de TVA.<br/><br/> Apparaît sur le fichier CN23 pour les envois.<br/>N’est pas utilisé pour les retours. </fr></lang>"
        },
        "importersContact": {
          "type": "string",
          "description": "<i>AN35</i> <br/>  <lang><en>Importer's contact (tel./e-mail).<br/>Doesn’t appear on CN23 document.</en><fr>Contact (tél./e-mail) de l’importateur. <br/> N’apparaît pas sur le fichier CN23.</fr></lang>"
        },
        "officeOrigin": {
          "type": "string",
          "description": "<i>AN35</i> <br/>  <lang><en>Office origin.<br/>Doesn’t appear on CN23 document.</en><fr>Bureau d’origine. <br/> N’apparaît pas sur le fichier CN23.</fr></lang>"
        },
        "comments": {
          "type": "string",
          "description": "<i>AN35</i> <br/>  <lang><en>Observations<br/>Appears on CN23 document.</en><fr>Observations<br/>Apparaît sur le fichier CN23</fr></lang>"
        },
        "description": {
          "type": "string",
          "description": "<i>AN1.. ??</i> <br/>  <lang><en>Mandatory in the case of a DDP shipment<br/>Generic description of articles in English.<br/>Example: Textile items, Shoes, Music instrument, Hair dryer, etc.</en><fr>Description générique des articles en anglais. <br/> Obligatire dans le cas d’un envoi DDP <br/> Exemple : Textile items, Shoes, Music instrument, Hair dryer, etc  </fr></lang>"
        },
        "invoiceNumber": {
          "type": "string",
          "description": "<i>AN1...35</i> <br/>  <lang><en>Identifier of related invoice document.<br/>Appears in the « N° de la facture » field on the CN23 document.</en><fr>Identifiant du document facture lié.<br/> Apparaît dans le champ « N° de la facture » sur la CN23.</fr></lang>"
        },
        "licenceNumber": {
          "type": "string",
          "description": "<i>AN1…35</i> <br/>  <lang><en>Identifier of the related import license document.<br/>Appears in the « N° de la/les licences » field on the CN23 document.</en><fr>Identifiant du document de licence d’importation lié. <br/> Apparaît dans le champ « N° de la/les licences » sur la CN23.</fr></lang>"
        },
        "certificatNumber": {
          "type": "string",
          "description": "<i>AN1…35</i> <br/>  <lang><en>Identifier of the related certificate number document.<br/><br/>Appears in the « N° du/des certificats » field on the CN23 document.</en><fr>Identifiant du document de certificat lié. <br/> Apparaît dans le champ « N° du/des certificats » sur la CN23.</fr></lang>"
        },
        "importerAddress": {
          "$ref": "#/$defs/Address"
        }
      },
      "description": "<i>SUB</i> <br/>  <lang><en>These parameters are mandatory only for destinations requiring a CN23 customs declaration.</en><fr>Ces paramètres ne sont obligatoires que pour les destinations nécessitant une déclaration douanière de type CN23.</fr></lang>"
    },
    "Field": {
      "required": [
        "key",
        "value"
      ],
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "description": "<i>A</i> <br/>  <lang><en>Key word to be informed</en><fr>Mot clef à renseigner</fr></lang>"
        },
        "value": {
          "type": "string",
          "description": "<i>AN32</i> <br/>  <lang><en>The expected value is the order identifier in the SI Colissimo.</en><fr>Valeur attendue dans l'ordre identifié du SI Colissimo</fr></lang>"
        }
      }
    },
    "Fields": {
      "type": "object",
      "properties": {
        "field": {
          "type": "array",
          "description": "<lang><en>Package size in centimeters: length, width and height<br/>\r\nLength <= 274 cm<br/>\r\nLength + circumference (2 x height + 2 x width) <= 330 cm<br/>\r\n               \r\n               <field>\r\n                   <key>LENGTH</key>\r\n                   <value>30</value>\r\n               </field>\r\n               <field>\r\n                   <key>WIDTH</key>\r\n                   <value>20</value>\r\n               </field>\r\n               <field>\r\n                   <key>HEIGHT</key>\r\n                   <value>10</value>\r\n               </field>\r\n               \r\n<b>Customer Barcode</b><br/>\r\nAdding a custom barcode in GEOLABEL standard labels cf. chapter \"Available Shipment options/Customer Barcode\" (maximum 17 alpha-numeric and 25 numeric characters)<br/>\r\n               \r\n               <field>\r\n                      <key>PRINT_CUSTOMER_BARCODE</key>\r\n                      <value>1</value>\r\n               </field>\r\n               <field>\r\n                       <key>CUSTOMER_BARCODE</key>\r\n                       <value>REF12345678</value>\r\n               </field>\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)<br/>\r\nIF PRINT_CUSTOMER_BARCODE = 2, print the barcode with the value of the parcel number (see example of labels II.5.1.8)<br/>\r\n<br/>\r\n<br/>\r\n<b>Label with visible client tag</b><br/>\r\nOn standard GEOLABEL labels in 10x15 and PDF format, it is possible to add a customized 15 characters text below the label.<br/>\r\nThe PRINT_CUSTOMER_LABEL field allows the text to be displayed or not, and the CUSTOMER_LABEL field specifies the text.<br/>\r\n    \n             <field>\r\n                 <key>PRINT_CUSTOMER_LABEL</key>\r\n                 <value>1</value>\r\n             </field>\r\n    \n    \n             <field>\r\n                 <key>CUSTOMER_LABEL</key>\r\n                 <value>ABCDEFG</value>\r\n             </field>\r\n    \n<br/>\r\nNote: it is not possible to display a personalized barcode and a personalized text at the same time.<br/>\r\n<br/>\r\nNote 2: the personalized text will not appear on the label when reprinted by getlabel (or on a La Poste vending machine).<br/>\r\n<br/>\r\n<b>CN23 format</b><br/>\r\nAddition of a specific CN23 format :<br/>\r\n    \n             <field>\r\n                 <key>OUTPUT_PRINT_TYPE_CN23</key>\r\n                 <value>ZPL_10x12_203dpi</value>\r\n             </field>\r\n    \nFormat/value allowed :<br/>\r\nZPL_10x12_203dpi<br/>\r\nZPL_10x12_300dpi<br/>\r\nDPL_10x12_203dpi<br/>\r\nDPL_10x12_300dpi<br/>\r\nPDF_10x12_300dpi<br/>\r\nPDF_A4_300dpi<br/>\r\n<b>“Unique Label” (UL) including label and CN23 on the same page </b> <br/>\r\naccepted formats are : <br/>\r\nZPL_10x15_203dpi_UL<br/>\r\nZPL_10x15_300dpi_UL<br/>\r\nDPL_10x15_203dpi_UL<br/>\r\nDPL_10x15_300dpi_UL<br/>\r\nPDF_10x15_300dpi_UL<br/>\r\nPDF_A4_300dpi_UL<br/>\r\n    \n             <field>\r\n                 <key>OUTPUT_PRINT_TYPE_CN23</key>\r\n                 <value>PDF_10x15_300dpi_UL</value>\r\n             </field>\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 :<br/>\r\nIf the parcel is not eligible for CN23, then the label format will be printed<br/>\r\n(OutputFormat block: outputprinting type field).<br/>\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.<br/>\r\nThis option overrides the customization features :<br/>\r\n- Add a customer label (PRINT_CUSTOMER_LABEL)<br/>\r\n- Adding a customer reference CAB (PRINT_CUSTOMER_BARCODE)<br/><br/>\r\n<b>Group your Parcel</b><br/>\r\n<br/>\r\n- The additional input parameters of the WS SLS for tracked parcels are as follows:<br/>\r\n•\tTracking parcel flag<br/>\r\n•\tTotal number of packages<br/>\r\n•\tIteration (order number of the package)<br/>\r\n<br/>\r\n<br/>\r\n               <field>\r\n                  <key>TYPE_MULTI_PARCEL</key>\r\n                  <value>FOLLOWER</value>\r\n               </field>\r\n               <field>\r\n                  <key>PARCEL_ITERATION_NUMBER</key>\r\n                  <value>2</value>\r\n               </field>\r\n               <field>\r\n                  <key>TOTAL_NUMBER_PARCEL</key>\r\n                  <value>5</value>\r\n               </field>\r\n<br/>\r\n- The additional input parameters of the WS SLS for the master parcel are <br/>\r\n•\tMaster parcel flag<br/>\r\n•\tIteration (order number of the package)<br/>\r\n•\tTotal number of packages<br/>\r\nLimitation of 5 parcels in total<br/>\r\n•\tList of follow-up packages<br/>\r\n     \r\n     \r\n              <field>\n                   <key>TYPE_MULTI_PARCEL</key>\r\n                   <value>MASTER</value>\r\n             </field>\r\n             <field>\r\n                  <key>PARCEL_ITERATION_NUMBER</key>\r\n                   <value>2</value>\r\n             </field>\r\n             <field>\r\n                  <key>TOTAL_NUMBER_PARCEL</key>\r\n                   <value>5</value>\r\n             </field>\r\n             <field>\r\n                  <key>LIST_FOLLOWER_PARCEL</key>\r\n\t\t\t\t     <value>8Q53764663714/8Q53764663721/8Q53764663738/8Q53764663748/8Q53764663758</value>\r\n             </field>\r\n<br/>\r\n<b>BuyNowPayLater</b><br/>\r\nThis input is used to notify transaction id attached to a parcel as part of the Colissimo<br/>\r\npay offer for deferred and fractioned payment.<br/>\r\nThis id parameter is truncated at 50 characters<br/>\r\n    \n             <field>\r\n                 <key>BNPL</key>\r\n                 <value>ID de transaction</value>\r\n             

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://artifacts.apis.io/colissimo/json-schema/colissimo-generate-label-request-schema.json