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
headerrequired

Scopes are derived implicitly based on the provided client_id values.

Body

application/json
externalShipmentId
string | null

An optional external identifier for the shipment.

Maximum length: 50
origin
object

The origin address from where the shipment will be sent.

destination
object

The destination address where the shipment will be delivered.

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.

deliveryByDate
string | null

The date when the shipment must be delivered by.

isSignatureRequired
boolean

Whether the shipment requires a signature upon delivery.

isRefrigerated
boolean

Whether the shipment requires refrigeration.

forceRetrieveRates
boolean

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

Response

200 - application/json
shipmentId
string

Unique identifier for the shipment.

Required string length: 28 - 90
origin
object

The address from which the shipment is sent.

destination
object

The address to which the shipment is being sent.

returnAddress
object

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

parcel
object

Details about the parcel being shipped.

isSignatureRequired
boolean

Indicates whether a signature is required for delivery.

createdAt
string

The date and time when the shipment was created.

updatedAt
string

The date and time when the shipment was last updated.

recommendedShipmentService
object

The recommended service for this shipment.

shipDate
string | null

The date when the shipment is planned to be sent.

deliveryByDate
string | null

The date when the shipment must be delivered by.

externalShipmentId
string | null

An optional external identifier for the shipment.

Error HandlingGet Package