La Poste · Schema

GetProductInterRequest

PostalParcel TrackingAddress ValidationGeolocationShippingOpen DataFrance

Properties

Name	Type	Description
contractNumber	string	AN Deprecated. Use apikey instead as explained in "Acess to the Web Service SLS/API Authentication".Obsolète. Utiliser l'apikey à la place comme expliqué dans "Accès au
password	string	AN Deprecated. Use apikey instead as explained in "Acess to the Web Service SLS/API Authentication".Obsolète. Utiliser l'apikey à la place comme expliqué dans "Accès au
productCode	string	A
insurance	boolean	B Assured Value. By default, enter "false" (or "0").Valeur Assurée. Par défaut passer à "false" (ou "0").
nonMachinable	boolean	B Parcel format. By default, enter "false" (or "0"). Enter "true" (or "1") to indicate that the parcel format is nonstandard (non-machinable). For
returnReceipt	boolean	B Advice of receipt. By default, enter "false" (or "0"). Avis de réception. Par défaut, passer à "false" (ou "0").
countryCode	string	A2 ISO code of the country of destination. Example: "DE" for Germany.Code ISO du pays de destination Exemple : « DE » pour Allemagne.
zipCode	string	AN Addressee postcode.Code postal de destination.
city	string	AN35 Not used (La Poste internal use only)Non utilisé (usage interne à la poste seulement)

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/getproductinterrequest.json",
  "title": "GetProductInterRequest",
  "required": [
    "productCode"
  ],
  "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\u00e8te. Utiliser l'apikey \u00e0 la place comme expliqu\u00e9 dans \"Acc\u00e8s 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\u00e8te. Utiliser l'apikey \u00e0 la place comme expliqu\u00e9 dans \"Acc\u00e8s au Web Service SLS/Authentification API\".</fr></lang>"
    },
    "productCode": {
      "type": "string",
      "description": "<i>A</i> <br/>  <lang><en></en><fr></fr></lang>"
    },
    "insurance": {
      "type": "boolean",
      "description": "<i>B</i> <br/>  <lang><en>Assured Value. <br/><br/> By default, enter \"false\" (or \"0\").</en><fr>Valeur Assur&eacute;e.<br/><br/> Par d\u00e9faut passer \u00e0 \"false\" (ou \"0\"). </fr></lang>"
    },
    "nonMachinable": {
      "type": "boolean",
      "description": "<i>B</i> <br/>  <lang><en>Parcel format. <br/><br/> By default, enter \"false\" (or \"0\"). <br/><br/>   Enter \"true\" (or \"1\") to indicate that the parcel format is nonstandard (non-machinable). </en><fr>Format du colis. <br/><br/> Par d\u00e9faut, passer \u00e0 \"false\" (ou \"0\"). <br/><br/>Passer \u00e0 \"true\" (ou \"1\") pour indiquer que le format du colis est non standard (non m\u00e9canisable). </fr></lang>"
    },
    "returnReceipt": {
      "type": "boolean",
      "description": "<i>B</i> <br/>  <lang><en>Advice of receipt.<br/><br/> By default, enter \"false\" (or \"0\"). </en><fr>Avis de r\u00e9ception. <br/><br/> Par d\u00e9faut, passer \u00e0 \"false\" (ou \"0\"). </fr></lang>"
    },
    "countryCode": {
      "type": "string",
      "description": "<i>A2</i> <br/>  <lang><en>ISO code of the country of destination.<br/><br/>Example: \"DE\" for Germany.</en><fr>Code ISO du pays de destination <br/><br/> Exemple : \u00ab DE \u00bb pour Allemagne. </fr></lang>"
    },
    "zipCode": {
      "type": "string",
      "description": "<i>AN</i> <br/>  <lang><en>Addressee postcode.</en><fr>Code postal de destination.</fr></lang>"
    },
    "city": {
      "type": "string",
      "description": "<i>AN35</i> <br/>  <lang><en>Not used (La Poste internal use only)</en><fr>Non utilis\u00e9 (usage interne \u00e0 la poste seulement)</fr></lang>"
    }
  }
}