{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/shipping/custom-package-types","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/shipping/custom-package-types","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/shipping/custom-package-types","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Custom Package Types","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"custom-package-types","__idx":0},"children":["Custom Package Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have your own custom packaging with specific dimensions that you use frequently (either in place of or in addition to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/shipping/carrier-packaging"},"children":["carrier defined packages"]},"), you might find it helpful to define those custom package types to use more easily in your shipments. You can then simply include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package_code"]}," property in your shipment object, instead of the individual dimension properties."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"define-a-package-type","__idx":1},"children":["Define a Package Type"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can define as many package types as you need, each with their own name, package code, and set of dimensions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"requirements","__idx":2},"children":["Requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following properties are required in the request body when creating a custom package type:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package_code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Max 50 characters. This is the code you will use in your shipment objects. Each custom package must add the prefix ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_"]}," to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package_code"]}," or the request will be rejected with a HTTP 400, Bad Request status."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Max 50 characters. Any custom name you choose to help identify the package."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requires the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["length"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["width"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["height"]}," properties"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"optional-properties","__idx":3},"children":["Optional Properties"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package_id"]},", which is a string (max 25 characters) that uniquely identifies the package, and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", a string of up to 500 characters."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request--response","__idx":4},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /v1/packages/"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/packages HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"package_code\": \"custom_laptop_box\",\n  \"name\": \"laptop_box\",\n  \"dimensions\": {\n    \"unit\": \"inch\",\n    \"length\": 15,\n    \"width\": 20,\n    \"height\": 5\n  },\n  \"description\": \"Packaging for laptops.\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response will simply include all of the packages defined properties."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"package_id\": \"se-100896\",\n  \"package_code\": \"custom_laptop_box\",\n  \"name\": \"laptop_box\",\n  \"dimensions\": {\n    \"unit\": \"inch\",\n    \"length\": 15.0,\n    \"width\": 20.0,\n    \"height\": 5.0\n  },\n  \"description\": \"Packaging for laptops.\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-package-types","__idx":5},"children":["List Package Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List your package types to get a response with an array of all the available custom packaging available in your account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request--response-1","__idx":6},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET /v1/packages"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/packages HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"packages\": [\n    {\n      \"package_id\": \"se-102873\",\n      \"package_code\": \"custom_laptop_box\",\n      \"name\": \"Custom Laptop Box\",\n      \"dimensions\": {\n        \"unit\": \"inch\",\n        \"length\": 15.00,\n        \"width\": 20.00,\n        \"height\": 5.00\n      },\n      \"description\": \"\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete-package-types","__idx":7},"children":["Delete Package Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deleting a package will not disassociate it from any shipments. It will merely stop being available for use with future shipments and it will will no longer be included in the list packages response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You will need the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package_id"]}," of the custom package you wish to delete."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request--response-2","__idx":8},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DELETE /v1/packages/:package_id"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"DELETE /v1/packages/se-102873 HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If successful, you'll receive an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Status 204, No Content"]}," response."]}]},"headings":[{"value":"Custom Package Types","id":"custom-package-types","depth":1},{"value":"Define a Package Type","id":"define-a-package-type","depth":2},{"value":"Requirements","id":"requirements","depth":3},{"value":"Optional Properties","id":"optional-properties","depth":3},{"value":"Example Request & Response","id":"example-request--response","depth":3},{"value":"List Package Types","id":"list-package-types","depth":2},{"value":"Example Request & Response","id":"example-request--response-1","depth":3},{"value":"Delete Package Types","id":"delete-package-types","depth":2},{"value":"Example Request & Response","id":"example-request--response-2","depth":3}],"frontmatter":{"seo":{"title":"Custom Package Types"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/shipping/custom-package-types","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}