ReconciliationAdjustments

List of adjustments for a package

GovernmentPostal ServiceShippingLogisticsAddress ValidationPackage Tracking
View JSON Schema on GitHub

JSON Schema

usps-reconciliation-adjustments-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/usps/json-schema/usps-reconciliation-adjustments-schema.json",
  "title": "ReconciliationAdjustments",
  "description": "List of adjustments for a package",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/usps-reconciliation-adjustments-openapi.yml#/components/schemas/ReconciliationAdjustments",
  "type": "array",
  "items": {
    "$ref": "#/$defs/ReconciliationAdjustmentDetails"
  },
  "$defs": {
    "ReconciliationAdjustmentDetails": {
      "type": "object",
      "properties": {
        "trackingNumber": {
          "minLength": 0,
          "type": "string",
          "description": "The trackingNumber of the package."
        },
        "manifestNumber": {
          "minLength": 0,
          "type": "string",
          "description": "The manifest number (or electronic file number/EFN) of the package."
        },
        "adjustmentSubtype": {
          "type": "string",
          "description": "The Subscription Adjustment Subtype.",
          "enum": [
            "CENSUS",
            "DUPLICATES",
            "UNMANIFESTED"
          ]
        },
        "details": {
          "type": "array",
          "description": "Root cause for Census (Zone, Weight, Destination Entry, etc..)",
          "items": {
            "type": "string",
            "enum": [
              "WEIGHT",
              "DIMENSIONAL",
              "PACKAGING",
              "ZONE",
              "MISSHIPPED",
              "DESTINATION_ENTRY",
              "USED_REFUNDED_LABEL",
              "HAZMAT",
              "NONMAILABLE_DIMENSIONS",
              "NONMAILABLE_WEIGHT"
            ]
          }
        },
        "rootCause": {
          "type": "array",
          "description": "Array of root causes that contributed to the adjustment.  rootCause has been deprecated and is being replaced with adjustmentSubtype and details.",
          "deprecated": true,
          "items": {
            "type": "string",
            "enum": [
              "CENSUS",
              "WEIGHT",
              "DIMENSIONAL",
              "PACKAGING",
              "ZONE",
              "MISSHIPPED",
              "DESTINATION_ENTRY",
              "UNMANIFESTED",
              "DUPLICATES",
              "USED_REFUNDED_LABEL",
              "HAZMAT",
              "NONMAILABLE_DIMENSIONS",
              "NONMAILABLE_WEIGHT"
            ]
          }
        },
        "pricingCharacteristics": {
          "description": "Pricing ingredients of the adjustment",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "pricingCharacteristic": {
                "type": "string",
                "description": "| Enumeration | Format | Example |\n| -- | -- | -- |\n| WEIGHT | number | 4.1 |\n| DIM_WEIGHT | number | 11.8 |\n| LENGTH | number | 8.6 |\n| WIDTH | number | 4.2 |\n| HEIGHT | number | 3.5 |\n| ORIGIN_ZIP_CODE | string | 20260 |\n| DESTINATION_ZIP_CODE | string | 20260 |\n| ZONE | string | 01 |\n| DESTINATION_ENTRY_FACILITY_TYPE | string | Temp |\n| RATE_INDICATOR | string | SP |\n| MAIL_CLASS | string | PRIORITY_MAIL |",
                "enum": [
                  "WEIGHT",
                  "DIM_WEIGHT",
                  "LENGTH",
                  "WIDTH",
                  "HEIGHT",
                  "ORIGIN_ZIP_CODE",
                  "DESTINATION_ZIP_CODE",
                  "ZONE",
                  "DESTINATION_ENTRY_FACILITY_TYPE",
                  "RATE_INDICATOR",
                  "MAIL_CLASS"
                ]
              },
              "claimed": {
                "minLength": 0,
                "description": "Manifest value of the ingredient",
                "type": "string"
              },
              "assessed": {
                "minLength": 0,
                "description": "The census value for the ingredient",
                "type": "string"
              }
            }
          }
        },
        "USPSPackagingBarcode": {
          "minLength": 0,
          "type": "string",
          "description": "USPS Packaging used for the shipment"
        },
        "postageAdjustment": {
          "minimum": 0,
          "type": "number",
          "description": "The postage charged for the adjustment.  A positive postageAdjustment is overpaid (REFUND).  A negative postageAdjustment is shortpaid (ADJUSTMENT).",
          "format": "double"
        },
        "assessedDateTime": {
          "type": "string",
          "description": "Datetime the package was assessed.",
          "format": "date-time"
        },
        "adjustmentTotalPostage": {
          "type": "object",
          "properties": {
            "claimed": {
              "minimum": 0.0,
              "description": "Manifest value of the ingredient including fees and extra services.",
              "type": "number",
              "format": "double"
            },
            "assessed": {
              "minimum": 0.0,
              "description": "Assessed postage based on census scan.",
              "type": "number",
              "format": "double"
            }
          },
          "description": "Total postage for the package including any adjustments."
        },
        "adjustmentBasePostage": {
          "type": "object",
          "properties": {
            "claimed": {
              "minimum": 0.0,
              "description": "Manifest value of the ingredient excluding fees and extra services.",
              "type": "number",
              "format": "double"
            },
            "assessed": {
              "minimum": 0.0,
              "description": "The census value for the ingredient excluding fees and extra services.",
              "type": "number",
              "format": "double"
            }
          },
          "description": "The claimed and assessed base postage for the package (minus fees and extra services)."
        },
        "totalPostage": {
          "deprecated": true,
          "type": "object",
          "properties": {
            "claimed": {
              "minimum": 0.0,
              "description": "Manifest value of the ingredient",
              "type": "number",
              "format": "double"
            },
            "assessed": {
              "minimum": 0.0,
              "description": "The census value for the ingredient",
              "type": "number",
              "format": "double"
            }
          },
          "description": "The claimed and assessed total postage for the package."
        },
        "basePostage": {
          "deprecated": true,
          "type": "object",
          "properties": {
            "claimed": {
              "minimum": 0.0,
              "description": "Manifest value of the ingredient",
              "type": "number",
              "format": "double"
            },
            "assessed": {
              "minimum": 0.0,
              "description": "The census value for the ingredient",
              "type": "number",
              "format": "double"
            }
          },
          "description": "The claimed and assessed base postage for the package (minus fees and extra services)."
        },
        "fees": {
          "type": "array",
          "description": "The claimed and assessed fees for the package.",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "description": "Name of the fee",
                "type": "string",
                "enum": [
                  "NONSTANDARD_DIMENSION_LENGTH_LT_22",
                  "NONSTANDARD_DIMENSION_LENGTH_GT_30",
                  "NONSTANDARD_DIMENSION_VOLUME_GT_2_CUBIC_FEET",
                  "NONSTANDARD_DIMENSION_NON_COMPLIANCE",
                  "NONSTANDARD_CHARACTERISTICS_FEE",
                  "HAZMAT_NONCOMPLIANCE_FEE"
                ]
              },
              "claimedPostage": {
                "minimum": 0.0,
                "description": "Manifest value of the ingredient for postage",
                "type": "number",
                "format": "double"
              },
              "assessedPostage": {
                "minimum": 0.0,
                "description": "The census value for the ingredient",
                "type": "number",
                "format": "double"
              }
            }
          }
        },
        "hazmatNoncomplianceErrorMessage": {
          "maxLength": 255,
          "type": "string",
          "description": "The hazmat error description of the adjustment due to hazardous materials non-compliance. \nExamples of the error message include: \n- \"HAZMAT SYMBOL AND NON-HAZMAT STC\"   \n- \"HAZMAT INDICATOR AND NON-HAZMAT STC\" \n- \"MILITARY ITEM WITH HAZMAT INDICATOR NONCOMPLIANCE\" \n- \"BARCODE BANNER TEXT INCORRECT FOR HAZMAT ITEM\"\n"
        },
        "accountNumber": {
          "minLength": 0,
          "type": "string",
          "description": "The Enterprise Payment Account the adjustment was charged to."
        },
        "transactionID": {
          "minLength": 0,
          "type": "string",
          "description": "The Enterprise Payment System Transaction ID the adjustment was charged to."
        },
        "earliestScanDate": {
          "minLength": 0,
          "type": "string",
          "description": "Earliest Datetime USPS scanned the package.",
          "format": "date-time"
        },
        "MID": {
          "minLength": 0,
          "maxLength": 10,
          "pattern": "^(\\d{6}|\\d{9})$",
          "type": "string",
          "description": "Mailer ID used in the barcode to identify the Mail Owner associated to a shipment."
        },
        "CRID": {
          "maxLength": 15,
          "minLength": 8,
          "type": "string",
          "description": "Customer Registration ID used to identify the business location associated to a shipment."
        },
        "adjustmentStatus": {
          "description": "The status of the adjustment",
          "type": "string",
          "enum": [
            "PENDING",
            "CHARGED",
            "REMOVED"
          ]
        },
        "extraServices": {
          "type": "array",
          "description": "Array of extra services associated with the shipment.",
          "items": {
            "type": "object",
            "properties": {
              "extraServiceName": {
                "minLength": 0,
                "description": "Name of the extra service",
                "type": "string"
              },
              "extraServiceSku": {
                "minLength": 0,
                "description": "SKU code for the extra service",
                "type": "string"
              },
              "extraServiceAmount": {
                "minimum": 0.0,
                "description": "Amount charged for the extra service",
                "type": "number",
                "format": "double"
              },
              "extraServiceCode": {
                "maxLength": 3,
                "description": "Number associated with the extra service",
                "type": "string"
              }
            }
          }
        },
        "originAddress": {
          "minLength": 0,
          "type": "string",
          "description": "Origin address associated to a shipment."
        },
        "originCity": {
          "minLength": 0,
          "type": "string",
          "description": "Origin city associated to a shipment."
        },
        "originState": {
          "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": "Origin state associated to a shipment."
        },
        "originZIPCode": {
          "maxLength": 5,
          "pattern": "^\\d{5}$",
          "type": "string",
          "description": "Origin zipcode associated to a shipment."
        },
        "destinationAddress": {
          "minLength": 0,
          "type": "string",
          "description": "Destination address associated to a shipment."
        },
        "destinationCity": {
          "minLength": 0,
          "type": "string",
          "description": "Destination city associated to a shipment."
        },
        "destinationState": {
          "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": "Destination state associated to a shipment."
        },
        "destinationZipCode": {
          "pattern": "^\\d{5}$",
          "type": "string",
          "description": "Destination zipcode associated to a shipment."
        },
        "destinationCountryCode": {
          "maxLength": 2,
          "type": "string",
          "description": "The destination country code associated to the shipment."
        },
        "packageScanGroupingId": {
          "maxLength": 36,
          "type": "string",
          "description": "A Unique ID used to group scans for a package."
        },
        "manifestPackageId": {
          "maxLength": 36,
          "type": "string",
          "description": "A unique ID associated to a package."
        },
        "processingCategory": {
          "maxLength": 1,
          "type": "string",
          "description": "A unique ID representing the processing category associated to a shipment."
        },
        "processingCategoryName": {
          "maxLength": 25,
          "type": "string",
          "description": "A name representing the processing category associated to a shipment.",
          "enum": [
            "CARDS",
            "LETTERS",
            "FLATS",
            "MACHINABLE_PARCEL",
            "IRREGULAR_PARCEL",
            "NONSTANDARD_PARCEL",
            "CATALOGS",
            "OPEN_AND_DISTRIBUTE",
            "RETURNS",
            "SOFT_PACK_MACHINABLE",
            "SOFT_PACK_NON_MACHINABLE"
          ]
        },
        "mailingDate": {
          "minLength": 0,
          "type": "string",
          "description": "Combination of Date Of Mailing and Time Of Mailing YYYYMMDD + HHMMSS",
          "format": "date-time"
        },
        "mailClassName": {
          "minLength": 0,
          "type": "string",
          "description": "The class of mail for the shipment."
        },
        "primaryDeliveryAddress": {
          "maxLength": 48,
          "type": "string",
          "description": "Primary delivery address for the transaction details."
        },
        "secondaryDeliveryAddress": {
          "maxLength": 96,
          "type": "string",
          "description": "Secondary delivery address for the transaction details."
        }
      },
      "additionalProperties": false,
      "description": "Details on adjustments that will be or have been issued to a customer account. Fields will only be provided if they differed from the original manifested data."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/usps-reconciliation-adjustments"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.