GetDocumentsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/purolator/main/json-schema/purolator-get-documents-request-schema.json",
  "title": "GetDocumentsRequest",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/purolator-get-documents-openapi.yml#/components/schemas/GetDocumentsRequest",
  "type": "object",
  "required": [
    "lineOfBusiness",
    "documentCriteria"
  ],
  "properties": {
    "lineOfBusiness": {
      "$ref": "#/$defs/LineOfBusiness"
    },
    "requestReference": {
      "$ref": "#/$defs/RequestReference"
    },
    "documentCriteria": {
      "type": "array",
      "minItems": 1,
      "maxItems": 50,
      "items": {
        "$ref": "#/$defs/DocumentCriteria"
      }
    }
  },
  "$defs": {
    "DocumentCriteria": {
      "type": "object",
      "required": [
        "shipmentPIN"
      ],
      "properties": {
        "shipmentPIN": {
          "type": "string",
          "description": "Shipment PIN whose documents should be retrieved."
        },
        "documentType": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "CustomsInvoice",
              "CustomsInvoiceThermal",
              "DangerousGoodsDeclaration",
              "DomesticBillOfLading",
              "DomesticBillOfLadingThermal",
              "ExpressChequeReceipt",
              "ExpressChequeReceiptThermal",
              "FDA2877",
              "InternationalBillOfLading",
              "InternationalBillOfLadingThermal",
              "QRCode",
              "USMCA"
            ]
          },
          "description": "Optional filter. When omitted, eligible documents for the shipment are returned."
        }
      }
    },
    "LineOfBusiness": {
      "type": "string",
      "enum": [
        "Courier",
        "Freight"
      ],
      "description": "Line of business. Case-insensitive. Only Courier is supported."
    },
    "RequestReference": {
      "type": "string",
      "maxLength": 36,
      "description": "A unique identifier for the request. Can be used to match request with the response. If not provided, a random UUID is generated."
    }
  }
}