Plan Shipment

POST

shipments

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
}'

Authorizations

Authorization

string

header

required

Scopes are derived implicitly based on the provided client_id values.

Body

application/json

deliveryByDate

string | null

The date when the shipment must be delivered by.

destination

object

The destination address where the shipment will be delivered.

externalShipmentId

string | null

An optional external identifier for the shipment.

Maximum length: 50

forceRetrieveRates

boolean

Forces the system to retrieve new rates, bypassing any cached results, when set to true.

isRefrigerated

boolean

Whether the shipment requires refrigeration.

isSignatureRequired

boolean

Whether the shipment requires a signature upon delivery.

origin

object

The origin address from where the shipment will be sent.

parcel

object

Details of the parcel to be shipped, including dimensions and weight.

shipDate

string

The date when the shipment is planned to be sent. Defaults to today if not specified.

Response

200 - application/json

createdAt

string

The date and time when the shipment was created.

deliveryByDate

string | null

The date when the shipment must be delivered by.

destination

object

The address to which the shipment is being sent.

externalShipmentId

string | null

An optional external identifier for the shipment.

isSignatureRequired

boolean

Indicates whether a signature is required for delivery.

origin

object

The address from which the shipment is sent.

parcel

object

Details about the parcel being shipped.

recommendedShipmentService

object

The recommended service for this shipment.

recommendedShipmentService.carrier

enum<string>

Name of the carrier providing this rate.

Available options:

Unknown,

UPS,

FedEx,

Gso,

TForce,

ParcelShield,

Cdl,

DawsonCourierNetwork,

USPS,

DoorDash

recommendedShipmentService.carrierService

enum<string>

Name of the carrier service providing this rate.

Available options:

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

recommendedShipmentService.carrierServiceCode

string

The carrier-specific service code returned directly by the carrier

recommendedShipmentService.createdAt

string

recommendedShipmentService.credentialId

string | null

Identifier for the credential used to obtain the rate.

Required string length: 28 - 90

recommendedShipmentService.currency

string

recommendedShipmentService.estimatedArrivalDateTime

string | null

Estimated DateTime when the shipment will arrive.

recommendedShipmentService.estimatedArrivalDateTimeZone

string | null

IANA time zone identifier

Required string length: 3 - 50

recommendedShipmentService.estimatedPickupDateTime

string | null

Estimated DateTime the shipment will be picked up

recommendedShipmentService.estimatedPickupDateTimeZone

string | null

IANA time zone identifier

Required string length: 3 - 50

recommendedShipmentService.price

number | null

The total price for this shipment

recommendedShipmentService.provider

string

recommendedShipmentService.risk

object

recommendedShipmentService.shipmentServiceId

string

Unique identifier for the rate.

Required string length: 28 - 90

recommendedShipmentService.transitService

enum<string>

The transit service used to deliver the shipment

Available options:

Unknown,

NextDayAm,

NextDay,

NextDayPm,

TwoDayAm,

TwoDay,

ThreeDay,

Ground,

GroundHome,

GroundLastMileHybrid,

FirstClass,

PriorityMail,

PriorityMailExpress,

ParcelSelect,

ParcelSelectLightweight,

FirstClassMail,

DirectCourier

recommendedShipmentService.transitServiceClass

enum<string>

The transit service class used to deliver the shipment

Available options:

Unknown,

Ground,

OneDay,

TwoDay,

ThreeDay,

FirstClass,

PriorityMail,

ParcelSelect,

DirectCourier

recommendedShipmentService.updatedAt

string

returnAddress

object

The return address for the shipment, if different from the 'from' address.

shipDate

string | null

The date when the shipment is planned to be sent.

shipmentId

string

Unique identifier for the shipment.

Required string length: 28 - 90

updatedAt

string

The date and time when the shipment was last updated.

Error Handling Get Package

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
}'

Getting Started

Integration Guides

API Reference

Authorizations

Body

Response