Skip to main content
POST
/
api
/
packages
Create a package
curl --request POST \
  --url https://clarus-api.com/api/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "packages",
    "attributes": {
      "shipment_id": 1530,
      "storage_unit_type_id": 12,
      "tracking_number": "1Z999AA10123456784",
      "dimensions": {
        "unit_of_measure": "centimetre",
        "length": 120,
        "width": 80,
        "height": 120,
        "weight": 15.5,
        "weight_unit_of_measure": "kilogram"
      }
    }
  }
}
'
{
  "data": {
    "id": "1",
    "type": "packages",
    "attributes": {
      "tracking_number": "1Z999AA10123456784",
      "storage_unit_id": null
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "packages",
    "attributes": {
      "shipment_id": 1530,
      "storage_unit_type_id": 12,
      "tracking_number": "1Z999AA10123456784",
      "dimensions": { "unit_of_measure": "centimetre", "length": 120.0, "width": 80.0, "height": 120.0, "weight": 15.5 }
    }
  }
}
FieldRequiredDescription
storage_unit_type_idYesStorage unit type
shipment_idNoOwning shipment
tracking_numberNoCarrier tracking number
dimensionsNoNested dimensions object (unit_of_measure required within)

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
data
object
required

Response

Created successfully

The response is of type object.