Update Allocation Package

PUT

/allocations/{allocation_id}/allocation_package

Update an allocation’s package. Useful if you need to specify package dimensions before making requests for shipping rates.

Parameters

Path Parameters

allocation_id

required

integer

ID of the Allocation

Request Body

Properties about the package to update

object

allocation_package

object

weight

Weight of the package

number

weight_unit

Unit of weight. Can be g or oz

string

width

Width of the package

number

height

Height of the package

number

depth

Depth of the package

number

dimensions_unit

Unit of length, width and depth.

string

package_provider

The name of the package. If you’re setting dimensions via the API, this should be set to CUSTOM.

string

package_selection_source

The source of the package selection. If you’re setting dimensions via the API, this should be set to ONE_OFF.

string

save_for_similar_shipments

Whether to save the package for similar shipments. Should be set to false.

boolean

Responses

200

The allocation package was successfully updated.

Example

{
  "id": "221127044",
  "type": "allocation_package",
  "attributes": {
    "allocation_id": 447345401,
    "created_at": "2025-02-25T17:03:00.202Z",
    "depth": 7,
    "height": 234,
    "package_id": null,
    "package_provider": "CUSTOM",
    "package_selection_source": "ONE_OFF",
    "package_name": null,
    "similarity_key": "b85f12fa270a46dbfe254f4e6085b59f626ec4f2",
    "updated_at": "2025-06-10T13:12:21.847Z",
    "weight": 29.98,
    "width": 433,
    "weight_unit": "oz",
    "dimensions_unit": "inches"
  }
}

422

The allocation package failed to update. Check the contents of the request body.