v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Shipping::Package

Create Package

Add a new package to a workspace

post/workspaces/{workspace_id}/shipping/packages

Path parameters

workspace_idinteger required

Request body

Example request

{
  "shipping_package": {
    "shipping_package": {
      "package_type": "box",
      "height": "4.0",
      "width": "2.0",
      "length": "2.0",
      "distance_unit": "in",
      "empty_weight": null,
      "weight": "0.0",
      "weight_unit": "lb",
      "default_package": false,
      "name": "Example Package",
      "carrier": null
    }
  }
}

Response

Created

idinteger

Package ID

public_idstring nullable

Package public ID

package_type'box' | 'envelope' | 'soft_package'

Package Type

heightnumber

Height

widthnumber

Width

lengthnumber

Length

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

Distance Unit

empty_weightstring nullable

Empty Weight

weightnumber nullable

Weight

weight_unit'lb' | 'kg' | 'g' | 'oz' nullable

Weight Unit

default_packageboolean nullable

Default Package

namestring

Name

tokenstring nullable

Token

carrier'fedex' | 'ups' | 'usps' nullable

Carrier

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

{
  "id": 1,
  "public_id": "EpuezP",
  "package_type": "box",
  "height": "4.0",
  "width": "2.0",
  "length": "2.0",
  "distance_unit": "in",
  "empty_weight": null,
  "weight": "0.0",
  "weight_unit": "lb",
  "default_package": false,
  "name": "Example Package",
  "token": null,
  "carrier": null,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}