Parcels

Parcel is a new offering from Deliverr that allows merchants to affordably deliver across the US hassle-free.

Parcel is currently only available to select merchants.

Create a parcel

Create a parcel and purchase a label for that parcel.

SecurityBEARER
Request
Request Body schema: application/json
required
required
object (DeliverrAddress)
name
required
string
company
string
street1
required
string
street2
string
city
required
string
zip
required
string
state
required
string
country
required
string
phone
string
email
string
isResidential
boolean
serviceLevel
string
marketplace
string
object (CustomLabelFooterFields)
customLabelFooter1
required
string [ 1 .. 25 ] characters

A custom field that can be used to define a string to be placed in the footer of the shipping label.

customLabelFooter2
string [ 1 .. 25 ] characters

A custom field that can be used to define a string to be placed in the footer of the shipping label.

object (ParcelCustomsInformation)
required
Array of objects (ParcelCustomsInformationItems)
Array
code
required
string
description
required
string
quantity
required
number <double>
weight
required
number <double>
weightUnit
required
string (WeightUnit)
Enum: "oz" "kg" "lb" "g"
value
required
number <double>
hsTariffCode
required
string
originCountry
required
string (CountryCode)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
customerParcelId
string
injectionLocation
string
object (DeliverrAddress)
name
required
string
company
string
street1
required
string
street2
string
city
required
string
zip
required
string
state
required
string
country
required
string
phone
string
email
string
isResidential
boolean
skipAddressValidation
boolean
pickupDateTime
string <date-time>
required
object (ParcelDimensions)
height
required
number <double>
length
required
number <double>
lengthUnit
required
string (LengthUnit)
Enum: "in" "cm" "mm" "m"
weight
required
number <double>
weightUnit
required
string (WeightUnit)
Enum: "oz" "kg" "lb" "g"
width
required
number <double>
customerCustomField
string
ShippingLabelFormat (string) or ShippingLabelFormatParcel (string) (ShippingLabelFormatParcel)
Any of:
string (ShippingLabelFormat)
Enum: "PNG" "ZPL203"
Responses
201

Parcel created

400

Bad Request

401

Unauthorized

post/logistics/api/2023-10/parcels
Request samples
application/json
{
  • "shipToAddress": {
    • "name": "string",
    • "company": "string",
    • "street1": "string",
    • "street2": "string",
    • "city": "string",
    • "zip": "string",
    • "state": "string",
    • "country": "string",
    • "phone": "string",
    • "email": "string",
    • "isResidential": true
    },
  • "serviceLevel": "string",
  • "marketplace": "string",
  • "customLabelFooterFields": {
    • "customLabelFooter1": "string",
    • "customLabelFooter2": "string"
    },
  • "customsInformation": {
    • "customsItems": [
      • {
        }
      ]
    },
  • "customerParcelId": "string",
  • "injectionLocation": "string",
  • "returnAddress": {
    • "name": "string",
    • "company": "string",
    • "street1": "string",
    • "street2": "string",
    • "city": "string",
    • "zip": "string",
    • "state": "string",
    • "country": "string",
    • "phone": "string",
    • "email": "string",
    • "isResidential": true
    },
  • "skipAddressValidation": true,
  • "pickupDateTime": "2019-08-24T14:15:22Z",
  • "dimensions": {
    • "height": 5,
    • "length": 2,
    • "lengthUnit": "in",
    • "weight": 1,
    • "weightUnit": "oz",
    • "width": 8
    },
  • "customerCustomField": "string",
  • "labelFormat": "PNG"
}
Response samples
application/json
{
  • "carrierCode": "string",
  • "customerCustomField": "string",
  • "customerReferenceId": "string",
  • "packageTrackingUrl": "string",
  • "parcelId": "string",
  • "price": 0,
  • "serviceLevel": "string",
  • "shippingLabelUrl": "string",
  • "status": "ERROR",
  • "trackingCode": "string",
  • "flexportTrackingUrl": "string"
}

Cancel a parcel

Cancels a parcel that was previously created.

SecurityBEARER
Request
Request Body schema: application/json
required
parcelId
required
string
Responses
200

Successfully cancelled parcel

400

Bad Request

401

Unauthorized

post/logistics/api/2023-10/parcels/cancel
Request samples
application/json
{
  • "parcelId": "string"
}
Response samples
application/json
{
  • "status": 400,
  • "type": "string",
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}

Get a parcel by ID

Fetch the parcel with a specified Parcel ID.

SecurityBEARER
Request
path Parameters
parcelId
required
string

Unique ID used to track the parcel, returned after acquiring a purchase label.

Responses
200

Fetched Parcel

Response Schema: application/json
Any of:
carrierCode
required
string

The carrier code for the package.

customerCustomField
string or null (Maybe_Scalars-at-String_)

An optional field that has additional information about the parcel provided by the caller.

customerReferenceId
string or null (Maybe_Scalars-at-String_)

An Order or PO number to associated to the parcel. Passed in as customerParcelId.

packageTrackingUrl
required
string

URL that can be used to track the package.

parcelId
required
string

Unique ID used to track the parcel, returned after acquiring a purchase label.

price
required
number <double>

The price of the parcel.

serviceLevel
required
string

Service Level of the parcel

shippingLabelUrl
required
string

URL used to download the shipping label data.

status
required
string (ParcelApiStatus)

Status of the Parcel Request

Enum: "ERROR" "OK"
trackingCode
required
string

The tracking code for the package.

flexportTrackingUrl
string

URL that can be used to track a package end-to-end through Flexport and final-mile partner networks.

401

Unauthorized

404

Parcel not found

get/logistics/api/2023-10/parcels/{parcelId}
Response samples
application/json
{
  • "carrierCode": "string",
  • "customerCustomField": "string",
  • "customerReferenceId": "string",
  • "packageTrackingUrl": "string",
  • "parcelId": "string",
  • "price": 0,
  • "serviceLevel": "string",
  • "shippingLabelUrl": "string",
  • "status": "ERROR",
  • "trackingCode": "string",
  • "flexportTrackingUrl": "string"
}

Get a parcel's tracking information by Parcel ID

Fetch the tracking information for the parcel with the specified Parcel ID.

SecurityBEARER
Request
path Parameters
parcelId
required
string

Unique ID used to track the parcel, returned after acquiring a purchase label.

Responses
200

Contains the tracking information for the parcel

Response Schema: application/json
Any of:
carrierCode
string or null (Maybe_Scalars-at-String_)
customerCustomField
string or null (Maybe_Scalars-at-String_)
customerReferenceId
string or null (Maybe_Scalars-at-String_)
errorMessage
string or null (Maybe_Scalars-at-String_)
errors
string or null (Maybe_Scalars-at-String_)
object or null (Maybe_TrackingResultTimestamps_)
arrivalScanTime
string or null <date-time> (Maybe_Scalars-at-Date_)
attemptedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)
deliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)
estimatedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)
facilityTime
string or null <date-time> (Maybe_Scalars-at-Date_)
labelTime
string or null <date-time> (Maybe_Scalars-at-Date_)
lastTrackingEventTime
string or null <date-time> (Maybe_Scalars-at-Date_)
lastTrackingIngestionTime
string or null <date-time> (Maybe_Scalars-at-Date_)
Array of objects or null or null (Maybe_Array_Maybe_ExpiredTrackingData___)
Array
labelId
string or null (Maybe_Scalars-at-String_)
packageTrackingUrl
string or null (Maybe_Scalars-at-String_)
shippingLabelUrl
string or null (Maybe_Scalars-at-String_)
shippingMethod
string or null (Maybe_Scalars-at-String_)
trackingCode
string or null (Maybe_Scalars-at-String_)
packageTrackingUrl
string or null (Maybe_Scalars-at-String_)
parcelId
string or null (Maybe_Scalars-at-ID_)
shippingLabelUrl
string or null (Maybe_Scalars-at-String_)
status
string or null (Maybe_Scalars-at-String_)
trackingCode
string or null (Maybe_Scalars-at-String_)
flexportTrackingUrl
string

URL that can be used to track a package end-to-end through Flexport and final-mile partner networks.

400

Bad Request

401

Unauthorized

get/logistics/api/2023-10/parcels/{parcelId}/tracking
Response samples
application/json
{
  • "carrierCode": "string",
  • "customerCustomField": "string",
  • "customerReferenceId": "string",
  • "errorMessage": "string",
  • "errors": "string",
  • "eventTimestamps": {
    • "arrivalScanTime": "2019-08-24T14:15:22Z",
    • "attemptedDeliveryTime": "2019-08-24T14:15:22Z",
    • "deliveryTime": "2019-08-24T14:15:22Z",
    • "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
    • "facilityTime": "2019-08-24T14:15:22Z",
    • "labelTime": "2019-08-24T14:15:22Z",
    • "lastTrackingEventTime": "2019-08-24T14:15:22Z",
    • "lastTrackingIngestionTime": "2019-08-24T14:15:22Z"
    },
  • "expiredTrackingData": [
    • {
      • "labelId": "string",
      • "packageTrackingUrl": "string",
      • "shippingLabelUrl": "string",
      • "shippingMethod": "string",
      • "trackingCode": "string"
      }
    ],
  • "packageTrackingUrl": "string",
  • "parcelId": "string",
  • "shippingLabelUrl": "string",
  • "status": "string",
  • "trackingCode": "string",
  • "flexportTrackingUrl": "string"
}

Get a parcel's tracking information by tracking code

Fetch the tracking information for the parcel with a specified tracking code. Only valid for Parcel users.

SecurityBEARER
Request
path Parameters
trackingCode
required
string

tracking code used to track the parcel

Responses
200

Contains the tracking information for the parcel

Response Schema: application/json
Any of:
carrierCode
string or null (Maybe_Scalars-at-String_)
customerCustomField
string or null (Maybe_Scalars-at-String_)
customerReferenceId
string or null (Maybe_Scalars-at-String_)
errorMessage
string or null (Maybe_Scalars-at-String_)
errors
string or null (Maybe_Scalars-at-String_)
object or null (Maybe_TrackingResultTimestamps_)
arrivalScanTime
string or null <date-time> (Maybe_Scalars-at-Date_)
attemptedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)
deliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)
estimatedDeliveryTime
string or null <date-time> (Maybe_Scalars-at-Date_)
facilityTime
string or null <date-time> (Maybe_Scalars-at-Date_)
labelTime
string or null <date-time> (Maybe_Scalars-at-Date_)
lastTrackingEventTime
string or null <date-time> (Maybe_Scalars-at-Date_)
lastTrackingIngestionTime
string or null <date-time> (Maybe_Scalars-at-Date_)
Array of objects or null or null (Maybe_Array_Maybe_ExpiredTrackingData___)
Array
labelId
string or null (Maybe_Scalars-at-String_)
packageTrackingUrl
string or null (Maybe_Scalars-at-String_)
shippingLabelUrl
string or null (Maybe_Scalars-at-String_)
shippingMethod
string or null (Maybe_Scalars-at-String_)
trackingCode
string or null (Maybe_Scalars-at-String_)
packageTrackingUrl
string or null (Maybe_Scalars-at-String_)
parcelId
string or null (Maybe_Scalars-at-ID_)
shippingLabelUrl
string or null (Maybe_Scalars-at-String_)
status
string or null (Maybe_Scalars-at-String_)
trackingCode
string or null (Maybe_Scalars-at-String_)
flexportTrackingUrl
string

URL that can be used to track a package end-to-end through Flexport and final-mile partner networks.

400

Bad Request

401

Unauthorized

get/logistics/api/2023-10/parcels/tracking/{trackingCode}
Response samples
application/json
{
  • "carrierCode": "string",
  • "customerCustomField": "string",
  • "customerReferenceId": "string",
  • "errorMessage": "string",
  • "errors": "string",
  • "eventTimestamps": {
    • "arrivalScanTime": "2019-08-24T14:15:22Z",
    • "attemptedDeliveryTime": "2019-08-24T14:15:22Z",
    • "deliveryTime": "2019-08-24T14:15:22Z",
    • "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
    • "facilityTime": "2019-08-24T14:15:22Z",
    • "labelTime": "2019-08-24T14:15:22Z",
    • "lastTrackingEventTime": "2019-08-24T14:15:22Z",
    • "lastTrackingIngestionTime": "2019-08-24T14:15:22Z"
    },
  • "expiredTrackingData": [
    • {
      • "labelId": "string",
      • "packageTrackingUrl": "string",
      • "shippingLabelUrl": "string",
      • "shippingMethod": "string",
      • "trackingCode": "string"
      }
    ],
  • "packageTrackingUrl": "string",
  • "parcelId": "string",
  • "shippingLabelUrl": "string",
  • "status": "string",
  • "trackingCode": "string",
  • "flexportTrackingUrl": "string"
}

Get the tracking URL for a parcel

Fetch the tracking URL for a parcel given a Parcel ID.

SecurityBEARER
Request
path Parameters
parcelId
required
string

Unique ID used to track the parcel, returned after acquiring a purchase label.

Responses
200

Contains the tracking URL for the parcel

Response Schema: application/json
string
400

Bad Request

401

Unauthorized

get/logistics/api/2023-10/parcels/{parcelId}/tracking_url
Response samples
application/json
"string"

Get a parcel quote

Fetch a quote for a label purchase without purchasing a label.

SecurityBEARER
Request
Request Body schema: application/json
required
serviceLevel
required
string
injectionLocation
string
required
object (DeliverrAddress)
name
required
string
company
string
street1
required
string
street2
string
city
required
string
zip
required
string
state
required
string
country
required
string
phone
string
email
string
isResidential
boolean
required
object (ParcelDimensions)
height
required
number <double>
length
required
number <double>
lengthUnit
required
string (LengthUnit)
Enum: "in" "cm" "mm" "m"
weight
required
number <double>
weightUnit
required
string (WeightUnit)
Enum: "oz" "kg" "lb" "g"
width
required
number <double>
Responses
200

Successfully fetched quote

Response Schema: application/json
Any of:
price
required
number <double>
serviceLevel
required
string
billedWeightLbs
required
number <double>
required
object (ParcelDimensions)
height
required
number <double>
length
required
number <double>
lengthUnit
required
string (LengthUnit)
Enum: "in" "cm" "mm" "m"
weight
required
number <double>
weightUnit
required
string (WeightUnit)
Enum: "oz" "kg" "lb" "g"
width
required
number <double>
warnings
required
Array of strings
400

Bad Request

401

Unauthorized

post/logistics/api/2023-10/parcels/quote
Request samples
application/json
{
  • "serviceLevel": "string",
  • "injectionLocation": "string",
  • "shipToAddress": {
    • "name": "string",
    • "company": "string",
    • "street1": "string",
    • "street2": "string",
    • "city": "string",
    • "zip": "string",
    • "state": "string",
    • "country": "string",
    • "phone": "string",
    • "email": "string",
    • "isResidential": true
    },
  • "dimensions": {
    • "height": 5,
    • "length": 2,
    • "lengthUnit": "in",
    • "weight": 1,
    • "weightUnit": "oz",
    • "width": 8
    }
}
Response samples
application/json
{
  • "price": 0,
  • "serviceLevel": "string",
  • "billedWeightLbs": 0,
  • "dimensions": {
    • "height": 5,
    • "length": 2,
    • "lengthUnit": "in",
    • "weight": 1,
    • "weightUnit": "oz",
    • "width": 8
    },
  • "warnings": [
    • "string"
    ]
}