Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Parcels

Retrieve an existing parcel

Returns parcel details using an existing parcel object ID (this will not return parcel details associated with un-purchased shipment/rate parcel object IDs).

get/parcels/{ParcelId}

Path parameters

ParcelIdstring required

Object ID of the parcel

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Response

Parcel

metadatastring
mass_unit'g' | 'kg' | 'lb' | 'oz' required

The unit used for weight.

weightstring required

Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.

distance_unit'cm' | 'in' | 'ft' | 'm' | 'mm' | 'yd' required

The measure unit used for length, width and height.

heightstring required

Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.

lengthstring required

Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted.

widthstring required

Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted.

object_createdstring date-time

Date and time of Parcel creation.

object_idstring

Unique identifier of the given Parcel object. This ID is required to create a Shipment object.

object_ownerstring

Username of the user who created the Parcel object.

object_state'VALID'

A Parcel will only be valid when all required values have been sent and validated successfully.

object_updatedstring date-time

Date and time of last Parcel update. Since you cannot update Parcels after they were created, this time stamp reflects the time when the Parcel was changed by Shippo's systems for the last time, e.g., during sorting the dimensions given.

testboolean

Indicates whether the object has been created in test mode.

Example response

{
  "extra": {
    "COD": {
      "amount": "5.5",
      "currency": "USD",
      "payment_method": "CASH"
    },
    "insurance": {
      "amount": "5.5",
      "content": "Laptop",
      "currency": "USD",
      "provider": "UPS"
    }
  },
  "metadata": "Customer ID 123456",
  "mass_unit": "lb",
  "weight": "1",
  "distance_unit": "in",
  "height": "1",
  "length": "1",
  "width": "1",
  "object_created": "2014-07-09T02:19:13.174Z",
  "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
  "object_owner": "shippotle@shippo.com",
  "object_state": "VALID",
  "object_updated": "2014-07-09T02:19:13.174Z"
}