package_types

Get custom package type by id

Get Custom Package Type by ID

get/v2/packages/{package_id}

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/packages/{package_id}
  • Auth: API key in header api-key

Response

The request was a success.

package_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

package_codestring required

A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.

namestring required
descriptionstring

Provides a helpful description for the custom package.

Example response

{
  "package_id": "se-28529731",
  "package_code": "small_flat_rate_box",
  "name": "laptop_box",
  "dimensions": {
    "length": 2,
    "width": 2,
    "height": 1
  },
  "description": "Packaging for laptops"
}

Changes

No recorded changes to this operation across all 1 revision of this API.