United States Postal Service · JSON Structure

Carrier Pickup Pickup Update Request Structure

Request to update an existing carrier pickup.

Type: object Properties: 4 Required: 1
GovernmentPostal ServiceShippingLogisticsAddress ValidationPackage Tracking

PickupUpdateRequest is a JSON Structure definition published by United States Postal Service, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

confirmationNumber packages packageLocation specialInstructions

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-update-request-structure.json",
  "name": "PickupUpdateRequest",
  "description": "Request to update an existing carrier pickup.",
  "properties": {
    "confirmationNumber": {
      "description": "Confirmation number of the pickup to update.",
      "example": "WTC123456789",
      "type": "string"
    },
    "packages": {
      "description": "Updated package list.",
      "items": {
        "$ref": "#/components/schemas/PickupPackage"
      },
      "type": "array"
    },
    "packageLocation": {
      "description": "Updated package location.",
      "example": "BACK_DOOR",
      "type": "string"
    },
    "specialInstructions": {
      "description": "Updated special instructions.",
      "type": "string"
    }
  },
  "required": [
    "confirmationNumber"
  ],
  "type": "object"
}