United States Postal Service · Schema

PickupPackage

Package information for pickup.

GovernmentPostal ServiceShippingLogisticsAddress ValidationPackage Tracking

Properties

Name Type Description
serviceType string USPS service type for the package.
count integer Number of packages of this service type.
View JSON Schema on GitHub

JSON Schema

carrier-pickup-pickup-package-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/united-states-postal-service/refs/heads/main/json-schema/carrier-pickup-pickup-package-schema.json",
  "title": "PickupPackage",
  "description": "Package information for pickup.",
  "type": "object",
  "properties": {
    "serviceType": {
      "type": "string",
      "description": "USPS service type for the package.",
      "enum": [
        "APO/FPO/DPO",
        "PRIORITY_MAIL_EXPRESS",
        "PRIORITY_MAIL",
        "FIRST_CLASS_PACKAGE_SERVICE",
        "PARCEL_SELECT",
        "RETURNS"
      ],
      "example": "PRIORITY_MAIL"
    },
    "count": {
      "type": "integer",
      "description": "Number of packages of this service type.",
      "example": 1
    }
  }
}