Fields

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/la-poste/main/json-schema/fields.json",
  "title": "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>\u201cUnique Label\u201d (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\u2022\tTracking parcel flag<br/>\r\n\u2022\tTotal number of packages<br/>\r\n\u2022\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\u2022\tMaster parcel flag<br/>\r\n\u2022\tIteration (order number of the package)<br/>\r\n\u2022\tTotal number of packages<br/>\r\nLimitation of 5 parcels in total<br/>\r\n\u2022\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             </field>\r\n    \n<b>CUSER_INFO_TEXT</b><br/>\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.<br/>\r\n    \n             <field>\r\n                 <key>CUSER_INFO_TEXT</key>\r\n                 <value>xxxxxxxxxxxxxxxxxx</value>\r\n             </field>\r\n    \n<b>CUSER_INFO_TEXT_4</b><br/>\r\nPartner reference (if given by your Colissimo contacts). Specific to the use of the service by our partners.<br/>\r\n    \n             <field>\r\n                 <key>CUSER_INFO_TEXT_4</key>\r\n                 <value>xxxxxxxxxxxxxxxxxx</value>\r\n             </field>\r\n    \n<br/>\r\n<b>EORI (Economics Operators Registration and Identification)</b><br/>\r\n<br/>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    <br/>\n  * Use the 'EORI' field for the sender's EORI (mandatory for shipments to the US).\r\n    \n             <field>\n                <key>EORI</key>\n                <value>1234567</value>\n             </field>\n             <field>\n                <key>EORI_ADRESSEE</key>\n                <value>1234567</value>\n             </field>\n</en><fr>Taille du colis en centim\u00e8tres: longueur, largeur et hauteur<br/>\r\nLongueur <= 274 cm<br/>\r\nLongueur + curconf\u00e9rence (2 x hauteur + 2 x largeur) <= 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>Code barre personnalis\u00e9</b><br/>\r\nAjouter un code barre personnalis\u00e9 sur les \u00e9tiquettes standards GEOLABEL conf. chapitre \"Option d'envoi/Code barres client\" (maximum 17 caract\u00e8res alpha num\u00e9riques et 25 num\u00e9riques)<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, affiche le code barre avec la valeur du champ CUSTOMER_BARCODE (voir les exemples d'etiquettes)<br/>\r\nIF PRINT_CUSTOMER_BARCODE = 2, affiche le code barre avec la valeur du num\u00e9ro de colis (voir les exemples d'etiquettes)<br/>\r\n<br/>\r\n<br/>\r\n<b>Etiquette avec r\u00e9f\u00e9rence client</b><br/>\r\nSur les \u00e9tiquettes standard GEOLABEL au format 10x15 et PDF , il est possible d'ajouter un texte personnalis\u00e9 de 15 caract\u00e8res maximum sous les \u00e9tiquettes.<br/>\r\nLe champ PRINT_CUSTOMER_LABEL permet d'afficher ou non le texte, et le champ CUSTOMER_LABEL pr\u00e9cise le texte.<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\nRemarque : il n'est pas possible d'afficher en m\u00eame temps un code \u00e0 barre personnalis\u00e9 et un texte personnalis\u00e9<br/>\r\n<br/>\r\nRemarque 2 : le texte personnalis\u00e9 n'appara\u00eetra pas sur l'\u00e9tiquette en cas de r\u00e9impression par getlabel (ou sur un automate La Poste).<br/>\r\n<br/>\r\n<b>CN23 format</b><br/>\r\nFormats sp\u00e9cifiques pour la CN23 :<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    \nFormats possibles :<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>une \u00e9tiquette unique (UL) incluant la CN23 sur la m\u00eame page</b> <br/>\r\nles formats accept\u00e9s sont : <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    \nLe format de la CN23 (output_print_type_CN23) et format de l'\u00e9tiquette (outputprinting type) doit \u00eatre le m\u00eame pour b\u00e9n\u00e9ficier de la fonctionnalit\u00e9 d'\u00e9tiquette unifi\u00e9e: <br/><br/>\r\nSi le colis n'est pas \u00e9ligile \u00e0 la CN23, le format affich\u00e9 sera<br/>\r\n(OutputFormat block: outputprinting type field).<br/>\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<br/>\r\nCette option \u00e9crase les personalisations suivantes : <br/>\r\n- Ajout d'une \u00e9tiquette personalis\u00e9e (PRINT_CUSTOMER_LABEL)<br/>\r\n- Ajout d'une r\u00e9f\u00e9rence CAB personalis\u00e9e (PRINT_CUSTOMER_BARCODE)<br/><br/>\r\n<b>Groupage de colis</b><br/>\r\n<br/>\r\n- Les param\u00e8tres additionnels du service sls pour tracer les colis sont les suivants : <br/>\r\n\u2022\tEtiquette de tra\u00e7age du colis<br/>\r\n\u2022\tNombre total de packages<br/>\r\n\u2022\tIteration (num\u00e9ro du 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- Les param\u00e8tres additionnels du service sls pour les colis master sont les suivants : <br/>\r\n\u2022\tEtiquette du colis master<br/>\r\n\u2022\tNombre total de packages<br/>\r\n\u2022\tIteration (num\u00e9ro du package)<br/>\r\n\u2022    Limitation \u00e0 5 colis<br/>\r\n\u2022\tListe des packages suivis<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\nCette saisie permet de notifier l'identifiant de la transaction attach\u00e9e \u00e0 un colis Colissimo<br/>\r\noffre payante en paiement diff\u00e9r\u00e9 et fractionn\u00e9.<br/>\r\nCe param\u00e8tre id est tronqu\u00e9 \u00e0 50 caract\u00e8res<br/>\r\n    \n             <field>\r\n                 <key>BNPL</key>\r\n                 <value>ID de transaction</value>\r\n             </field>\r\n    \n<b>CUSER_INFO_TEXT</b><br/>\r\nR\u00e9f\u00e9rence de recherche pour OSC. La r\u00e9f\u00e9rence peut \u00eatre unique ou partag\u00e9e sur plusieurs colis, afin de permettre de rechercher une liste de colis ayant la m\u00eame r\u00e9f\u00e9rence par exemple.<br/>\r\n    \n             <field>\r\n                 <key>CUSER_INFO_TEXT</key>\r\n                 <value>xxxxxxxxxxxxxxxxxx</value>\r\n             </field>\r\n    \n<b>CUSER_INFO_TEXT_4</b><br/>\r\nR\u00e9f\u00e9rence partenaire (si communiqu\u00e9e par vos interlocuteurs Colissimo). Sp\u00e9cifique \u00e0 l'utilisation du service par nos partenaires.<br/>\r\n    \n             <field>\r\n                 <key>CUSER_INFO_TEXT_4</key>\r\n                 <value>xxxxxxxxxxxxxxxxxx</value>\r\n             </field>\r\n    \n<br/>\r\n<b>EORI (Economics Operators Registration and Identification)</b><br/>\r\n<br/>Num\u00e9ros EORI de l'exp\u00e9diteur et/ou du destinataire qui seront visibles notamment sur la d\u00e9claration douani\u00e8re.\r\n  * Utiliser le champs 'EORI_ADDRESSEE' pour l'EORI du destinataire\r\n    <br/>\n  * Utiliser le champs 'EORI' pour l'EORI de l'exp\u00e9diteur (obligatoire pour les envois vers les US).\r\n    \n             <field>\n                <key>EORI</key>\n                <value>1234567</value>\n             </field>\n             <field>\n                <key>EORI_ADRESSEE</key>\n                <value>1234567</value>\n             </field>\n</fr></lang>",
      "items": {
        "$ref": "#/components/schemas/Field"
      }
    },
    "customField": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Field"
      }
    }
  },
  "description": "<i>SUB</i> <br/>  <lang><en></en><fr>Ce bloc peut \u00eatre utilis\u00e9 pour renseigner l\u2019identifiant <br/><br/> -Gestion des utilisateurs </b> <br/> -Colissimo Pass ID <br/> - GST <br/> - EORI </fr></lang>"
}