package_types

Create custom package type

Changed on

Create a custom package type to better assist in getting accurate rate estimates

post/v1/packages

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/packages
  • Auth: API key in header API-Key

Request body

package_idstring

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

package_codestring required

A unique, user-defined identifier for the custom package type. Must start with "custom_".

namestring required
descriptionstring nullable

Provides a helpful description for the custom package.

Example request

{
  "package_id": "se-28529731",
  "package_code": "custom_laptop_box",
  "name": "laptop_box",
  "description": "Packaging for laptops"
}

Response

The request was a success.

package_idstring

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

package_codestring required

A unique identifier for the custom package type. API-created packages start with "custom_". UI-created packages may use other codes.

namestring required
descriptionstring nullable

Provides a helpful description for the custom package.

Example response

{
  "package_id": "se-28529731",
  "package_code": "package",
  "name": "laptop_box",
  "description": "Packaging for laptops"
}

Changes

  • e998dffc42beRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

  • 020f57d6f5b8Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status