La Poste SlsServiceWS : documentation API

openapi: 3.2.0
info:
  contact: {}
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: 'La Poste SlsInternalService : Services destinés aux applications internes SlsServiceWS : documentation API'
servers:
- url: http://api-etiquetage.colis.intra.laposte.fr/sls-ws/SlsServiceRest
tags:
- name: 'SlsServiceWS : documentation'
paths:
  /checkGenerateLabel:
    post:
      tags:
      - 'SlsServiceWS : documentation'
      summary: checkGenerateLabel
      description: <lang><en>Data control without label generation</en><fr>Contrôle des données sans génération d'étiquette</fr></lang>
      operationId: checkGenerateLabel_1
      parameters:
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        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: <lang><en>Functional error</en><fr>Erreur fonctionnel</fr></lang>
        '403':
          description: <lang><en>Token KO or Unauthorized access. (sid non-existent or customer account inactive or customer terminated)</en><fr>Token KO ou Acc&egrave;s non autoris&eacute;. (sid inexistant ou compte client inactif ou client r&eacute;sili&eacute;)</fr></lang>
        '500':
          description: <lang><en>Technical error or server error</en><fr>Erreur Technique ou erreur serveur</fr></lang>
        '422':
          description: <lang><en>The JSON input to the service is badly formatted</en><fr>Le JSON en entrée du service est mal formatté</fr></lang>
  /generateLabel:
    post:
      tags:
      - 'SlsServiceWS : documentation'
      summary: generateLabel
      description: '<lang><en>This method is provided to create shipments in relation to the following solutions, regardless of the product or associated destination:<br/><br/>Offre France: Colissimo Domicile, Point Retrait, Retour,<br/>Offre Internationale: Colissimo Expert, Domicile, Point Retrait, Retour,<br/>Offre Outre-Mer: Colissimo Domicile and Colissimo Eco.<br/><br/><br/>The products currently concerned are listed in the paragraph <b>III. 1 Products available.</b> La Poste - Colissimo may modify this list.<br/><br/>Important: it is preferable not to send an optional field when it is blank.</en><fr>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 :<ul><li>Offre France : Colissimo Domicile, Point Retrait, Retour,</li><li>Offre Internationale : Colissimo Expert, Domicile, Point Retrait, Retour,</li><li>Offre Outre-Mer : Colissimo Domicile et Colissimo Eco.</li></ul><b>Remarque</b> : il est recommandé de ne pas envoyer un champ facultatif plutôt que de l’envoyer vide. <br/><br/><hr /> Fonction principale d''affranchissement : <br/> Gén&egrave;re une annonce informatique du colis et ses documents associés(étiquette et déclarations douani&egrave;res)<br/><b>Réponse:</b> <br/>Ce service retourne une Map contenant un objet json et 0 à 3 tableaux d''octets. <br />La Map retournée est un objet MultipartBody. <br/>L''objet json est sauvegardé avec la clé "jsonInfos" et est de type "application-json". <br/>Les trois tableaux d''octets sont chacun sauvegardé avec les clés : <i>proforma, label et cn23</i>, et sont de type "application/octet-stream".<br /><hr /><b>Exemple de client en cxf :</b> <br/><br/><i>WebClient client = WebClient.create(URL);<br/>client.type("application/json").accept("multipart/mixed");<br/>MultipartBody bodyResponse = client.post(ObjetJsonRequete, MultipartBody.class);<br /><br/>A ce niveau, chaque objet sauvegardé dans la Map MultipartBody est récupéré grace &agrave sa clé.<br/>Pour le tableau d''octets "label", on utilise le code ci-dessous: <br/><br/>DataHandler dataHandler = bodyResponse.getAttachment("label").getDataHandler();<br/>InputStream is = dataHandler.getInputStream(); </i><hr/>L''objet jsonInfos a le format ci-dessous: <br/>{<br/>&nbsp;&nbsp;"messages":Array[Message],<br/>&nbsp;&nbsp;"parcelNumber":String,<br/>&nbsp;&nbsp;"parcelNumberPartner":String<br/>}<br/><br/>Message<br/>{<br/>&nbsp;&nbsp;"id":String,<br/>&nbsp;&nbsp;"type":String,<br/>&nbsp;&nbsp;"messageContent":String<br/>}</fr></lang>'
      operationId: generateLabel_1
      parameters:
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        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: <lang><en>Functional error</en><fr>Erreur fonctionnel</fr></lang>
        '403':
          description: <lang><en>Token KO or Unauthorized access. (sid non-existent or customer account inactive or customer terminated)</en><fr>Token KO ou Acc&egrave;s non autoris&eacute;. (sid inexistant ou compte client inactif ou client r&eacute;sili&eacute;)</fr></lang>
        '500':
          description: <lang><en>Technical error or server error</en><fr>Erreur Technique ou erreur serveur</fr></lang>
        '422':
          description: <lang><en>The JSON input to the service is badly formatted</en><fr>Le JSON en entrée du service est mal formatté</fr></lang>
  /generateCN23:
    post:
      tags:
      - 'SlsServiceWS : documentation'
      summary: generateCN23
      description: <lang><fr>Méthode permettant de générer le document douanier CN23</fr><en>Method for generating the CN23 customs document</en></lang>
      operationId: generateCN23_1
      parameters:
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        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: <lang><en>The method <b>getListMailBoxPickingDates()</b> indicates whether an address is eligible for shipment from a mailbox and, if so, what the date and time are of the  <br/>parcel pick-up from this address. <br/><br/>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.</en><fr>La méthode <b>getListMailBoxPickingDates()</b> 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. <br/><br/> 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.</fr></lang>
      operationId: getListMailBoxPickingDates_2
      parameters:
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        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: <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>
        schema:
          type: string
      - name: password
        in: header
        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>
        schema:
          type: string
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        schema:
          type: string
      - name: accountNumber
        in: header
        description: <i>N6</i> <br/> <lang><en>accountNumber</en><fr>accountNumber</fr></lang>
        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'
  /generateBordereauByParcelsNumbers:
    post:
      tags:
      - 'SlsServiceWS : documentation'
      summary: generateBordereauByParcelsNumbers
      description: '<lang><fr>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.</fr><en>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.</en></lang>'
      operationId: generateBordereauByParcelsNumbers_1
      parameters:
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        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: <lang><en>This method generates a token and associated documents if the customer wishes to secure the printing of these return labels. <br/><br/> The token and documents will enable customers to re-print a label at a post office or pick points.</en><fr></fr></lang>
      operationId: generateToken_1
      parameters:
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        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: <lang><en>Functional error</en><fr>Erreur fonctionnel</fr></lang>
        '403':
          description: <lang><en>Token KO or Unauthorized access. (sid non-existent or customer account inactive or customer terminated)</en><fr>Token KO ou Acc&egrave;s non autoris&eacute;. (sid inexistant ou compte client inactif ou client r&eacute;sili&eacute;)</fr></lang>
        '500':
          description: <lang><en>Technical error or server error</en><fr>Erreur Technique ou erreur serveur</fr></lang>
        '422':
          description: <lang><en>The JSON input to the service is badly formatted</en><fr>Le JSON en entrée du service est mal formatté</fr></lang>
  /getProductInter:
    post:
      tags:
      - 'SlsServiceWS : documentation'
      summary: getProductInter
      description: '<lang><en>This function, exclusively dedicated to international shipments, provides the return options compatible with the requested destination (e.g. <b>"paid return", "do not return"</b>). <br/><br/> 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 </en><fr>Cette fonction, dédiée exclusivement aux envois internationaux, fournit les options de retour compatibles avec la destination demandée (par exemple : <b>« retour payant », « ne pas retourner »</b>).<br/><br/>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</fr></lang>'
      operationId: getProductInter_1
      parameters:
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        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: <lang><en>Functional error</en><fr>Erreur fonctionnel</fr></lang>
        '403':
          description: <lang><en>Token KO or Unauthorized access. (sid non-existent or customer account inactive or customer terminated)</en><fr>Token KO ou Acc&egrave;s non autoris&eacute;. (sid inexistant ou compte client inactif ou client r&eacute;sili&eacute;)</fr></lang>
        '500':
          description: <lang><en>Technical error or server error</en><fr>Erreur Technique ou erreur serveur</fr></lang>
        '422':
          description: <lang><en>The JSON input to the service is badly formatted</en><fr>Le JSON en entrée du service est mal formatté</fr></lang>
  /planPickup:
    post:
      tags:
      - 'SlsServiceWS : documentation'
      summary: planPickup
      description: <lang><en>The method <b>planPickup ()</b> 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)</en><fr>La méthode <b>planPickup()</b> permet de faire une demande d’emport d’un colis retour déposé par l’expéditeur dans sa boîte aux lettres.<br/> Le colis doit avoir été préalablement annoncé auprès de La Poste. <br/> 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. <br/> Cette méthode est compatible avec le code produit CORE (8R Colissimo Retour France) et CORF (CQ Colissimo Retour International)</fr></lang>
      operationId: planPickup_2
      parameters:
      - name: apiKey
        in: header
        description: <lang><en>apiKey </en><fr>L'apiKey </fr></lang>
        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:
    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
    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
    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: '#/components/schemas/Address'
      description: <i>SUB</i> <br/>  <lang><en></en><fr></fr></lang>
    StatusType:
      type: object
      properties:
        reasonPhrase:
          type: string
        family:
          type: string
          enum:
          - INFORMATIONAL
          - SUCCESSFUL
          - REDIRECTION
          - CLIENT_ERROR
          - SERVER_ERROR
          - OTHER
        statusCode:
          type: integer
          format: int32
    CommandMap:
      type: object
      properties:
        mimeTypes:
          type: array
          items:
            type: string
    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'
    CustomizationTemplate:
      type: object
      properties:
        customizableReferenceKey:
          type: integer
          format: int32
        customizableReferenceValue:
          type: string
    MessageRest:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        messageContent:
          type: string
        replacementValues:
          type: array
          items:
            $ref: '#/components/schemas/ReplacementValue'
    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: '<i>SUB</i> <br/>  <lang><en>This block contains tags and blocks related to the shipment (options, parcel, sender, addressee, customs).<br/>List sub-bocks (described below): <br/><ul><li>Service: type of product and prices, </li><li>Parcel: insurances and options, </li><li>Sender: sender,</li><li>Addressee: addressee, </li><li>CustomsDeclarations: customs.</li></ul></en><fr>Ce bloc contient des balises et blocs liés à l’expédition (options, colis, expéditeur, destinataire, douanes).<br/><br/>Liste des sous-blocs (décrits plus bas) : <br/><ul><li>Service : type de produit et tarifs, </li><li>Parcel : assurances et options, </li><li>Sender : expéditeur ou déposant en retour </li><li>Addressee : destinataire,</li><li>CustomsDeclarations : douanes.</li></ul></fr></lang>'
    CheckGenerateLabelRequest:
      required:
      - letter
      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>
        letter:
          $ref: '#/components/schemas/Letter'
        outputFormat:
          $ref: '#/components/schemas/OutputFormat'
        fields:
          $ref: '#/components/schemas/Fields'
        customizationFields:
          $ref: '#/components/schemas/CustomizationFields'
    Fields:
      type: object
      properties:
        field:
          type: array
          description: "<lang><en>Package size in centimeters: length, width and height<br/>\nLength <= 274 cm<br/>\nLength + circumference (2 x height + 2 x width) <= 330 cm<br/>\n               \n               <field>\n                   <key>LENGTH</key>\n                   <value>30</value>\n               </field>\n               <field>\n                   <key>WIDTH</key>\n                   <value>20</value>\n               </field>\n               <field>\n                   <key>HEIGHT</key>\n                   <value>10</value>\n               </field>\n               \n<b>Customer Barcode</b><br/>\nAdding a custom barcode in GEOLABEL standard labels cf. chapter \"Available Shipment options/Customer Barcode\" (maximum 17 alpha-numeric and 25 numeric characters)<br/>\n               \n               <field>\n                      <key>PRINT_CUSTOMER_BARCODE</key>\n                      <value>1</value>\n               </field>\n               <field>\n                       <key>CUSTOMER_BARCODE</key>\n                       <value>REF12345678</value>\n               </field>\n\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/>\nIF PRINT_CUSTOMER_BARCODE = 2, print the barcode with the value of the parcel number (see example of labels II.5.1.8)<br/>\n<br/>\n<br/>\n<b>Label with visible client tag</b><br/>\nOn standard GEOLABEL labels in 10x15 and PDF format, it is possible to add a customized 15 characters text below the label.<br/>\nThe PRINT_CUSTOMER_LABEL field allows the text to be displayed or not, and the CUSTOMER_LABEL field specifies the text.<br/>\n    \n             <field>\n                 <key>PRINT_CUSTOMER_LABEL</key>\n                 <value>1</value>\n             </field>\n    \n    \n             <field>\n                 <key>CUSTOMER_LABEL</key>\n                 <value>ABCDEFG</value>\n             </field>\n    \n<br/>\nNote: it is not possible to display a personalized barcode and a personalized text at the same time.<br/>\n<br/>\nNote 2: the personalized text will not appear on the label when reprinted by getlabel (or on a La Poste vending machine).<br/>\n<br/>\n<b>CN23 format</b><br/>\nAddition of a specific CN23 format :<br/>\n    \n             <field>\n                 <key>OUTPUT_PRINT_TYPE_CN23</key>\n                 <value>ZPL_10x12_203dpi</value>\n             </field>\n    \nFormat/value allowed :<br/>\nZPL_10x12_203dpi<br/>\nZPL_10x12_300dpi<br/>\nDPL_10x12_203dpi<br/>\nDPL_10x12_300dpi<br/>\nPDF_10x12_300dpi<br/>\nPDF_A4_300dpi<br/>\n<b>“Unique Label” (UL) including label and CN23 on the same page </b> <br/>\naccepted formats are : <br/>\nZPL_10x15_203dpi_UL<br/>\nZPL_10x15_300dpi_UL<br/>\nDPL_10x15_203dpi_UL<br/>\nDPL_10x15_300dpi_UL<br/>\nPDF_10x15_300dpi_UL<br/>\nPDF_A4_300dpi_UL<br/>\n    \n             <field>\n                 <key>OUTPUT_PRINT_TYPE_CN23</key>\n                 <value>PDF_10x15_300dpi_UL</value>\n             </field>\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/>\nIf the parcel is not eligible for CN23, then the label format will be printed<br/>\n(OutputFormat block: outputprinting type field).<br/>\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/>\nThis option overrides the customization features :<br/>\n- Add a customer label (PRINT_CUSTOMER_LABEL)<br/>\n- Adding a customer reference CAB (PRINT_CUSTOMER_BARCODE)<br/><br/>\n<b>Group your Parcel</b><br/>\n<br/>\n- The additional input parameters of the WS SLS for tracked parcels are as follows:<br/>\n•\tTracking parcel flag<br/>\n•\tTotal number of packages<br/>\n•\tIteration (order number of the package)<br/>\n<br/>\n<br/>\n               <field>\n                  <key>TYPE_MULTI_PARCEL</key>\n                  <value>FOLLOWER</value>\n               </field>\n               <field>\n                  <key>PARCEL_ITERATION_NUMBER</key>\n                  <value>2</value>\n               </field>\n               <field>\n                  <key>TOTAL_NUMBER_PARCEL</key>\n                  <value>5</value>\n               </field>\n<br/>\n- The additional input parameters of the WS SLS for the master parcel are <br/>\n•\tMaster parcel flag<br/>\n•\tIteration (order number of the package)<br/>\n•\tTotal number of packages<br/>\nLimitation of 5 parcels in total<br/>\n•\tList of follow-up packages<br/>\n     \n     \n              <field>\n                   <key>TYPE_MULTI_PARCEL</key>\n                   <value>MASTER</value>\n             </field>\n             <field>\n                  <key>PARCEL_ITERATION_NUMBER</key>\n                   <value>2</value>\n             </field>\n             <field>\n                  <key>TOTAL_NUMBER_PARCEL</key>\n                   <value>5</value>\n             </field>\n             <field>\n                  <key>LIST_FOLLOWER_PARCEL</key>\n\t\t\t\t     <value>8Q53764663714/8Q53764663721/8Q53764663738/8Q53764663748/8Q53764663758</value>\n             </field>\n<br/>\n<b>BuyNowPayLater</b><br/>\nThis input is used to notify transaction id attached to a parcel as part of the Colissimo<br/>\npay offer for deferred and fractioned payment.<br/>\nThis id parameter is truncated at 50 characters<br/>\n    \n             <field>\n                 <key>BNPL</key>\n                 <value>ID de transaction</value>\n             </field>\n    \n<b>CUSER_INFO_TEXT</b><br/>\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/>\n    \n             <field>\n                 <key>CUSER_INFO_TEXT</key>\n                 <value>xxxxxxxxxxxxxxxxxx</value>\n             </field>\n    \n<b>CUSER_INFO_TEXT_4</b><br/>\nPartner reference (if given by your Colissimo contacts). Specific to the use of the service by our partners.<br/>\n    \n             <field>\n                 <key>CUSER_INFO_TEXT_4</key>\n                 <value>xxxxxxxxxxxxxxxxxx</value>\n             </field>\n    \n<br/>\n<b>EORI (Economics Operators Registration and Identification)</b><br/>\n<br/>EORI numbers of the sender and/or recipient, which will appear on the customs declaration.\n  * Use the 'EORI_ADDRESSEE' field for the recipient's EORI.\n    <br/>\n  * Use the 'EORI' field for the sender's EORI (mandatory for shipments to the US).\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ètres: longueur, largeur et hauteur<br/>\nLongueur <= 274 cm<br/>\nLongueur + curconférence (2 x hauteur + 2 x largeur) <= 330 cm<br/>\n               \n               <field>\n                   <key>LENGTH</key>\n                   <value>30</value>\n               </field>\n               <field>\n                   <key>WIDTH</key>\n                   <value>20</value>\n               </field>\n               <field>\n                   <key>HEIGHT</key>\n                   <value>10</value>\n               </field>\n               \n<b>Code barre personnalisé</b><br/>\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)<br/>\n               \n               <field>\n                      <key>PRINT_CUSTOMER_BARCODE</key>\n                      <value>1</value>\n               </field>\n               <field>\n                       <key>CUSTOMER_BARCODE</key>\n                       <value>REF12345678</value>\n               </field>\n\nIF PRINT_CUSTOMER_BARCODE = 1, affiche le code barre avec la valeur du champ CUSTOMER_BARCODE (voir les exemples d'etiquettes)<br/>\nIF PRINT_CUSTOMER_BARCODE = 2, affiche le code barre avec la valeur du numéro de colis (voir les exemples d'etiquettes)<br/>\n<br/>\n<br/>\n<b>Etiquette avec ré

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/la-poste/refs/heads/main/openapi/la-poste-slsservicews-documentation-api-openapi.yml