United States Postal Service · JSON-LD Context
Usps Context
JSON-LD context defining the semantic vocabulary for Usps from United States Postal Service.
120 Classes
368 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
usps:
https://usps.com/schema#
Classes
AddressResponse
CityAndState
AddressAdditionalInfo
ZIPCodeResponse
ErrorMessage
Address
AdjustmentDetails
AppointmentFull
CancellationRequest
CancellationResponse
SlotAvailability
ContainerLevel
Slots
SchedulePickupRequest
PickupConfirmation
Addressee
EmailNotification
SMSNotification
SchedulePickupRequest_packages
SchedulePickupRequest_pickupLocation
ErrorMessage_error_source
ErrorMessage_error_errors
ErrorMessage_error
ImageInfo
Manifest
Container
ContainerIDPackagesBody
ContainerWarnings
ErrorMessageErrorSource
ErrorMessageErrorErrors
ErrorMessageError
ExtraService
IndiciaImbImageInfo
SerialNumberFormat
Commitment
LabelRequest
LabelMetadata
CancelResponse
IMBCancelResponse
LabelMultiPartResponse
ReturnLabelMultiPartResponse
ReturnLabelMetadata
ReturnLabelRequest
IndiciaRequest
IndiciaRequestDescription
IndiciaResponse
IndiciaImbRequest
IndiciaImbRequestDescription
IndiciaImbResponse
IndiciaImbExtraService
PackageDescription
PackageOptions
IMIType
CustomerReference
CustomsForm
ShippingContents
LabelBrandingUploadRequest
LabelBrandingUploadResponse
LabelBrandingDeleteResponse
LabelBrandingPatchResponse
LabelBrandingGetListResponse
LabelBrandingGetImageResponse
LabelReprintRequest
LabelReprintMultiPartResponse
LabelReprintDomesticOutboundResponse
LabelReprintDomesticReturnResponse
ReprintInfo
LabelReprintImageInfo
BaseRatesQuery
RateListQuery
ExtraServiceRateQueryWithSingleExtraService
ExtraServiceRateQuery
BaseRatesQueryResult
TotalRatesExtraServiceRateDetails
TotalRatesQueryResult
LetterRatesQuery
BaseRateOption
RateDetails
LetterRatesOption
LetterRateDetail
MailClass
PriceType
MailClassOutboundOnly
RateOption
Campaign
CampaignEdit
CampaignEditResponse
QueryString
IMBsRequest
IMBsResponseLessThan25Success
IMBsResponseMoreThan25Success
IMBsPartialSuccess
IMBsErrorMessage
SummarySuccessResponse
DetailSuccessResponse
QueryErrorResponse
PackageCampaign
CancelPackageCampaignResponse
TrackingNumberRequest
TrackingNumberSuccessResponse
TrackingNumberPartialSuccessResponse
EditPackageCampaign
EditPackageCampaignResponse
CampaignDetailsResponse
SinglePackageCampaignResponse
TrackingNumberError
CustomsReference
InternationalLabelRequest
InternationalLabelMetadata
InternationalLabelResponse
LabelReprintInternationalMultipartResponse
LabelReprintInternationalResponse
EUProductIDFields
ExtraServiceRateDetails
InternationalRateListQuery
InternationalRateListQueryResult
InternationalLetterRatesQuery
InternationalPriceType
TotalRatesRequestLandedCostItem
DropShipmentLocation
Properties
| Property | Type | Container |
|---|---|---|
| firm | string | |
| address | reference | |
| additionalInfo | reference | |
| corrections | reference | |
| matches | reference | |
| warnings | list | |
| city | string | |
| state | string | |
| ZIPCode | string | |
| deliveryPoint | string | |
| carrierRoute | string | |
| countyName | string | |
| congressDistrict | string | |
| footnotes | string | |
| recordType | string | |
| secondaryInfo | string | |
| returnCode | decimal | |
| returnCodeText | string | |
| DPVConfirmation | string | |
| DPVEnhancedConfirmation | string | |
| DPVFootnotes | string | |
| business | string | |
| DPVBusiness | string | |
| DPVCMRA | string | |
| DPVDrop | string | |
| DPVEducational | string | |
| DPVDropCount | string | |
| DPVLACS | string | |
| DPVNoDoorDelivery | string | |
| DPVPBSA | string | |
| DPVNostatReasonCode | string | |
| DPVNostatReasonCodeDesc | string | |
| centralDeliveryPoint | string | |
| DPVSeasonal | string | |
| DPVThrowback | string | |
| DPVNoSecureLocation | string | |
| vacant | string | |
| DPVVacant | string | |
| DPVNostat | string | |
| DPVNonDeliveryDaysFlag | string | |
| DPVNonDeliveryDaysSMTWTFS | string | |
| DPVNonDeliveryDaysValues | list | |
| DPVCurbDelivery | string | |
| DPVCentralBoxDelivery | string | |
| DPVNDCBUDelivery | string | |
| DPVOtherDelivery | string | |
| DPVDeliveryType | string | |
| DPVUsageCode | string | |
| electricVehicleRoute | boolean | |
| postOfficeCity | string | |
| postOfficeState | string | |
| countyNumber | string | |
| autoZoneIndicator | string | |
| LACSLinkReturnCode | string | |
| LACSLinkIndicator | string | |
| miscLine | string | |
| ZIP5Valid | string | |
| POBoxOnlyZIP | string | |
| defaultFlag | string | |
| matchedPrimaryNumber | string | |
| matchedSecondaryNumber | string | |
| parsedPMBDesignator | string | |
| parsedPMBNumber | string | |
| suiteLinkIndicator | string | |
| financeNumber | string | |
| baseAlternateCode | string | |
| LACSIndicator | string | |
| eLOTCode | string | |
| eLOTNumber | string | |
| apiVersion | string | |
| error | ||
| streetAddress | string | |
| streetAddressAbbreviation | string | |
| secondaryAddress | string | |
| cityAbbreviation | string | |
| trackingNumber | string | |
| manifestNumber | string | |
| adjustmentSubtype | string | |
| details | list | |
| rootCause | list | |
| pricingCharacteristics | list | |
| USPSPackagingBarcode | string | |
| postageAdjustment | decimal | |
| assessedDateTime | dateTime | |
| adjustmentTotalPostage | ||
| adjustmentBasePostage | ||
| totalPostage | ||
| basePostage | ||
| fees | list | |
| hazmatNoncomplianceErrorMessage | string | |
| accountNumber | string | |
| transactionID | string | |
| earliestScanDate | dateTime | |
| MID | string | |
| CRID | string | |
| adjustmentStatus | string | |
| extraServices | list | |
| originAddress | string | |
| originCity | string | |
| originState | string | |
| originZipCode | string | |
| destinationAddress | string | |
| destinationCity | string | |
| destinationState | string | |
| destinationZipCode | string | |
| destinationCountryCode | string | |
| packageScanGroupingId | string | |
| manifestPackageId | string | |
| processingCategory | string | |
| processingCategoryName | string | |
| mailingDate | dateTime | |
| mailClassName | string | |
| primaryDeliveryAddress | string | |
| secondaryDeliveryAddress | string | |
| appointmentType | string | |
| destinationEntry | string | |
| recurringAppointment | ||
| oneTimeAppointment | ||
| detailInfo | ||
| trailerInfo | ||
| consigneeFacility | ||
| comment | string | |
| valueAddedService | string | |
| shipperAppointmentRequestID | string | |
| consigneeAppointmentID | string | |
| schedulerID | string | |
| schedulerCorpID | string | |
| shipperMultiStopID | string | |
| consigneeMultiStopID | string | |
| shipperStopNumber | string | |
| pickupOrDelivery | string | |
| palletPositionCount | integer | |
| includesElectronicLoad | string | |
| systemID | string | |
| cancelReasonCode | string | |
| cancelComments | string | |
| cancelNumber | string | |
| oneTimeAppt | boolean | |
| recurringAppt | boolean | |
| mailClass | string | |
| dropshipKey | string | |
| appointmentStartDate | dateTime | |
| appointmentEndDate | dateTime | |
| applyTiers | string | |
| perishableInd | boolean | |
| userCRID | string | |
| schedulerCRID | string | |
| preferredAppt | dateTime | |
| apptTime | string | |
| dayFrequency | string | |
| weekFrequency | string | |
| apptTrackingID | string | |
| comments | string | |
| schedulerContentID | string | |
| shipperApptRequestID | string | |
| appointmentSlots | list | |
| pickupDate | date | |
| pickupAddress | reference | |
| packages | list | |
| estimatedWeight | decimal | |
| pickupLocation | reference | |
| nextAvailablePickup | boolean | |
| confirmationNumber | string | |
| carrierPickupRequest | reference | |
| firstName | string | |
| lastName | string | |
| string | ||
| cellNumber | string | |
| packageType | string | |
| packageCount | integer | |
| averageLength | integer | |
| averageWidth | integer | |
| averageHeight | integer | |
| trackingNumbers | list | |
| packageLocation | string | |
| specialInstructions | string | |
| dogPresent | boolean | |
| parameter | string | |
| example | string | |
| status | string | |
| code | string | |
| title | string | |
| detail | string | |
| source | reference | |
| message | string | |
| errors | list | |
| imageType | string | |
| labelType | string | |
| addZPLComments | boolean | |
| containers | list | |
| containerID | string | |
| imageInfo | reference | |
| allowManifestedLabels | reference | |
| sortType | string | |
| destinationEntryFacilityType | string | |
| destinationZIPCode | string | |
| originFacility | reference | |
| mailerName | string | |
| containerTopology | string | |
| warningCode | string | |
| warningDescription | string | |
| receiptOption | string | |
| name | string | |
| scheduleDeliveryDate | string | |
| expectedDeliveryDate | string | |
| isPriorityMailNextDay | boolean | |
| toAddress | reference | |
| fromAddress | reference | |
| senderAddress | reference | |
| returnAddress | ||
| packageDescription | ||
| customsForm | reference | |
| labelAddress | reference | |
| routingInformation | string | |
| constructCode | string | |
| SKU | string | |
| postage | decimal | |
| serviceTypeCode | string | |
| zone | string | |
| commitment | reference | |
| weightUOM | string | |
| weight | decimal | |
| dimensionalWeight | decimal | |
| permitHolderName | string | |
| inductionType | ||
| labelBrokerID | string | |
| bannerText | string | |
| retailDistributionCode | string | |
| returnReceiptTrackingNumber | string | |
| links | reference | |
| disputeId | string | |
| imb | string | |
| disputeID | string | |
| labelMetadata | reference | |
| returnLabelMetadata | reference | |
| labelImage | string | |
| receiptImage | string | |
| returnLabelImage | string | |
| returnReceiptImage | string | |
| labelBrokerQR | string | |
| sku | string | |
| indiciaDescription | reference | |
| length | decimal | |
| height | decimal | |
| thickness | decimal | |
| nonMachinableIndicators | ||
| imiType | reference | |
| indiciaMetadata | ||
| indiciaImage | string | |
| itemValue | decimal | |
| dimensionsUOM | string | |
| width | decimal | |
| girth | decimal | |
| hasNonstandardCharacteristics | boolean | |
| packageValue | decimal | |
| nonDeliveryOption | string | |
| omas | ||
| referenceNumber | string | |
| contentComments | string | |
| restrictionType | string | |
| restrictionComments | string | |
| AESITN | string | |
| invoiceNumber | string | |
| licenseNumber | string | |
| certificateNumber | string | |
| itemDescription | string | |
| itemQuantity | integer | |
| itemTotalValue | decimal | |
| itemWeight | decimal | |
| itemTotalWeight | decimal | |
| HSTariffNumber | string | |
| countryofOrigin | string | |
| itemCategory | string | |
| itemSubcategory | string | |
| imageName | string | |
| imageData | string | |
| imageUUID | string | |
| createdDateTime | dateTime | |
| images | list | |
| limit | integer | |
| offset | integer | |
| totalCount | integer | |
| reprintInfo | reference | |
| reprintNumber | integer | |
| reprintLimit | integer | |
| suppressPostage | boolean | |
| suppressMailDate | boolean | |
| brandingImageFormat | string | |
| brandingImageUUIDs | list | |
| packageNumber | integer | |
| totalPackages | integer | |
| originZIPCode | string | |
| rateIndicator | string | |
| priceType | reference | |
| accountType | string | |
| mailClasses | reference | |
| rateOptions | reference | |
| extraService | string | |
| price | decimal | |
| totalBasePrice | decimal | |
| rates | list | |
| description | string | |
| dimWeight | decimal | |
| startDate | date | |
| endDate | string | |
| productName | string | |
| productDefinition | string | |
| campaignID | string | |
| campaignType | string | |
| mailpieceShape | string | |
| submitterName | string | |
| submitterCRID | string | |
| mailOwnerCRID | string | |
| mailOwnerName | string | |
| campaignCode | string | |
| campaignTitle | string | |
| brandDisplayName | string | |
| startSerial | string | |
| endSerial | string | |
| targetUrl | string | |
| campaignSource | string | |
| hasUrlParams | boolean | |
| isShareable | boolean | |
| postalOneSaturationJobID | string | |
| rideAlong | string | |
| replacementImage | string | |
| addBarcode | boolean | |
| barcodeCount | decimal | |
| cancel | boolean | |
| createdDatetime | dateTime | |
| delete | boolean | |
| fullEdit | boolean | |
| lastModifiedDatetime | dateTime | |
| lastModifiedSource | string | |
| lastModifiedUsername | string | |
| limitedEdit | boolean | |
| noEdit | boolean | |
| submittedDatetime | dateTime | |
| campaigns | list | |
| metadata | ||
| IMBs | string | |
| callbackKey | string | |
| totalBarcodes | decimal | |
| totalBarcodesAdded | decimal | |
| totalBarcodesFailed | decimal | |
| campaignGroupingCode | string | |
| referenceType | string | |
| reference | string | |
| contact | ||
| internationalTrackingNumber | string | |
| internationalPriceGroup | string | |
| prepaidDutiesTaxesFees | ||
| merchantProductIdentifier | string | |
| nonstandardizedManufacturerProductIdentifier | string | |
| standardizedManufacturerProductIdentifier | string | |
| foreignPostalCode | reference | |
| itemId | string | |
| countryOfOrigin | string | |
| dropShipmentKey | string | |
| facilityName | string | |
| facilityAddress | ||
| dropSitePhoneNumber | string | |
| acceptedPackageTypes | list | |
| dropShipAcceptanceTimes | list | |
| dropShipmentFacilityDetails | reference | |
| USPSConnectDetails | reference | |
| timeZone | string | |
| DSTObserved | boolean |
JSON-LD Document
{
"@context": {
"@vocab": "https://usps.com/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"usps": "https://usps.com/schema#",
"AddressResponse": "usps:AddressResponse",
"firm": {
"@id": "usps:firm",
"@type": "xsd:string"
},
"address": {
"@id": "usps:address",
"@type": "@id"
},
"additionalInfo": {
"@id": "usps:additionalInfo",
"@type": "@id"
},
"corrections": {
"@id": "usps:corrections",
"@type": "@id"
},
"matches": {
"@id": "usps:matches",
"@type": "@id"
},
"warnings": {
"@id": "usps:warnings",
"@container": "@list"
},
"CityAndState": "usps:CityAndState",
"city": {
"@id": "usps:city",
"@type": "xsd:string"
},
"state": {
"@id": "usps:state",
"@type": "xsd:string"
},
"ZIPCode": {
"@id": "usps:ZIPCode",
"@type": "xsd:string"
},
"AddressAdditionalInfo": "usps:AddressAdditionalInfo",
"deliveryPoint": {
"@id": "usps:deliveryPoint",
"@type": "xsd:string"
},
"carrierRoute": {
"@id": "usps:carrierRoute",
"@type": "xsd:string"
},
"countyName": {
"@id": "usps:countyName",
"@type": "xsd:string"
},
"congressDistrict": {
"@id": "usps:congressDistrict",
"@type": "xsd:string"
},
"footnotes": {
"@id": "usps:footnotes",
"@type": "xsd:string"
},
"recordType": {
"@id": "usps:recordType",
"@type": "xsd:string"
},
"secondaryInfo": {
"@id": "usps:secondaryInfo",
"@type": "xsd:string"
},
"returnCode": {
"@id": "usps:returnCode",
"@type": "xsd:decimal"
},
"returnCodeText": {
"@id": "usps:returnCodeText",
"@type": "xsd:string"
},
"DPVConfirmation": {
"@id": "usps:DPVConfirmation",
"@type": "xsd:string"
},
"DPVEnhancedConfirmation": {
"@id": "usps:DPVEnhancedConfirmation",
"@type": "xsd:string"
},
"DPVFootnotes": {
"@id": "usps:DPVFootnotes",
"@type": "xsd:string"
},
"business": {
"@id": "usps:business",
"@type": "xsd:string"
},
"DPVBusiness": {
"@id": "usps:DPVBusiness",
"@type": "xsd:string"
},
"DPVCMRA": {
"@id": "usps:DPVCMRA",
"@type": "xsd:string"
},
"DPVDrop": {
"@id": "usps:DPVDrop",
"@type": "xsd:string"
},
"DPVEducational": {
"@id": "usps:DPVEducational",
"@type": "xsd:string"
},
"DPVDropCount": {
"@id": "usps:DPVDropCount",
"@type": "xsd:string"
},
"DPVLACS": {
"@id": "usps:DPVLACS",
"@type": "xsd:string"
},
"DPVNoDoorDelivery": {
"@id": "usps:DPVNoDoorDelivery",
"@type": "xsd:string"
},
"DPVPBSA": {
"@id": "usps:DPVPBSA",
"@type": "xsd:string"
},
"DPVNostatReasonCode": {
"@id": "usps:DPVNostatReasonCode",
"@type": "xsd:string"
},
"DPVNostatReasonCodeDesc": {
"@id": "usps:DPVNostatReasonCodeDesc",
"@type": "xsd:string"
},
"centralDeliveryPoint": {
"@id": "usps:centralDeliveryPoint",
"@type": "xsd:string"
},
"DPVSeasonal": {
"@id": "usps:DPVSeasonal",
"@type": "xsd:string"
},
"DPVThrowback": {
"@id": "usps:DPVThrowback",
"@type": "xsd:string"
},
"DPVNoSecureLocation": {
"@id": "usps:DPVNoSecureLocation",
"@type": "xsd:string"
},
"vacant": {
"@id": "usps:vacant",
"@type": "xsd:string"
},
"DPVVacant": {
"@id": "usps:DPVVacant",
"@type": "xsd:string"
},
"DPVNostat": {
"@id": "usps:DPVNostat",
"@type": "xsd:string"
},
"DPVNonDeliveryDaysFlag": {
"@id": "usps:DPVNonDeliveryDaysFlag",
"@type": "xsd:string"
},
"DPVNonDeliveryDaysSMTWTFS": {
"@id": "usps:DPVNonDeliveryDaysSMTWTFS",
"@type": "xsd:string"
},
"DPVNonDeliveryDaysValues": {
"@id": "usps:DPVNonDeliveryDaysValues",
"@container": "@list"
},
"DPVCurbDelivery": {
"@id": "usps:DPVCurbDelivery",
"@type": "xsd:string"
},
"DPVCentralBoxDelivery": {
"@id": "usps:DPVCentralBoxDelivery",
"@type": "xsd:string"
},
"DPVNDCBUDelivery": {
"@id": "usps:DPVNDCBUDelivery",
"@type": "xsd:string"
},
"DPVOtherDelivery": {
"@id": "usps:DPVOtherDelivery",
"@type": "xsd:string"
},
"DPVDeliveryType": {
"@id": "usps:DPVDeliveryType",
"@type": "xsd:string"
},
"DPVUsageCode": {
"@id": "usps:DPVUsageCode",
"@type": "xsd:string"
},
"electricVehicleRoute": {
"@id": "usps:electricVehicleRoute",
"@type": "xsd:boolean"
},
"postOfficeCity": {
"@id": "usps:postOfficeCity",
"@type": "xsd:string"
},
"postOfficeState": {
"@id": "usps:postOfficeState",
"@type": "xsd:string"
},
"countyNumber": {
"@id": "usps:countyNumber",
"@type": "xsd:string"
},
"autoZoneIndicator": {
"@id": "usps:autoZoneIndicator",
"@type": "xsd:string"
},
"LACSLinkReturnCode": {
"@id": "usps:LACSLinkReturnCode",
"@type": "xsd:string"
},
"LACSLinkIndicator": {
"@id": "usps:LACSLinkIndicator",
"@type": "xsd:string"
},
"miscLine": {
"@id": "usps:miscLine",
"@type": "xsd:string"
},
"ZIP5Valid": {
"@id": "usps:ZIP5Valid",
"@type": "xsd:string"
},
"POBoxOnlyZIP": {
"@id": "usps:POBoxOnlyZIP",
"@type": "xsd:string"
},
"defaultFlag": {
"@id": "usps:defaultFlag",
"@type": "xsd:string"
},
"matchedPrimaryNumber": {
"@id": "usps:matchedPrimaryNumber",
"@type": "xsd:string"
},
"matchedSecondaryNumber": {
"@id": "usps:matchedSecondaryNumber",
"@type": "xsd:string"
},
"parsedPMBDesignator": {
"@id": "usps:parsedPMBDesignator",
"@type": "xsd:string"
},
"parsedPMBNumber": {
"@id": "usps:parsedPMBNumber",
"@type": "xsd:string"
},
"suiteLinkIndicator": {
"@id": "usps:suiteLinkIndicator",
"@type": "xsd:string"
},
"financeNumber": {
"@id": "usps:financeNumber",
"@type": "xsd:string"
},
"baseAlternateCode": {
"@id": "usps:baseAlternateCode",
"@type": "xsd:string"
},
"LACSIndicator": {
"@id": "usps:LACSIndicator",
"@type": "xsd:string"
},
"eLOTCode": {
"@id": "usps:eLOTCode",
"@type": "xsd:string"
},
"eLOTNumber": {
"@id": "usps:eLOTNumber",
"@type": "xsd:string"
},
"ZIPCodeResponse": "usps:ZIPCodeResponse",
"ErrorMessage": "usps:ErrorMessage",
"apiVersion": {
"@id": "usps:apiVersion",
"@type": "xsd:string"
},
"error": {
"@id": "usps:error"
},
"Address": "usps:Address",
"streetAddress": {
"@id": "usps:streetAddress",
"@type": "xsd:string"
},
"streetAddressAbbreviation": {
"@id": "usps:streetAddressAbbreviation",
"@type": "xsd:string"
},
"secondaryAddress": {
"@id": "usps:secondaryAddress",
"@type": "xsd:string"
},
"cityAbbreviation": {
"@id": "usps:cityAbbreviation",
"@type": "xsd:string"
},
"AdjustmentDetails": "usps:AdjustmentDetails",
"trackingNumber": {
"@id": "usps:trackingNumber",
"@type": "xsd:string"
},
"manifestNumber": {
"@id": "usps:manifestNumber",
"@type": "xsd:string"
},
"adjustmentSubtype": {
"@id": "usps:adjustmentSubtype",
"@type": "xsd:string"
},
"details": {
"@id": "usps:details",
"@container": "@list"
},
"rootCause": {
"@id": "usps:rootCause",
"@container": "@list"
},
"pricingCharacteristics": {
"@id": "usps:pricingCharacteristics",
"@container": "@list"
},
"USPSPackagingBarcode": {
"@id": "usps:USPSPackagingBarcode",
"@type": "xsd:string"
},
"postageAdjustment": {
"@id": "usps:postageAdjustment",
"@type": "xsd:decimal"
},
"assessedDateTime": {
"@id": "usps:assessedDateTime",
"@type": "xsd:dateTime"
},
"adjustmentTotalPostage": {
"@id": "usps:adjustmentTotalPostage"
},
"adjustmentBasePostage": {
"@id": "usps:adjustmentBasePostage"
},
"totalPostage": {
"@id": "usps:totalPostage"
},
"basePostage": {
"@id": "usps:basePostage"
},
"fees": {
"@id": "usps:fees",
"@container": "@list"
},
"hazmatNoncomplianceErrorMessage": {
"@id": "usps:hazmatNoncomplianceErrorMessage",
"@type": "xsd:string"
},
"accountNumber": {
"@id": "usps:accountNumber",
"@type": "xsd:string"
},
"transactionID": {
"@id": "usps:transactionID",
"@type": "xsd:string"
},
"earliestScanDate": {
"@id": "usps:earliestScanDate",
"@type": "xsd:dateTime"
},
"MID": {
"@id": "usps:MID",
"@type": "xsd:string"
},
"CRID": {
"@id": "usps:CRID",
"@type": "xsd:string"
},
"adjustmentStatus": {
"@id": "usps:adjustmentStatus",
"@type": "xsd:string"
},
"extraServices": {
"@id": "usps:extraServices",
"@container": "@list"
},
"originAddress": {
"@id": "usps:originAddress",
"@type": "xsd:string"
},
"originCity": {
"@id": "usps:originCity",
"@type": "xsd:string"
},
"originState": {
"@id": "usps:originState",
"@type": "xsd:string"
},
"originZipCode": {
"@id": "usps:originZipCode",
"@type": "xsd:string"
},
"destinationAddress": {
"@id": "usps:destinationAddress",
"@type": "xsd:string"
},
"destinationCity": {
"@id": "usps:destinationCity",
"@type": "xsd:string"
},
"destinationState": {
"@id": "usps:destinationState",
"@type": "xsd:string"
},
"destinationZipCode": {
"@id": "usps:destinationZipCode",
"@type": "xsd:string"
},
"destinationCountryCode": {
"@id": "usps:destinationCountryCode",
"@type": "xsd:string"
},
"packageScanGroupingId": {
"@id": "usps:packageScanGroupingId",
"@type": "xsd:string"
},
"manifestPackageId": {
"@id": "usps:manifestPackageId",
"@type": "xsd:string"
},
"processingCategory": {
"@id": "usps:processingCategory",
"@type": "xsd:string"
},
"processingCategoryName": {
"@id": "usps:processingCategoryName",
"@type": "xsd:string"
},
"mailingDate": {
"@id": "usps:mailingDate",
"@type": "xsd:dateTime"
},
"mailClassName": {
"@id": "usps:mailClassName",
"@type": "xsd:string"
},
"primaryDeliveryAddress": {
"@id": "usps:primaryDeliveryAddress",
"@type": "xsd:string"
},
"secondaryDeliveryAddress": {
"@id": "usps:secondaryDeliveryAddress",
"@type": "xsd:string"
},
"AppointmentFull": "usps:AppointmentFull",
"appointmentType": {
"@id": "usps:appointmentType",
"@type": "xsd:string"
},
"destinationEntry": {
"@id": "usps:destinationEntry",
"@type": "xsd:string"
},
"recurringAppointment": {
"@id": "usps:recurringAppointment"
},
"oneTimeAppointment": {
"@id": "usps:oneTimeAppointment"
},
"detailInfo": {
"@id": "usps:detailInfo"
},
"trailerInfo": {
"@id": "usps:trailerInfo"
},
"consigneeFacility": {
"@id": "usps:consigneeFacility"
},
"comment": {
"@id": "usps:comment",
"@type": "xsd:string"
},
"valueAddedService": {
"@id": "usps:valueAddedService",
"@type": "xsd:string"
},
"shipperAppointmentRequestID": {
"@id": "usps:shipperAppointmentRequestID",
"@type": "xsd:string"
},
"consigneeAppointmentID": {
"@id": "usps:consigneeAppointmentID",
"@type": "xsd:string"
},
"schedulerID": {
"@id": "usps:schedulerID",
"@type": "xsd:string"
},
"schedulerCorpID": {
"@id": "usps:schedulerCorpID",
"@type": "xsd:string"
},
"shipperMultiStopID": {
"@id": "usps:shipperMultiStopID",
"@type": "xsd:string"
},
"consigneeMultiStopID": {
"@id": "usps:consigneeMultiStopID",
"@type": "xsd:string"
},
"shipperStopNumber": {
"@id": "usps:shipperStopNumber",
"@type": "xsd:string"
},
"pickupOrDelivery": {
"@id": "usps:pickupOrDelivery",
"@type": "xsd:string"
},
"palletPositionCount": {
"@id": "usps:palletPositionCount",
"@type": "xsd:integer"
},
"includesElectronicLoad": {
"@id": "usps:includesElectronicLoad",
"@type": "xsd:string"
},
"CancellationRequest": "usps:CancellationRequest",
"systemID": {
"@id": "usps:systemID",
"@type": "xsd:string"
},
"cancelReasonCode": {
"@id": "usps:cancelReasonCode",
"@type": "xsd:string"
},
"cancelComments": {
"@id": "usps:cancelComments",
"@type": "xsd:string"
},
"CancellationResponse": "usps:CancellationResponse",
"cancelNumber": {
"@id": "usps:cancelNumber",
"@type": "xsd:string"
},
"SlotAvailability": "usps:SlotAvailability",
"oneTimeAppt": {
"@id": "usps:oneTimeAppt",
"@type": "xsd:boolean"
},
"recurringAppt": {
"@id": "usps:recurringAppt",
"@type": "xsd:boolean"
},
"mailClass": {
"@id": "usps:mailClass",
"@type": "xsd:string"
},
"dropshipKey": {
"@id": "usps:dropshipKey",
"@type": "xsd:string"
},
"appointmentStartDate": {
"@id": "usps:appointmentStartDate",
"@type": "xsd:dateTime"
},
"appointmentEndDate": {
"@id": "usps:appointmentEndDate",
"@type": "xsd:dateTime"
},
"applyTiers": {
"@id": "usps:applyTiers",
"@type": "xsd:string"
},
"perishableInd": {
"@id": "usps:perishableInd",
"@type": "xsd:boolean"
},
"userCRID": {
"@id": "usps:userCRID",
"@type": "xsd:string"
},
"schedulerCRID": {
"@id": "usps:schedulerCRID",
"@type": "xsd:string"
},
"preferredAppt": {
"@id": "usps:preferredAppt",
"@type": "xsd:dateTime"
},
"apptTime": {
"@id": "usps:apptTime",
"@type": "xsd:string"
},
"dayFrequency": {
"@id": "usps:dayFrequency",
"@type": "xsd:string"
},
"weekFrequency": {
"@id": "usps:weekFrequency",
"@type": "xsd:string"
},
"apptTrackingID": {
"@id": "usps:apptTrackingID",
"@type": "xsd:string"
},
"comments": {
"@id": "usps:comments",
"@type": "xsd:string"
},
"schedulerContentID": {
"@id": "usps:schedulerContentID",
"@type": "xsd:string"
},
"shipperApptRequestID": {
"@id": "usps:shipperApptRequestID",
"@type": "xsd:string"
},
"ContainerLevel": "usps:ContainerLevel",
"Slots": "usps:Slots",
"appointmentSlots": {
"@id": "usps:appointmentSlots",
"@container": "@list"
},
"SchedulePickupRequest": "usps:SchedulePickupRequest",
"pickupDate": {
"@id": "usps:pickupDate",
"@type": "xsd:date"
},
"pickupAddress": {
"@id": "usps:pickupAddress",
"@type": "@id"
},
"packages": {
"@id": "usps:packages",
"@container": "@list"
},
"estimatedWeight": {
"@id": "usps:estimatedWeight",
"@type": "xsd:decimal"
},
"pickupLocation": {
"@id": "usps:pickupLocation",
"@type": "@id"
},
"nextAvailablePickup": {
"@id": "usps:nextAvailablePickup",
"@type": "xsd:boolean"
},
"PickupConfirmation": "usps:PickupConfirmation",
"confirmationNumber": {
"@id": "usps:confirmationNumber",
"@type": "xsd:string"
},
"carrierPickupRequest": {
"@id": "usps:carrierPickupRequest",
"@type": "@id"
},
"Addressee": "usps:Addressee",
"firstName": {
"@id": "usps:firstName",
"@type": "xsd:string"
},
"lastName": {
"@id": "usps:lastName",
"@type": "xsd:string"
},
"EmailNotification": "usps:EmailNotification",
"email": {
"@id": "usps:email",
"@type": "xsd:string"
},
"SMSNotification": "usps:SMSNotification",
"cellNumber": {
"@id": "usps:cellNumber",
"@type": "xsd:string"
},
"SchedulePickupRequest_packages": "usps:SchedulePickupRequest_packages",
"packageType": {
"@id": "usps:packageType",
"@type": "xsd:string"
},
"packageCount": {
"@id": "usps:packageCount",
"@type": "xsd:integer"
},
"averageLength": {
"@id": "usps:averageLength",
"@type": "xsd:integer"
},
"averageWidth": {
"@id": "usps:averageWidth",
"@type": "xsd:integer"
},
"averageHeight": {
"@id": "usps:averageHeight",
"@type": "xsd:integer"
},
"trackingNumbers": {
"@id": "usps:trackingNumbers",
"@container": "@list"
},
"SchedulePickupRequest_pickupLocation": "usps:SchedulePickupRequest_pickupLocation",
"packageLocation": {
"@id": "usps:packageLocation",
"@type": "xsd:string"
},
"specialInstructions": {
"@id": "usps:specialInstructions",
"@type": "xsd:string"
},
"dogPresent": {
"@id": "usps:dogPresent",
"@type": "xsd:boolean"
},
"ErrorMessage_error_source": "usps:ErrorMessage_error_source",
"parameter": {
"@id": "usps:parameter",
"@type": "xsd:string"
},
"example": {
"@id": "usps:example",
"@type": "xsd:string"
},
"ErrorMessage_error_errors": "usps:ErrorMessage_error_errors",
"status": {
"@id": "usps:status",
"@type": "xsd:string"
},
"code": {
"@id": "usps:code",
"@type": "xsd:string"
},
"title": {
"@id": "usps:title",
"@type": "xsd:string"
},
"detail": {
"@id": "usps:detail",
"@type": "xsd:string"
},
"source": {
"@id": "usps:source",
"@type": "@id"
},
"ErrorMessage_error": "usps:ErrorMessage_error",
"message": {
"@id": "usps:message",
"@type": "xsd:string"
},
"errors": {
"@id": "usps:errors",
"@container": "@list"
},
"ImageInfo": "usps:ImageInfo",
"imageType": {
"@id": "usps:imageType",
"@type": "xsd:string"
},
"labelType": {
"@id": "usps:labelType",
"@type": "xsd:string"
},
"addZPLComments": {
"@id": "usps:addZPLComments",
"@type": "xsd:boolean"
},
"Manifest": "usps:Manifest",
"containers": {
"@id": "usps:containers",
"@container": "@list"
},
"Container": "usps:Container",
"containerID": {
"@id": "usps:containerID",
"@type": "xsd:string"
},
"imageInfo": {
"@id": "usps:imageInfo",
"@type": "@id"
},
"allowManifestedLabels": {
"@id": "usps:allowManifestedLabels",
"@type": "@id"
},
"sortType": {
"@id": "usps:sortType",
"@type": "xsd:string"
},
"destinationEntryFacilityType": {
"@id": "usps:destinationEntryFacilityType",
"@type": "xsd:string"
},
"destinationZIPCode": {
"@id": "usps:destinationZIPCode",
"@type": "xsd:string"
},
"originFacility": {
"@id": "usps:originFacility",
"@type": "@id"
},
"mailerName": {
"@id": "usps:mailerName",
"@type": "xsd:string"
},
"containerTopology": {
"@id": "usps:containerTopology",
"@type": "xsd:string"
},
"ContainerIDPackagesBody": "usps:ContainerIDPackagesBody",
"ContainerWarnings": "usps:ContainerWarnings",
"warningCode": {
"@id": "usps:warningCode",
"@type": "xsd:string"
},
"warningDescription": {
"@id": "usps:warningDescription",
"@type": "xsd:string"
},
"ErrorMessageErrorSource": "usps:ErrorMessageErrorSource",
"ErrorMessageErrorErrors": "usps:ErrorMessageErrorErrors",
"ErrorMessageError": "usps:ErrorMessageError",
"ExtraService": "usps:ExtraService",
"IndiciaImbImageInfo": "usps:IndiciaImbImageInfo",
"receiptOption": {
"@id": "usps:receiptOption",
"@type": "xsd:string"
},
"SerialNumberFormat": "usps:SerialNumberFormat",
"Commitment": "usps:Commitment",
"name": {
"@id": "usps:name",
"@type": "xsd:string"
},
"scheduleDeliveryDate": {
"@id": "usps:scheduleDeliveryDate",
"@type": "xsd:string"
},
"expectedDeliveryDate": {
"@id": "usps:expectedDeliveryDate",
"@type": "xsd:string"
},
"isPriorityMailNextDay": {
"@id": "usps:isPriorityMailNextDay",
"@type": "xsd:boolean"
},
"LabelRequest": "usps:LabelRequest",
"toAddress": {
"@id": "usps:toAddress",
"@type": "@id"
},
"fromAddress": {
"@id": "usps:fromAddress",
"@type": "@id"
},
"senderAddress": {
"@id": "usps:senderAddress",
"@type": "@id"
},
"returnAddress": {
"@id": "usps:returnAddress"
},
"packageDescription": {
"@id": "usps:packageDescription"
},
"customsForm": {
"@id": "usps:customsForm",
"@type": "@id"
},
"LabelMetadata": "usps:LabelMetadata",
"labelAddress": {
"@id": "usps:labelAddress",
"@type": "@id"
},
"routingInformation": {
"@id": "usps:routingInformation",
"@type": "xsd:string"
},
"constructCode": {
"@id": "usps:constructCode",
"@type": "xsd:string"
},
"SKU": {
"@id": "usps:SKU",
"@type": "xsd:string"
},
"postage": {
"@id": "usps:postage",
"@type": "xsd:decimal"
},
"serviceTypeCode": {
"@id": "usps:serviceTypeCode",
"@type": "xsd:string"
},
"zone": {
"@id": "usps:zone",
"@type": "xsd:string"
},
"commitment": {
"@id": "usps:commitment",
"@type": "@id"
},
"weightUOM": {
"@id": "usps:weightUOM",
"@type": "xsd:string"
},
"weight": {
"@id": "usps:weight",
"@type": "xsd:decimal"
},
"dimensionalWeight": {
"@id": "usps:dimensionalWeight",
"@type": "xsd:decimal"
},
"permitHolderName": {
"@id": "usps:permitHolderName",
"@type": "xsd:string"
},
"inductionType": {
"@id": "usps:inductionType"
},
"labelBrokerID": {
"@id": "usps:labelBrokerID",
"@type": "xsd:string"
},
"bannerText": {
"@id": "usps:bannerText",
"@type": "xsd:string"
},
"retailDistributionCode": {
"@id": "usps:retailDistributionCode",
"@type": "xsd:string"
},
"returnReceiptTrackingNumber": {
"@id": "usps:returnReceiptTrackingNumber",
"@type": "xsd:string"
},
"links": {
"@id": "usps:links",
"@type": "@id"
},
"CancelResponse": "usps:CancelResponse",
"disputeId": {
"@id": "usps:disputeId",
"@type": "xsd:string"
},
"IMBCancelResponse": "usps:IMBCancelResponse",
"imb": {
"@id": "usps:imb",
"@type": "xsd:string"
},
"disputeID": {
"@id": "usps:disputeID",
"@type": "xsd:string"
},
"LabelMultiPartResponse": "usps:LabelMultiPartResponse",
"labelMetadata": {
"@id": "usps:labelMetadata",
"@type": "@id"
},
"returnLabelMetadata": {
"@id": "usps:returnLabelMetadata",
"@type": "@id"
},
"labelImage": {
"@id": "usps:labelImage",
"@type": "xsd:string"
},
"receiptImage": {
"@id": "usps:receiptImage",
"@type": "xsd:string"
},
"returnLabelImage": {
"@id": "usps:returnLabelImage",
"@type": "xsd:string"
},
"returnReceiptImage": {
"@id": "usps:returnReceiptImage",
"@type": "xsd:string"
},
"labelBrokerQR": {
"@id": "usps:labelBrokerQR",
"@type": "xsd:string"
},
"ReturnLabelMultiPartResponse": "usps:ReturnLabelMultiPartResponse",
"ReturnLabelMetadata": "usps:ReturnLabelMetadata",
"sku": {
"@id": "usps:sku",
"@type": "xsd:string"
},
"ReturnLabelRequest": "usps:ReturnLabelRequest",
"IndiciaRequest": "usps:IndiciaRequest",
"indiciaDescription": {
"@id": "usps:indiciaDescription",
"@type": "@id"
},
"IndiciaRequestDescription": "usps:IndiciaRequestDescription",
"length": {
"@id": "usps:length",
"@type": "xsd:decimal"
},
"height": {
"@id": "usps:height",
"@type": "xsd:decimal"
},
"thickness": {
"@id": "usps:thickness",
"@type": "xsd:decimal"
},
"nonMachinableIndicators": {
"@id": "usps:nonMachinableIndicators"
},
"imiType": {
"@id": "usps:imiType",
"@type": "@id"
},
"IndiciaResponse": "usps:IndiciaResponse",
"indiciaMetadata": {
"@id": "usps:indiciaMetadata"
},
"indiciaImage": {
"@id": "usps:indiciaImage",
"@type": "xsd:string"
},
"IndiciaImbRequest": "usps:IndiciaImbRequest",
"IndiciaImbRequestDescription": "usps:IndiciaImbRequestDescription",
"itemValue": {
"@id": "usps:itemValue",
"@type": "xsd:decimal"
},
"IndiciaImbResponse": "usps:IndiciaImbResponse",
"IndiciaImbExtraService": "usps:IndiciaImbExtraService",
"PackageDescription": "usps:PackageDescription",
"dimensionsUOM": {
"@id": "usps:dimensionsUOM",
"@type": "xsd:string"
},
"width": {
"@id": "usps:width",
"@type": "xsd:decimal"
},
"girth": {
"@id": "usps:girth",
"@type": "xsd:decimal"
},
"hasNonstandardCharacteristics": {
"@id": "usps:hasNonstandardCharacteristics",
"@type": "xsd:boolean"
},
"PackageOptions": "usps:PackageOptions",
"packageValue": {
"@id": "usps:packageValue",
"@type": "xsd:decimal"
},
"nonDeliveryOption": {
"@id": "usps:nonDeliveryOption",
"@type": "xsd:string"
},
"omas": {
"@id": "usps:omas"
},
"IMIType": "usps:IMIType",
"CustomerReference": "usps:CustomerReference",
"referenceNumber": {
"@id": "usps:referenceNumber",
"@type": "xsd:string"
},
"CustomsForm": "usps:CustomsForm",
"contentComments": {
"@id": "usps:contentComments",
"@type": "xsd:string"
},
"restrictionType": {
"@id": "usps:restrictionType",
"@type": "xsd:string"
},
"restrictionComments": {
"@id": "usps:restrictionComments",
"@type": "xsd:string"
},
"AESITN": {
"@id": "usps:AESITN",
"@type": "xsd:string"
},
"invoiceNumber": {
"@id": "usps:invoiceNumber",
"@type": "xsd:string"
},
"licenseNumber": {
"@id": "usps:licenseNumber",
"@type": "xsd:string"
},
"certificateNumber": {
"@id": "usps:certificateNumber",
"@type": "xsd:string"
},
"ShippingContents": "usps:ShippingContents",
"itemDescription": {
"@id": "usps:itemDescription",
"@type": "xsd:string"
},
"itemQuantity": {
"@id": "usps:itemQuantity",
"@type": "xsd:integer"
},
"itemTotalValue": {
"@id": "usps:itemTotalValue",
"@type": "xsd:decimal"
},
"itemWeight": {
"@id": "usps:itemWeight",
"@type": "xsd:decimal"
},
"itemTotalWeight": {
"@id": "usps:itemTotalWeight",
"@type": "xsd:decimal"
},
"HSTariffNumber": {
"@id": "usps:HSTariffNumber",
"@type": "xsd:string"
},
"countryofOrigin": {
"@id": "usps:countryofOrigin",
"@type": "xsd:string"
},
"itemCategory": {
"@id": "usps:itemCategory",
"@type": "xsd:string"
},
"itemSubcategory": {
"@id": "usps:itemSubcategory",
"@type": "xsd:string"
},
"LabelBrandingUploadRequest": "usps:LabelBrandingUploadRequest",
"imageName": {
"@id": "usps:imageName",
"@type": "xsd:string"
},
"imageData": {
"@id": "usps:imageData",
"@type": "xsd:string"
},
"LabelBrandingUploadResponse": "usps:LabelBrandingUploadResponse",
"imageUUID": {
"@id": "usps:imageUUID",
"@type": "xsd:string"
},
"LabelBrandingDeleteResponse": "usps:LabelBrandingDeleteResponse",
"LabelBrandingPatchResponse": "usps:LabelBrandingPatchResponse",
"createdDateTime": {
"@id": "usps:createdDateTime",
"@type": "xsd:dateTime"
},
"LabelBrandingGetListResponse": "usps:LabelBrandingGetListResponse",
"images": {
"@id": "usps:images",
"@container": "@list"
},
"limit": {
"@id": "usps:limit",
"@type": "xsd:integer"
},
"offset": {
"@id": "usps:offset",
"@type": "xsd:integer"
},
"totalCount": {
"@id": "usps:totalCount",
"@type": "xsd:integer"
},
"LabelBrandingGetImageResponse": "usps:LabelBrandingGetImageResponse",
"LabelReprintRequest": "usps:LabelReprintRequest",
"LabelReprintMultiPartResponse": "usps:LabelReprintMultiPartResponse",
"reprintInfo": {
"@id": "usps:reprintInfo",
"@type": "@id"
},
"LabelReprintDomesticOutboundResponse": "usps:LabelReprintDomesticOutboundResponse",
"LabelReprintDomesticReturnResponse": "usps:LabelReprintDomesticReturnResponse",
"ReprintInfo": "usps:ReprintInfo",
"reprintNumber": {
"@id": "usps:reprintNumber",
"@type": "xsd:integer"
},
"reprintLimit": {
"@id": "usps:reprintLimit",
"@type": "xsd:integer"
},
"LabelReprintImageInfo": "usps:LabelReprintImageInfo",
"suppressPostage": {
"@id": "usps:suppressPostage",
"@type": "xsd:boolean"
},
"suppressMailDate": {
"@id": "usps:suppressMailDate",
"@type": "xsd:boolean"
},
"brandingImageFormat": {
"@id": "usps:brandingImageFormat",
"@type": "xsd:string"
},
"brandingImageUUIDs": {
"@id": "usps:brandingImageUUIDs",
"@container": "@list"
},
"packageNumber": {
"@id": "usps:packageNumber",
"@type": "xsd:integer"
},
"totalPackages": {
"@id": "usps:totalPackages",
"@type": "xsd:integer"
},
"BaseRatesQuery": "usps:BaseRatesQuery",
"originZIPCode": {
"@id": "usps:originZIPCode",
"@type": "xsd:string"
},
"rateIndicator": {
"@id": "usps:rateIndicator",
"@type": "xsd:string"
},
"priceType": {
"@id": "usps:priceType",
"@type": "@id"
},
"accountType": {
"@id": "usps:accountType",
"@type": "xsd:string"
},
"RateListQuery": "usps:RateListQuery",
"mailClasses": {
"@id": "usps:mailClasses",
"@type": "@id"
},
"ExtraServiceRateQueryWithSingleExtraService": "usps:ExtraServiceRateQueryWithSingleExtraService",
"ExtraServiceRateQuery": "usps:ExtraServiceRateQuery",
"BaseRatesQueryResult": "usps:BaseRatesQueryResult",
"rateOptions": {
"@id": "usps:rateOptions",
"@type": "@id"
},
"TotalRatesExtraServiceRateDetails": "usps:TotalRatesExtraServiceRateDetails",
"extraService": {
"@id": "usps:extraService",
"@type": "xsd:string"
},
"price": {
"@id": "usps:price",
"@type": "xsd:decimal"
},
"TotalRatesQueryResult": "usps:TotalRatesQueryResult",
"LetterRatesQuery": "usps:LetterRatesQuery",
"BaseRateOption": "usps:BaseRateOption",
"totalBasePrice": {
"@id": "usps:totalBasePrice",
"@type": "xsd:decimal"
},
"rates": {
"@id": "usps:rates",
"@container": "@list"
},
"RateDetails": "usps:RateDetails",
"description": {
"@id": "usps:description",
"@type": "xsd:string"
},
"dimWeight": {
"@id": "usps:dimWeight",
"@type": "xsd:decimal"
},
"startDate": {
"@id": "usps:startDate",
"@type": "xsd:date"
},
"endDate": {
"@id": "usps:endDate",
"@type": "xsd:string"
},
"productName": {
"@id": "usps:productName",
"@type": "xsd:string"
},
"productDefinition": {
"@id": "usps:productDefinition",
"@type": "xsd:string"
},
"LetterRatesOption": "usps:LetterRatesOption",
"LetterRateDetail": "usps:LetterRateDetail",
"MailClass": "usps:MailClass",
"PriceType": "usps:PriceType",
"MailClassOutboundOnly": "usps:MailClas
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://artifacts.apis.io/usps/json-ld/usps-context.jsonld