Receive a comprehensive list of pricing, service standards, and shipping options for USPS products within a single API call.
Shipping Options (3.1.12)
Download OpenAPI specification:Download
Find all relevant shipping options, rates and service standards.
Presents options for shipping a package.
Based on the inputs below, the API generates a comprehensive list of shipping options that comply with USPS Shipping Standards, all within a single request. For international mail classes deliveries there are no commitments. APO, DPO, and FPO locations also do not offer commitments.
Element | Description |
---|---|
originZIPCode | The origin ZIP Code™ is where the package is being mailed from and is used for calculating pricing. |
destinationZIPCode | The destination ZIP Code™ of the recipient is used for calculating pricing. |
destinationEntryFacilityType | The Destination Entry Facility Type the package will be mailed from and is used in calculating Shipping Standards. |
packageDescription | Package characteristics used to price the shipment including requested mail class, weight, dimensions, and more. |
pricingOptions | Pricing options such as price type and supporting information needed for pricing the shipping option. |
Authorizations:
Request Body schema:
required | Array of objects (DomesticPricingOption) non-empty |
originZIPCode required | string (originZIPCode) ^\d{5}(?:[-\s]\d{4})?$ The originating ZIP code for the package. |
destinationZIPCode required | string (destinationZIPCode) ^\d{5}(?:[-\s]\d{4})?$ The destination ZIP code for the package. |
destinationEntryFacilityType | string Default: "NONE" Enum: "NONE" "DESTINATION_NETWORK_DISTRIBUTION_CENTER" "DESTINATION_SECTIONAL_CENTER_FACILITY" "DESTINATION_DELIVERY_UNIT" "DESTINATION_SERVICE_HUB" Types of Facilities:
If any value other than NONE is selected, a destinationEntryFacilityAddress is required. The destinationEntryFacilityAddress must be a valid facility to drop your package. The destination entry facility type must be set to 'NONE' when there is a value provided for the 'inductionZipCode' field. |
required | object (DomesticPackageDescription) Package Definitions |
shippingFilter | string Enum: "PRICE" "SERVICE_STANDARDS" A filter for domestic results to return only one response based on lowest price or fastest service standard |
Responses
Request samples
- Payload
{- "pricingOptions": [
- {
- "priceType": "RETAIL",
- "paymentAccount": {
- "accountType": "EPS",
- "accountNumber": "string"
}
}
], - "originZIPCode": "string",
- "destinationZIPCode": "string",
- "destinationEntryFacilityType": "NONE",
- "packageDescription": {
- "weight": 0,
- "length": 0,
- "height": 0,
- "width": 0,
- "girth": 0,
- "mailClass": "PARCEL_SELECT",
- "extraServices": [
- 365
], - "packageValue": 35,
- "mailingDate": "2019-08-24"
}, - "shippingFilter": "PRICE"
}
Response samples
- 200
- 400
- 401
- 403
- 429
- 503
Example response for a Domestic Options Request
{- "originZIPCode": "50311",
- "destinationZIPCode": "60119",
- "pricingOptions": [
- {
- "shippingOptions": [
- {
- "mailClass": "PARCEL_SELECT",
- "rateOptions": [
- {
- "commitment": {
- "name": "2 Days",
- "scheduleDeliveryDate": "2024-10-04",
- "guaranteedDelivery": false
}, - "totalBasePrice": 9.17,
- "rates": [
- {
- "description": "Parcel Select Nonstandard DNDC Single-piece",
- "startDate": "2024-07-14",
- "endDate": "2024-10-05",
- "price": 6.17,
- "zone": "00",
- "weight": 1,
- "dimensionalWeight": 0,
- "dimWeight": 0,
- "fees": [
- {
- "name": "Nonstandard Length > 22",
- "price": 3,
- "SKU": "D811XVCXXXX0000"
}
], - "priceType": "COMMERCIAL",
- "mailClass": "PARCEL_SELECT",
- "productName": "",
- "productDefinition": "",
- "processingCategory": "NONSTANDARD",
- "rateIndicator": "SP",
- "destinationEntryFacilityType": "DESTINATION_NETWORK_DISTRIBUTION_CENTER",
- "SKU": "DVXP0XXCXC00010"
}
], - "extraServices": [
- {
- "name": "Return Receipt Electronic",
- "price": 2.62,
- "extraService": "957",
- "priceType": "COMMERCIAL",
- "warnings": [
- {
- "warningCode": "001",
- "warningDescription": "Contract rate not found for request. Published rate returned."
}
], - "SKU": "DXRX0EXXXCX0000"
}
]
}
]
}
], - "priceType": "COMMERCIAL",
- "paymentAccount": {
- "accountType": "EPS",
- "accountNumber": "12345767890"
}
}
]
}