openapi: 3.0.1
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ès non autorisé. (sid inexistant ou compte client inactif ou client résilié)</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ère une annonce informatique du colis et ses documents associés(étiquette et déclarations douaniè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 à 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/> "messages":Array[Message],<br/> "parcelNumber":String,<br/> "parcelNumberPartner":String<br/>}<br/><br/>Message<br/>{<br/> "id":String,<br/> "type":String,<br/> "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ès non autorisé. (sid inexistant ou compte client inactif ou client résilié)</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ès non autorisé. (sid inexistant ou compte client inactif ou client résilié)</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ès non autorisé. (sid inexistant ou compte client inactif ou client résilié)</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:
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
CodeVAS:
type: object
properties:
mention:
type: string
deliveryMode:
type: string
reserve:
type: string
signature:
type: string
PlanPickupResponse:
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Message'
SwissLabel:
type: object
properties:
injectionSite:
type: string
signatureOption:
type: boolean
codeSwissPost:
type: string
swissParcelNumber:
type: string
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
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>
CommandMap:
type: object
properties:
mimeTypes:
type: array
items:
type: string
ParcelRequestV31:
required:
- weight
type: object
properties:
parcelNumber:
type: string
description: <i>AN13</i> <br/> <lang><en>Not used (La Poste internal use only)</en><fr>Non utilisé (utilisation interne à La Poste uniquement)</fr></lang>
insuranceAmount:
type: integer
description: <i>N</i> <br/> <lang><en>Not used (La Poste internal use only)</en><fr>Non utilisé (utilisation interne à La Poste uniquement)</fr></lang>
format: int32
insuranceValue:
type: integer
description: '<i>N</i> <br/> <lang><en>Insured value <br/><br/> By default, enter "0".<br/><br/>If the insurance option is chosen, enter the amount of the desired insurance level by selecting among one of the 6 levels below . <br/> The amount must be written in cents. Example: 500000 for 5,000 EUR.<br/><br/> 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. <br/><br/> 6 optional insurance levels: <br/> <ul> <li>150 EUR ; </li> <li>300 EUR ; </li> <li>500 EUR ; </li> <li>1000 EUR ; </li> <li>2000 EUR ; </li> <li>5000 EUR ;</li></ul><br/>Maximum= 5000€.</en><fr>Valeur assurée. <br/><br/> Par défaut, renseigner "0". <br/> 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. <br/><br/> 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. <br/><br/>6 niveaux d’assurance optionnelle : <br/> <ul> <li>150 EUR ; </li> <li>300 EUR ; </li> <li>500 EUR ; </li> <li>1000 EUR ; </li> <li>2000 EUR ; </li> <li>5000 EUR ;</li></ul><br/>Maximum= 5000€.</fr></lang>'
format: int32
recommendationLevel:
type: string
description: <lang><en>Level</en><fr>Niveau</fr></lang>
weight:
type: number
description: '<i>N</i> <br/> <lang><en>Weight of parcel in kg. <br/> Example: "5.50". <br/><br/> <b>parameter "weight":</b> <ul> <li>Parcel weight in kg,</li> <li>Minimum: 0.01kg,</li> <li>Maximum: 30.00 kg or the maximum weight authorised by the pick-up location</li> <li>Only 2 decimals different from 0 are accepted.</li> </ul> <br/> <b>The status of the customer account:</b> a terminated customer account will not allow labels to be generated. </en><fr>Poids du colis en kg. <br/> Exemple : "5.50". </fr></lang>'
format: float
nonMachinable:
type: boolean
description: '<i>B</i> <br/> <lang><en>Default: false<br/>Parcel format.<br/>If productCode is <b>HD</b>, enter "false" (or "0") by default.<br/>Enter "true" (or "1") to indicate that parcel format is non-standard (non-machinable).</en><fr>Format du colis. <br/> Si la balise productCode a les codes <b>HD</b> renseigner "false" (ou "0") par défaut. <br/> Passer à "true" (ou "1") pour indiquer que le format du colis est non standard (non mécanisable). </fr></lang>'
returnReceipt:
type: boolean
description: '<i>B</i> <br/> <lang><en>Default: false<br/>Advice of receipt</en><fr>Avis de réception. <br/><br/> Par défaut, renseigner "false " (ou "0"). </fr></lang>'
instructions:
type: string
description: '<i>AN1...35</i> <br/> <lang><en>Additional information:<br/><ul><li>For the delivery labels,</li><li>For Colissimo Return labels (return pattern).</li></ul>Example for a delivery: "to the left of interior gate".</en><fr>Permet d’afficher sur l’étiquette : <br/> <ul> <li>Des indications complémentaires pour la livraison,</li> <li>Le motif du retour.</li> </ul> <br/> Exemple pour une livraison : « à gauche au portail intérieur ». </fr></lang>'
pickupLocationId:
type: string
description: '<i>N6</i> <br/> <lang><en>Pick-up location identifier for Colissimo out of home delivery.<br/>This tag:<br/><ul><li>Must be entered if the tag productCode is <b>HD</b></li><li>Must be blank if the tag productCode is <b>DOM or DOS.</b></li></ul>If the network code is "X00", the block <fields> must be set.</en><fr>Identifiant du point de retrait pour une livraison Colissimo hors domicile. <br/><br/> Cette balise : <br/> <ul> <li>Doit être renseignée si productCode vaut <b>HD</b></li> <li>Doit être vide si productCode vaut <b>DOM</b> ou <b>DOS.</b></li> </ul> <br/> Si le code réseau est "X00", il sera obligatoire de renseigner le bloc fields. </fr></lang>'
ftd:
type: boolean
description: '<i>B</i> <br/> <lang><en>Default: false<br/>For overseas shipments <br/>Mandatory, to be filled in by "true" (or "1"), for shipments to Overseas France only.</en><fr>Pour les envois vers l''outre-mer <br/><br/> Par défaut, renseigner "false " (ou "0"). <br/><br/>Obligatoire, à renseigner par "true " (ou "1"), pour les envois vers l’Outre-Mer uniquement. </fr></lang>'
ddp:
type: boolean
description: '<i>B</i> <br/> <lang><en>Default: false <br/>- For international shipments <br/>Indicate "1" if the package is ddp</en><fr>Pour les envois vers l’international <br/><br/> Indiquer « 1 » si le colis est ddp, <br/><br/> Par défaut, renseigner « 0 » (zéro) </fr></lang>'
disabledDeliveryBlockingCode:
type: string
description: '<lang><en>Prerequisite: you must have activated the "Code Bloquant" service on the Colissimo Box.<br/><br/>Indicates whether delivery should be made without a blocking code (if no value is entered, eligible parcels will be delivered with a blocking code).<br/><br/>1 = true: Deactivates the blocking code<br/>0 = False: Does not deactivate the blocking code<br/>Empty = False: Does not deactivate the blocking code</en><fr>Prérequis : avoir activé le service "Code Bloquant" sur la Colissimo Box<br/><br/>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)<br/><br/>1 = true : Désactive le code bloquant<br/>0 = False : Ne désactive pas le code bloquant<br/>Vide = False : Ne désactive pas le code bloquant</fr></lang>'
hazmatFlag:
type: boolean
description: <lang><en>Indicates whether the package contains a hazardous material</en><fr>Indique si le colis contient une matière dangereuse</fr></lang>
hazmatCategory:
type: string
description: <lang><en>Code (as defined in the contract) of the hazardous material category</en><fr>Code (comme définit dans le contrat) de la catégorie de matière dangereuse</fr></lang>
hazmatPrintLogo:
type: boolean
description: <lang><en>Indicates whether the hazardous materials logo should be printed after the label. The logo will be printed in a 10x10 format only.</en><fr>Indique si le logo de matières dangereuses doit être imprimé après l’étiquette. Le logo sera imprimé dans un format 10x10 uniquement.</fr></lang>
postCommand:
type: boolean
cod:
type: boolean
description: '<i>B</i> <br/> <lang><en>Default: false<br/>Indicates whether delivery should be made on a reimbursable basis.</en><fr>Indique si la livraison doit se faire contre remboursement. <br/> <br/> Par défaut, renseigner "0" (zéro). <br/><br/> Passer à "true" (ou "1") si la livraison doit se faire contre remboursement. </fr></lang>'
codcurrency:
type: string
description: <lang><en>COD currency</en><fr>COD devise</fr></lang>
codamount:
type: integer
description: '<i>N</i> <br/> <lang><en>Default: false (or 0)<br/>Mandatory if the value of the tag COD is "true" (or "1").<br/>Amount expected for cash on delivery.</en><fr>Montant attendu pour une livraison contre remboursement. <br/><br/> Par défaut, renseigner "false" (ou "0"). <br/><br/> Obligatoire si la valeur de la balise COD est "true" (ou "1"). </fr></lang>'
format: int32
description: <i>SUB</i> <br/> <lang><en></en><fr></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 Barcod
# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/la-poste/refs/heads/main/openapi/la-poste-slsservicews-documentation-api-openapi.yml