La Poste · Schema

GenerateLabelRequest

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
outputFormat object
letter object
fields object
customizationFields object
View JSON Schema on GitHub

JSON Schema

generatelabelrequest.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/la-poste/main/json-schema/generatelabelrequest.json",
  "title": "GenerateLabelRequest",
  "required": [
    "letter",
    "outputFormat"
  ],
  "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>"
    },
    "outputFormat": {
      "$ref": "#/components/schemas/OutputFormat"
    },
    "letter": {
      "$ref": "#/components/schemas/Letter"
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "customizationFields": {
      "$ref": "#/components/schemas/CustomizationFields"
    }
  }
}