parsel

Create shipment

POST/shipments

Create a shipment with origin, destination, and parcel details, and retrieve available rates. If buy_cheapest_rate is true, the cheapest rate will be bought and a shipping label will be created.

Headers

AuthorizationRequired
Bearer authentication of the form Bearer <token>, where token is your auth token

Request

Shipment params

buy_cheapest_rateboolean
If true, the cheapest shipping rate will be automatically purchased
custom_reference_1string
An optional message to include on the shipping label.
custom_reference_2string
A second optional message to include on the shipping label.
customs_infoobject
Customs information. Required for international (non US) shipments only.
destinationobjectRequired
label_formatenum
The format of the shipping label, defaults to PNG
originobjectRequired
parcelobjectRequired
rate_shopping_profilestringformat: "uuid"
An optional reference ID to apply specific rate shopping configurations. If provided and a matching profile exists, it will override the default rate shopping configuration.
return_addressobject
Return address for the shipment. If not provided, defaults to the origin address.

Example Request

curl -X POST https://api.parsel.app/shipments
  -H "Authorization: Bearer <bearer_token>"
  -H "Content-Type: application/json"
  -d '{
  "customs_info": {
    "customs_items": [
      {
        "description": "Cotton T-shirt",
        "harmonized_system_code": "6109.10.00",
        "origin_country": "US",
        "quantity": 3,
        "value": 10,
        "weight": 5,
        "weight_unit": "OZ"
      }
    ],
    "customs_signer": "Steve Brule",
    "incoterm": "DAP"
  },
  "destination": {
    "city": "New York",
    "company": "Acme Inc.",
    "country": "US",
    "email": "jane.doe@example.com",
    "name": "Jill",
    "phone": "+1234567890",
    "state": "NY",
    "street1": "169 Madison Avenue",
    "street2": "#2041",
    "zip": "10016"
  },
  "origin": {
    "city": "Atlanta",
    "company": "Acme Inc.",
    "country": "US",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1234567890",
    "state": "GA",
    "street1": "313 Nelson Street Southwest",
    "street2": "Suite 16001",
    "zip": "30313"
  },
  "parcel": {
    "height": 1.1,
    "length": 1.1,
    "length_unit": "IN",
    "weight": 1.1,
    "weight_unit": "OZ",
    "width": 1.1
  },
  "return_address": {
    "city": "Return City",
    "company": "Return Center Inc.",
    "country": "US",
    "email": "returns@example.com",
    "name": "Return Center",
    "phone": "+1234567890",
    "state": "CA",
    "street1": "456 Return St",
    "zip": "90210"
  }
}'

Response