Parcel Locker Location

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/usps/json-schema/usps-parcel-locker-location-schema.json",
  "title": "Parcel Locker Location",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/usps-locations-openapi.yml#/components/schemas/ParcelLockerLocation",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "facilityID": {
        "type": "string",
        "description": "Unique identifier of the Post Office where the parcel locker is located."
      },
      "locationName": {
        "type": "string",
        "description": "The name of the facility where the parcel locker is located."
      },
      "locationAddress": {
        "$ref": "#/$defs/DomesticAddress"
      },
      "latitude": {
        "type": "number",
        "description": "The latitude geo coordinate."
      },
      "longitude": {
        "type": "number",
        "description": "The longitude geo coordinate."
      },
      "deliveryAddress": {
        "$ref": "#/$defs/DomesticAddress"
      },
      "deliveryPoint": {
        "type": "string",
        "description": "2-digit Delivery Point Code (DPC) of the Parcel Locker."
      },
      "lockerStatus": {
        "type": "string",
        "description": "The current status of the parcel locker."
      },
      "lockerOnline": {
        "type": "boolean",
        "description": "Indicates whether the parcel locker is currently online or offline."
      },
      "lockerSizeMaximumLength": {
        "type": "number",
        "description": "Length of the largest locker.",
        "format": "double"
      },
      "lockerSizeMaximumWidth": {
        "type": "number",
        "description": "Width of the largest locker.",
        "format": "double"
      },
      "lockerSizeMaximumHeight": {
        "type": "number",
        "description": "Height of the largest locker.",
        "format": "double"
      },
      "serviceDirectShip": {
        "type": "boolean",
        "description": "Indicates whether the parcel locker can accept Direct-to-Locker packages."
      },
      "serviceRedelivery": {
        "type": "boolean",
        "description": "Indicates whether the parcel locker can accept redelivery packages."
      },
      "servicePOBoxOverflow": {
        "type": "boolean",
        "description": "Indicates whether the parcel locker can accept packages that do not fit into a PO Box."
      },
      "servicePrepaid": {
        "type": "boolean",
        "deprecated": true,
        "description": "DEPRECATED, replaced by `servicePrepaidReturns`. Indicates whether the parcel locker can accept prepaid returns packages."
      },
      "servicePrepaidReturns": {
        "type": "boolean",
        "description": "Indicates whether the parcel locker can accept prepaid returns packages."
      },
      "serviceLabelPrinting": {
        "type": "boolean",
        "description": "Indicates whether the parcel locker has printing capability."
      }
    }
  },
  "$defs": {
    "Address": {
      "title": "Address",
      "type": "object",
      "properties": {
        "streetAddress": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "description": "The number of a building along with the name of the road or street on which it is located."
        },
        "streetAddressAbbreviation": {
          "maxLength": 50,
          "minLength": 0,
          "type": "string",
          "description": "This is the abbreviation of street address line for the address.",
          "readOnly": true
        },
        "secondaryAddress": {
          "maxLength": 50,
          "type": "string",
          "description": "The secondary unit designator, such as apartment(APT) or suite(STE) number, defining the exact location of the address within a building.  For more information please see [Postal Explorer](https://pe.usps.com/text/pub28/28c2_003.htm)."
        },
        "cityAbbreviation": {
          "type": "string",
          "description": "This is the abbreviation of city name for the address.",
          "readOnly": true
        }
      },
      "additionalProperties": true,
      "description": "Address fields standard to all locations."
    },
    "DomesticAddress": {
      "title": "Domestic Address",
      "description": "Address fields for US locations",
      "allOf": [
        {
          "$ref": "#/$defs/Address"
        },
        {
          "type": "object",
          "properties": {
            "city": {
              "maxLength": 28,
              "minLength": 1,
              "type": "string",
              "description": "This is the city name of the address."
            },
            "state": {
              "maxLength": 2,
              "minLength": 2,
              "pattern": "^(AA|AE|AL|AK|AP|AS|AZ|AR|CA|CO|CT|DE|DC|FM|FL|GA|GU|HI|ID|IL|IN|IA|KS|KY|LA|ME|MH|MD|MA|MI|MN|MS|MO|MP|MT|NE|NV|NH|NJ|NM|NY|NC|ND|OH|OK|OR|PW|PA|PR|RI|SC|SD|TN|TX|UT|VT|VI|VA|WA|WV|WI|WY)$",
              "type": "string",
              "description": "This is two-character state code of the address."
            },
            "ZIPCode": {
              "pattern": "\\d{5}",
              "type": "string",
              "description": "This is the 5-digit ZIP code."
            },
            "ZIPPlus4": {
              "pattern": "\\d{4}",
              "type": "string",
              "description": "This is the ZIP+4 extension."
            },
            "urbanization": {
              "maxLength": 96,
              "type": "string",
              "description": "An area, sector, or residential development within a geographic area (typically used for addresses in Puerto Rico)"
            }
          },
          "additionalProperties": true
        }
      ]
    }
  }
}