La Poste · Schema

PlanPickupSender

SUB
Block containing sender's addressBloc contenant les coordonnées du déposant en retour.

PostalParcel TrackingAddress ValidationGeolocationShippingOpen DataFrance

Properties

Name	Type	Description
companyName	string	AN35 Company nameRaison sociale.
lastName	string	AN35 Last nameNom.
firstName	string	AN29 First namePrénom.
line0	string	AN35 Floor, corridor, stairwell, flat numberEtage, couloir, escalier, appartement.
line1	string	AN35 Entrance, building, residence. Entrée, bâtiment, immeuble, résidence.
line2	string	AN35 Number and street name. Example: "5 rue du Bellay"Numéro et libellé de voie. Example: \"5 rue du Bellay\"
line3	string	AN35 Named place or other mentionLieu-dit ou autre mention.
city	string	AN35 MunicipalityCommune.
zipCode	string	AN5 PostcodeCode postal.
countryCode	string	A2 Only the "FR" value is authorised. Country code.Code pays. Seule la valeur « FR » est autorisée.
email	string	AN80 Email address. Used for sending tracking notifications to addressees.Adresse courriel. Utilisé pour les notifications de suivi aux destinataires.
phoneNumber	string	AN15 TelephoneTéléphone.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/la-poste/main/json-schema/planpickupsender.json",
  "title": "PlanPickupSender",
  "required": [
    "zipCode"
  ],
  "type": "object",
  "properties": {
    "companyName": {
      "type": "string",
      "description": "<i>AN35</i> <br/>  <lang><en>Company name</en><fr>Raison sociale.</fr></lang>"
    },
    "lastName": {
      "type": "string",
      "description": "<i>AN35</i> <br/>  <lang><en>Last name</en><fr>Nom.</fr></lang>"
    },
    "firstName": {
      "type": "string",
      "description": "<i>AN29</i> <br/>  <lang><en>First name</en><fr>Pr\u00e9nom.</fr></lang>"
    },
    "line0": {
      "type": "string",
      "description": "<i>AN35</i> <br/>  <lang><en>Floor, corridor, stairwell, flat number</en><fr>Etage, couloir, escalier, appartement.</fr></lang>"
    },
    "line1": {
      "type": "string",
      "description": "<i>AN35</i> <br/>  <lang><en>Entrance, building, residence. </en><fr>Entr\u00e9e, b&acirc;timent, immeuble, r\u00e9sidence.</fr></lang>"
    },
    "line2": {
      "type": "string",
      "description": "<i>AN35</i> <br/>  <lang><en>Number and street name. <br/><br/>Example: \"5 rue du Bellay\"</en><fr>Num\u00e9ro et libell\u00e9 de voie. <br/><br/>Example: \\\"5 rue du Bellay\\\"</fr></lang>"
    },
    "line3": {
      "type": "string",
      "description": "<i>AN35</i> <br/>  <lang><en>Named place or other mention</en><fr>Lieu-dit ou autre mention.</fr></lang>"
    },
    "city": {
      "type": "string",
      "description": "<i>AN35</i> <br/>  <lang><en>Municipality</en><fr>Commune.</fr></lang>"
    },
    "zipCode": {
      "type": "string",
      "description": "<i>AN5</i> <br/>  <lang><en>Postcode</en><fr>Code postal.</fr></lang>"
    },
    "countryCode": {
      "type": "string",
      "description": "<i>A2</i> <br/>  <lang><en>Only the \"FR\" value is authorised. <br/>Country code.</en><fr>Code pays.<br/><br/>Seule la valeur \u00ab <b>FR</b> \u00bb est autoris\u00e9e.</fr></lang>"
    },
    "email": {
      "type": "string",
      "description": "<i>AN80</i> <br/>  <lang><en>Email address. <br/>Used for sending tracking notifications to addressees.</en><fr>Adresse courriel. <br/><br/> Utilis\u00e9 pour les notifications de suivi aux destinataires.</fr></lang>"
    },
    "phoneNumber": {
      "type": "string",
      "description": "<i>AN15</i> <br/>  <lang><en>Telephone</en><fr>T\u00e9l\u00e9phone.</fr></lang>"
    }
  },
  "description": "<i>SUB</i> <br/>  <lang><en>Block containing sender's address</en><fr>Bloc contenant les coordonn\u00e9es du d\u00e9posant en retour.</fr></lang>"
}