Packaging Definition

Carrier packaging options are defined inside files that are then used by the ShipEngine Connect to offer these packaging options to users who utilize the carrier within one of our e-commerce applications. Each packaging type that you wish to offer should have its own definition file. These files can reside anywhere within your application as long as their locations are specified in the Carrier Application Definition file. The definition may be specified in JavaScript, TypeScript, JSON, or YAML.

Packaging Properties

Name	Type	Required?	Description
`id`	UUID	✔	UUID that uniquely identifies the packaging. This ID should never change.
`identifiers`	object		Your own identifiers for this packaging option.
`code`	string		Optional code used to map to what the carrier identify the packaging.
`name`	string	✔	The user-friendly name for this packaging (e.g. "Flat-Rate Box", "Large Padded Envelope").
`description`	string		A short, user-friendly description of the packaging.
`requiresWeight`	boolean		Indicates whether the weight must be specified when using this packaging.
`requiresDimensions`	boolean		Indicates whether the dimensions must be specified when using this packaging.

Examples

id: 03318192-3e6c-475f-a496-a4f17c1dbcae
identifiers:
  apiCode: PAK
name: Package
description: Your own packaging, up to 100 kilograms
requiresWeight: true
requiresDimensions: true

{
  id: "03318192-3e6c-475f-a496-a4f17c1dbcae",
  identifiers: {
    apiCode: "PAK"
  },
  code: "PAK",
  name: "Package",
  description: "Your own packaging, up to 100 kilograms",
  requiresWeight: true,
  requiresDimensions: true
}

{
  "id": "03318192-3e6c-475f-a496-a4f17c1dbcae",
  "code": "PAK",
  "name": "Package",
  "description": "Your own packaging, up to 100 kilograms",
  "requiresWeight": true,
  "requiresDimensions": true
}

import { PackagingDefinition } from "@shipengine/connect";
const packagePackaging: PackagingDefinition = {
  id: "03318192-3e6c-475f-a496-a4f17c1dbcae",
  code: "PAK",
  name: "Package",
  description:
    "Your own packaging, up to 100 kilograms",
  requiresWeight: true,
  requiresDimensions: true
};
export default packagePackaging;