Getting Started
Integration Guides
API Reference
Plan Shipment
Plan a shipment by evaluating rates, assessing risks, and selecting the recommended carrier service.
curl --request POST \
--url https://carrierapi.parcelshield.com/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"origin": {
"line1": "9400 Southpark Center Loop",
"line2": "Suite 100",
"city": "Orlando",
"state": "FL",
"zipCode": "32819",
"country": "US",
"name": "ParcelShield",
"phone": "2484345508",
"email": "[email protected]",
"isResidential": false
},
"destination": {
"line1": "4040 Central Florida Pkwy",
"city": "Orlando",
"state": "FL",
"zipCode": "32837",
"country": "US",
"name": "John Smith",
"phone": "2484345508",
"email": "[email protected]",
"isResidential": false
},
"parcel": {
"length": 20,
"width": 15,
"height": 13,
"weight": 4
},
"shipDate": "2024-10-25",
"isSignatureRequired": false,
"isRefrigerated": false,
"forceRetrieveRates": false
}'{
"shipmentId": "shp_1234567890abcdef",
"origin": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "New York",
"state": "NY",
"zipCode": "10001",
"country": "US",
"name": "John Doe",
"company": "ParcelShield",
"phone": "1234567890",
"email": "[email protected]",
"isResidential": false
},
"destination": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "New York",
"state": "NY",
"zipCode": "10001",
"country": "US",
"name": "John Doe",
"company": "ParcelShield",
"phone": "1234567890",
"email": "[email protected]",
"isResidential": false
},
"returnAddress": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "New York",
"state": "NY",
"zipCode": "10001",
"country": "US",
"name": "John Doe",
"company": "ParcelShield",
"phone": "1234567890",
"email": "[email protected]",
"isResidential": false
},
"parcel": {
"length": 10,
"width": 10,
"height": 10,
"weight": 10,
"predefinedPackage": "<string>"
},
"isSignatureRequired": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"recommendedShipmentService": {
"shipmentServiceId": "rate_1xtp80yrxbma5r6b01j67sqf52",
"credentialId": "cred_1xtp80yrxbma5r6b01j67sqf52",
"carrier": "FedEx",
"carrierService": "FedExFirstOvernight",
"carrierServiceCode": "FIRST_OVERNIGHT",
"transitService": "NextDayAm",
"transitServiceClass": "OneDay",
"price": 10,
"currency": "USD",
"estimatedArrivalDateTime": "2023-11-07T05:31:56Z",
"estimatedArrivalDateTimeZone": "America/Chicago",
"estimatedPickupDateTime": "2023-11-07T05:31:56Z",
"estimatedPickupDateTimeZone": "America/Chicago",
"provider": "UPS",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"risk": {
"version": "1.1",
"weightedOnDateRisk": {
"risk": "Low",
"onDate": 0.96
},
"predictedRoute": [
{
"zip": "865374",
"type": "OR",
"dateTime": "2023-11-07T05:31:56Z",
"stdDevMinutes": 123
}
]
}
},
"shipDate": "2023-12-25",
"deliveryByDate": "2023-12-25",
"externalShipmentId": "<string>"
}Authorizations
Scopes are derived implicitly based on the provided client_id values.
Body
An optional external identifier for the shipment.
50The origin address from where the shipment will be sent.
The postal code or ZIP code.
1 - 5"10001"
The first line of the address, typically including street number and name.
"123 Main St"
The second line of the address, if needed (e.g., apartment number, suite, etc.).
"Apt 4B"
The city or town name.
"New York"
The two-character state, province, or region.
2"NY"
The two-letter ISO 3166-1 country code. Defaults to "US" for the United States.
2"US"
The name of the person or company associated with this address.
"John Doe"
The company name, if applicable.
"ParcelShield"
The phone number associated with this address.
"1234567890"
The email address associated with this address.
Indicates if this is a residential address.
false
The destination address where the shipment will be delivered.
The postal code or ZIP code.
1 - 5"10001"
The first line of the address, typically including street number and name.
"123 Main St"
The second line of the address, if needed (e.g., apartment number, suite, etc.).
"Apt 4B"
The city or town name.
"New York"
The two-character state, province, or region.
2"NY"
The two-letter ISO 3166-1 country code. Defaults to "US" for the United States.
2"US"
The name of the person or company associated with this address.
"John Doe"
The company name, if applicable.
"ParcelShield"
The phone number associated with this address.
"1234567890"
The email address associated with this address.
Indicates if this is a residential address.
false
Details of the parcel to be shipped, including dimensions and weight.
The length of the parcel in inches.
10
The width of the parcel in inches.
10
The height of the parcel in inches.
10
The weight of the parcel in pounds.
10
The predefined package type, if applicable. Null if using custom dimensions.
The date when the shipment is planned to be sent. Defaults to today if not specified.
The date when the shipment must be delivered by.
Whether the shipment requires a signature upon delivery.
Whether the shipment requires refrigeration.
Forces the system to retrieve new rates, bypassing any cached results, when set to true.
Response
Unique identifier for the shipment.
28 - 90"shp_1234567890abcdef"
The address from which the shipment is sent.
The postal code or ZIP code.
1 - 5"10001"
The first line of the address, typically including street number and name.
"123 Main St"
The second line of the address, if needed (e.g., apartment number, suite, etc.).
"Apt 4B"
The city or town name.
"New York"
The two-character state, province, or region.
2"NY"
The two-letter ISO 3166-1 country code. Defaults to "US" for the United States.
2"US"
The name of the person or company associated with this address.
"John Doe"
The company name, if applicable.
"ParcelShield"
The phone number associated with this address.
"1234567890"
The email address associated with this address.
Indicates if this is a residential address.
false
The address to which the shipment is being sent.
The postal code or ZIP code.
1 - 5"10001"
The first line of the address, typically including street number and name.
"123 Main St"
The second line of the address, if needed (e.g., apartment number, suite, etc.).
"Apt 4B"
The city or town name.
"New York"
The two-character state, province, or region.
2"NY"
The two-letter ISO 3166-1 country code. Defaults to "US" for the United States.
2"US"
The name of the person or company associated with this address.
"John Doe"
The company name, if applicable.
"ParcelShield"
The phone number associated with this address.
"1234567890"
The email address associated with this address.
Indicates if this is a residential address.
false
The return address for the shipment, if different from the 'from' address.
The postal code or ZIP code.
1 - 5"10001"
The first line of the address, typically including street number and name.
"123 Main St"
The second line of the address, if needed (e.g., apartment number, suite, etc.).
"Apt 4B"
The city or town name.
"New York"
The two-character state, province, or region.
2"NY"
The two-letter ISO 3166-1 country code. Defaults to "US" for the United States.
2"US"
The name of the person or company associated with this address.
"John Doe"
The company name, if applicable.
"ParcelShield"
The phone number associated with this address.
"1234567890"
The email address associated with this address.
Indicates if this is a residential address.
false
Details about the parcel being shipped.
The length of the parcel in inches.
10
The width of the parcel in inches.
10
The height of the parcel in inches.
10
The weight of the parcel in pounds.
10
The predefined package type, if applicable. Null if using custom dimensions.
Indicates whether a signature is required for delivery.
The date and time when the shipment was created.
The date and time when the shipment was last updated.
The recommended service for this shipment.
Unique identifier for the rate.
28 - 90"rate_1xtp80yrxbma5r6b01j67sqf52"
Identifier for the credential used to obtain the rate.
28 - 90"cred_1xtp80yrxbma5r6b01j67sqf52"
Name of the carrier providing this rate.
Unknown, UPS, FedEx, Gso, TForce, ParcelShield, Cdl, DawsonCourierNetwork, USPS, DoorDash "FedEx"
Name of the carrier service providing this rate.
Unknown, UpsNextDayEarly, UpsNextDay, UpsNextDaySaver, UpsTwoDayAm, UpsTwoDay, UpsThreeDay, UpsGround, UpsSurePost, UspsFirstClassPackageService, UspsPriorityMail, UspsPriorityMailExpress, UspsParcelSelect, UspsParcelSelectLightweight, UspsFirstClassMail, UspsGroundAdvantage, UspsPending, FedExFirstOvernight, FedExPriorityOvernight, FedExStandardOvernight, FedExTwoDayAm, FedExTwoDay, FedExExpressSaver, FedExGround, FedExHomeDelivery, FedExGroundEconomy, DirectCourier "FedExFirstOvernight"
The carrier-specific service code returned directly by the carrier
"FIRST_OVERNIGHT"
The transit service used to deliver the shipment
Unknown, NextDayAm, NextDay, NextDayPm, TwoDayAm, TwoDay, ThreeDay, Ground, GroundHome, GroundLastMileHybrid, FirstClass, PriorityMail, PriorityMailExpress, ParcelSelect, ParcelSelectLightweight, FirstClassMail, DirectCourier "NextDayAm"
The transit service class used to deliver the shipment
Unknown, Ground, OneDay, TwoDay, ThreeDay, FirstClass, PriorityMail, ParcelSelect, DirectCourier "OneDay"
The total price for this shipment
10
"USD"
Estimated DateTime when the shipment will arrive.
IANA time zone identifier
3 - 50"America/Chicago"
Estimated DateTime the shipment will be picked up
IANA time zone identifier
3 - 50"America/Chicago"
"UPS"
The version of the package risk model.
"1.1"
The date when the shipment is planned to be sent.
The date when the shipment must be delivered by.
An optional external identifier for the shipment.
curl --request POST \
--url https://carrierapi.parcelshield.com/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"origin": {
"line1": "9400 Southpark Center Loop",
"line2": "Suite 100",
"city": "Orlando",
"state": "FL",
"zipCode": "32819",
"country": "US",
"name": "ParcelShield",
"phone": "2484345508",
"email": "[email protected]",
"isResidential": false
},
"destination": {
"line1": "4040 Central Florida Pkwy",
"city": "Orlando",
"state": "FL",
"zipCode": "32837",
"country": "US",
"name": "John Smith",
"phone": "2484345508",
"email": "[email protected]",
"isResidential": false
},
"parcel": {
"length": 20,
"width": 15,
"height": 13,
"weight": 4
},
"shipDate": "2024-10-25",
"isSignatureRequired": false,
"isRefrigerated": false,
"forceRetrieveRates": false
}'{
"shipmentId": "shp_1234567890abcdef",
"origin": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "New York",
"state": "NY",
"zipCode": "10001",
"country": "US",
"name": "John Doe",
"company": "ParcelShield",
"phone": "1234567890",
"email": "[email protected]",
"isResidential": false
},
"destination": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "New York",
"state": "NY",
"zipCode": "10001",
"country": "US",
"name": "John Doe",
"company": "ParcelShield",
"phone": "1234567890",
"email": "[email protected]",
"isResidential": false
},
"returnAddress": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "New York",
"state": "NY",
"zipCode": "10001",
"country": "US",
"name": "John Doe",
"company": "ParcelShield",
"phone": "1234567890",
"email": "[email protected]",
"isResidential": false
},
"parcel": {
"length": 10,
"width": 10,
"height": 10,
"weight": 10,
"predefinedPackage": "<string>"
},
"isSignatureRequired": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"recommendedShipmentService": {
"shipmentServiceId": "rate_1xtp80yrxbma5r6b01j67sqf52",
"credentialId": "cred_1xtp80yrxbma5r6b01j67sqf52",
"carrier": "FedEx",
"carrierService": "FedExFirstOvernight",
"carrierServiceCode": "FIRST_OVERNIGHT",
"transitService": "NextDayAm",
"transitServiceClass": "OneDay",
"price": 10,
"currency": "USD",
"estimatedArrivalDateTime": "2023-11-07T05:31:56Z",
"estimatedArrivalDateTimeZone": "America/Chicago",
"estimatedPickupDateTime": "2023-11-07T05:31:56Z",
"estimatedPickupDateTimeZone": "America/Chicago",
"provider": "UPS",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"risk": {
"version": "1.1",
"weightedOnDateRisk": {
"risk": "Low",
"onDate": 0.96
},
"predictedRoute": [
{
"zip": "865374",
"type": "OR",
"dateTime": "2023-11-07T05:31:56Z",
"stdDevMinutes": 123
}
]
}
},
"shipDate": "2023-12-25",
"deliveryByDate": "2023-12-25",
"externalShipmentId": "<string>"
}