United States Postal Service · Schema
Cancellation Response
Cancellation Response details.
GovernmentPostal ServiceShippingLogisticsAddress ValidationPackage Tracking
Properties
| Name | Type | Description |
|---|---|---|
| consigneeAppointmentID | string | FAST appointment ID. |
| shipperAppointmentRequestID | string | Mailer assigned ID. |
| CRID | string | The CRID of the appointment scheduler. |
| systemID | string | Identifies the submitting application. |
| destinationEntry | string | Dropship is YES. Origin Entry is NO. |
| cancelReasonCode | string | The reason the appointment was cancelled. Only set when the appointment is cancelled A = Appointment made in error, D = Delivery appointment Cancelled per request of consignee, E = Product combined in |
| cancelComments | string | Comments the user enters upon appointment cancellation |
| cancelNumber | string | The cancellation number of an appointment. Used in response only. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/usps/json-schema/usps-cancellation-response-schema.json",
"title": "Cancellation Response",
"description": "Cancellation Response details.",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/usps-appointments-openapi.yml#/components/schemas/CancellationResponse",
"type": "object",
"required": [
"consigneeAppointmentID",
"shipperAppointmentRequestID",
"CRID",
"destinationEntry",
"cancelReasonCode",
"cancelComments"
],
"properties": {
"consigneeAppointmentID": {
"pattern": "^[A-Za-z0-9]{1,9}$",
"type": "string",
"description": "FAST appointment ID.",
"maxLength": 9
},
"shipperAppointmentRequestID": {
"pattern": "^[A-Za-z0-9-]{1,12}$",
"type": "string",
"description": "Mailer assigned ID.",
"maxLength": 12
},
"CRID": {
"pattern": "^[0-9]{2,18}$",
"type": "string",
"description": "The CRID of the appointment scheduler.",
"minLength": 2,
"maxLength": 18
},
"systemID": {
"pattern": "^[A-Za-z0-9]{1,30}$",
"type": "string",
"description": "Identifies the submitting application.",
"maxLength": 30,
"default": "FastAPI"
},
"destinationEntry": {
"description": "Dropship is YES. Origin Entry is NO.",
"type": "string",
"enum": [
"YES",
"NO"
]
},
"cancelReasonCode": {
"description": "The reason the appointment was cancelled. Only set when the appointment is cancelled A = Appointment made in error, D = Delivery appointment Cancelled per request of consignee, E = Product combined into another existing appointment, M = Major change in expected delivery window, P = Product not available",
"type": "string",
"enum": [
"A",
"D",
"E",
"M",
"P"
]
},
"cancelComments": {
"pattern": "^[A-Za-z0-9\\.\\-\\&\\# ]{1,255}$",
"description": "Comments the user enters upon appointment cancellation",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"cancelNumber": {
"pattern": "^[0-9]{1,9}$",
"type": "string",
"description": "The cancellation number of an appointment. Used in response only.",
"maxLength": 9
}
}
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/usps-cancellation-response"
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.