{
"$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": "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\u201cUnique Label\u201d (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\u2022\tTracking parcel flag
\r\n\u2022\tTotal number of packages
\r\n\u2022\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\u2022\tMaster parcel flag
\r\n\u2022\tIteration (order number of the package)
\r\n\u2022\tTotal number of packages
\r\nLimitation of 5 parcels in total
\r\n\u2022\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\u00e8tres: longueur, largeur et hauteur
\r\nLongueur <= 274 cm
\r\nLongueur + curconf\u00e9rence (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\u00e9
\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)
\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\u00e9ro de colis (voir les exemples d'etiquettes)
\r\n
\r\n
\r\nEtiquette avec r\u00e9f\u00e9rence client
\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.
\r\nLe champ PRINT_CUSTOMER_LABEL permet d'afficher ou non le texte, et le champ CUSTOMER_LABEL pr\u00e9cise 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\u00eame temps un code \u00e0 barre personnalis\u00e9 et un texte personnalis\u00e9
\r\n
\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).
\r\n
\r\nCN23 format
\r\nFormats sp\u00e9cifiques 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 \u00e9tiquette unique (UL) incluant la CN23 sur la m\u00eame page
\r\nles formats accept\u00e9s 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'\u00e9tiquette (outputprinting type) doit \u00eatre le m\u00eame pour b\u00e9n\u00e9ficier de la fonctionnalit\u00e9 d'\u00e9tiquette unifi\u00e9e:
\r\nSi le colis n'est pas \u00e9ligile \u00e0 la CN23, le format affich\u00e9 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 \u00e9crase les personalisations suivantes :
\r\n- Ajout d'une \u00e9tiquette personalis\u00e9e (PRINT_CUSTOMER_LABEL)
\r\n- Ajout d'une r\u00e9f\u00e9rence CAB personalis\u00e9e (PRINT_CUSTOMER_BARCODE)
\r\nGroupage de colis
\r\n
\r\n- Les param\u00e8tres additionnels du service sls pour tracer les colis sont les suivants :
\r\n\u2022\tEtiquette de tra\u00e7age du colis
\r\n\u2022\tNombre total de packages
\r\n\u2022\tIteration (num\u00e9ro 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\u00e8tres additionnels du service sls pour les colis master sont les suivants :
\r\n\u2022\tEtiquette du colis master
\r\n\u2022\tNombre total de packages
\r\n\u2022\tIteration (num\u00e9ro du package)
\r\n\u2022 Limitation \u00e0 5 colis
\r\n\u2022\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\u00e9e \u00e0 un colis Colissimo
\r\noffre payante en paiement diff\u00e9r\u00e9 et fractionn\u00e9.
\r\nCe param\u00e8tre id est tronqu\u00e9 \u00e0 50 caract\u00e8res
\r\n \n \r\n BNPL\r\n ID de transaction\r\n \r\n \nCUSER_INFO_TEXT
\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.
\r\n \n \r\n CUSER_INFO_TEXT\r\n xxxxxxxxxxxxxxxxxx\r\n \r\n \nCUSER_INFO_TEXT_4
\r\nR\u00e9f\u00e9rence partenaire (si communiqu\u00e9e par vos interlocuteurs Colissimo). Sp\u00e9cifique \u00e0 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\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
\n * Utiliser le champs 'EORI' pour l'EORI de l'exp\u00e9diteur (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 \u00eatre utilis\u00e9 pour renseigner l\u2019identifiant
-Gestion des utilisateurs
-Colissimo Pass ID
- GST
- EORI "
}