Skip to content

Commit 86e7a49

Browse files
harris-n-jalil-uspsharris-n-jalil-usps
committed
Update README.md
1 parent 5b23c8f commit 86e7a49

File tree

1 file changed

+173
-0
lines changed

1 file changed

+173
-0
lines changed

‎README.md‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2041,6 +2041,179 @@ Response:
20412041
[SCANForm-ManifestMIDShipment-response.json](https://github.com/USPS/api-examples/blob/main/SCANForm-ManifestMIDShipment-response.json)
20422042
20432043
2044+
## Shipping Options
2045+
Receive a comprehensive list of pricing, service standards, and shipping options for USPS products within a single API call.
2046+
2047+
### Shipping Options - Shipping Package Options
2048+
Allows users to generate a comprehensive list of shipping options that comply with USPS Shipping Standards, all within a single request.
2049+
```sh
2050+
curl -X 'POST' 'https://api.usps.com/shipments/v3/options/search' \
2051+
--header 'Accept: application/json' \
2052+
--header 'Authorization: Bearer $TOKEN' \
2053+
--data '{
2054+
"pricingOptions": [
2055+
{
2056+
"priceType": "COMMERCIAL",
2057+
"paymentAccount": {
2058+
"accountType": "EPS",
2059+
"accountNumber": "XXXXXXXXXX"
2060+
}
2061+
}
2062+
],
2063+
"originZIPCode": "05485-8016",
2064+
"destinationZIPCode": "38746 0230",
2065+
"packageDescription": {
2066+
"weight": 1,
2067+
"length": 1,
2068+
"height": 1,
2069+
"width": 1,
2070+
"girth": 1,
2071+
"mailClass": "PARCEL_SELECT",
2072+
"extraServices": [
2073+
365
2074+
],
2075+
"mailingDate": "2024-05-01",
2076+
"packageValue": 35
2077+
}
2078+
}'
2079+
```
2080+
Response:
2081+
```json
2082+
{
2083+
"originZIPCode": "05485-8016",
2084+
"destinationZIPCode": "38746-0230",
2085+
"pricingOptions": [
2086+
{
2087+
"shippingOptions": [
2088+
{
2089+
"mailClass": "PARCEL_SELECT",
2090+
"rateOptions": [
2091+
{
2092+
"commitment": {
2093+
"name": "3 Days",
2094+
"scheduleDeliveryDate": "2024-05-04"
2095+
},
2096+
"totalPrice": 3.40,
2097+
"totalBasePrice": 3.40,
2098+
"rates": [
2099+
{
2100+
"description": "Parcel Select Nonmachinable DDU Single-piece",
2101+
"startDate": "2024-01-21",
2102+
"endDate": "",
2103+
"price": 3.4,
2104+
"zone": "00",
2105+
"weight": 1.0,
2106+
"dimensionalWeight": 0.0,
2107+
"fees": [],
2108+
"SKU": "DVXP0XXUXC00010"
2109+
}
2110+
],
2111+
"extraServices": [
2112+
{
2113+
"name": "Global Direct Entry",
2114+
"price": 0.00,
2115+
"SKU": "NA"
2116+
}
2117+
]
2118+
},
2119+
{
2120+
"commitment": {
2121+
"name": "3 Days",
2122+
"scheduleDeliveryDate": "2024-05-04"
2123+
},
2124+
"totalPrice": 5.48,
2125+
"totalBasePrice": 5.48,
2126+
"rates": [
2127+
{
2128+
"description": "Parcel Select Nonmachinable DNDC Single-piece",
2129+
"startDate": "2024-01-21",
2130+
"endDate": "",
2131+
"price": 5.48,
2132+
"zone": "00",
2133+
"weight": 1.0,
2134+
"dimensionalWeight": 0.0,
2135+
"fees": [],
2136+
"SKU": "DVXP0XXCXC00010"
2137+
}
2138+
],
2139+
"extraServices": [
2140+
{
2141+
"name": "Global Direct Entry",
2142+
"price": 0.00,
2143+
"SKU": "NA"
2144+
}
2145+
]
2146+
},
2147+
{
2148+
"commitment": {
2149+
"name": "3 Days",
2150+
"scheduleDeliveryDate": "2024-05-04"
2151+
},
2152+
"totalPrice": 5.29,
2153+
"totalBasePrice": 5.29,
2154+
"rates": [
2155+
{
2156+
"description": "Parcel Select Nonmachinable DSCF SCF",
2157+
"startDate": "2024-01-21",
2158+
"endDate": "",
2159+
"price": 5.29,
2160+
"zone": "00",
2161+
"weight": 1.0,
2162+
"dimensionalWeight": 0.0,
2163+
"fees": [],
2164+
"SKU": "DVXP0XXFXC00010"
2165+
}
2166+
],
2167+
"extraServices": [
2168+
{
2169+
"name": "Global Direct Entry",
2170+
"price": 0.00,
2171+
"SKU": "NA"
2172+
}
2173+
]
2174+
},
2175+
{
2176+
"commitment": {
2177+
"name": "3 Days",
2178+
"scheduleDeliveryDate": "2024-05-04"
2179+
},
2180+
"totalPrice": 4.17,
2181+
"totalBasePrice": 4.17,
2182+
"rates": [
2183+
{
2184+
"description": "Parcel Select Nonmachinable DHUB Single-piece",
2185+
"startDate": "2024-01-21",
2186+
"endDate": "",
2187+
"price": 4.17,
2188+
"zone": "00",
2189+
"weight": 1.0,
2190+
"dimensionalWeight": 0.0,
2191+
"fees": [],
2192+
"SKU": "DVXP0XXBXC00010"
2193+
}
2194+
],
2195+
"extraServices": [
2196+
{
2197+
"name": "Global Direct Entry",
2198+
"price": 0.00,
2199+
"SKU": "NA"
2200+
}
2201+
]
2202+
}
2203+
]
2204+
}
2205+
],
2206+
"priceType": "COMMERCIAL",
2207+
"paymentAccount": {
2208+
"accountType": "EPS",
2209+
"accountNumber": "XXXXXXXXXX"
2210+
}
2211+
}
2212+
]
2213+
}
2214+
```
2215+
2216+
20442217
## Tracking
20452218
This API returns tracking status and related details for a given USPS package, including scan events and their date, time, and location. The Tracking APIs allow you to integrate the status of your shipment into your customer-facing experience and internal fulfillment processes that will benefit your company by:
20462219
- Providing your customers with the latest status and delivery expectations while keeping them within your company’s or organization’s website.

0 commit comments

Comments
 (0)