United States Postal Service · JSON Structure

Carrier Pickup Pickup Package Structure

Package information for pickup.

Type: object Properties: 2
GovernmentPostal ServiceShippingLogisticsAddress ValidationPackage Tracking

PickupPackage is a JSON Structure definition published by United States Postal Service, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

serviceType count

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/united-states-postal-service/refs/heads/main/json-structure/carrier-pickup-pickup-package-structure.json",
  "name": "PickupPackage",
  "description": "Package information for pickup.",
  "properties": {
    "serviceType": {
      "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",
      "type": "string"
    },
    "count": {
      "description": "Number of packages of this service type.",
      "example": 1,
      "type": "int32"
    }
  },
  "type": "object"
}