Overview

A commodity is a unit of freight being shipped. Commodities are assigned to tasks and have the ability to impact shipping charges based on weight and size, as well as commodity type.

API configuration

When using the API to make requests, see the pages below for the process. These guides walk through the requirements and setup to access the Rose Rocket API with your application.

Authentication - Access Rose Rocket with OAuth 2.0
Object operations - Configure your requests

Object structure

Use the table below for information about the commodity objects.

Fields	Labels	DataType	Descriptions	Remarks
`id`	Commodity ID	`string`	Unique identifier of the record.
`fullId`	Auto-generated Commodity ID	`string`	A human-readable identifier for the commodity
`freightClass`	Freight Class	`string`	Specifies the classification of commodities for freight purposes, determined by factors like ease of handling, value, weight, length, height, density, and liability.	This field can only accept specific predefined values from the options listed. Provided options: - none - 50 - 55 - 60 - 65 - 70 - 77.5 - 85 - 92.5 - 100 - 110 - 125 - 150 - 175 - 200 - 250 - 300 - 400 - 500
`commodityType`	Commodity Typ	`Enum`	Specifies the type of commodity being transported.	This field allows selection from predefined Enum options representing different types of commodities. Enum options: - bundle - carton - skid - package - container - crate - pallet - other
`weightUnit`	Weight Unit	`Enum`	Specifies the unit of measurement for weight.	Select one of the provided Enum options: - kgs - lbs - metric tonnes - tons
`volumeUnit`	Volume Unit	`Enum`	Specifies the unit of measurement for volume.	Select one of the provided Enum options: - gallons - liters - cubic feet
`dimensionUnit`	Dimension Unit	`Enum`	Specifies the unit of measurement for dimensions.	Select one of the provided Enum options: - cm - in - ft
`temperatureUnit`	Temperature Unit	`Enum`	Specifies the unit of measurement for temperature.	Select one of the provided Enum options: - f - c
`packingGroupNumber`	Packing Group Number	`Enum`	Specifies the packing group number of the commodity.	Select one of the provided Enum options: - pgi - pgii - pgiii
`hazmatClass`	Hazmat Class	`Enum`	Specifies the hazardous material classification (hazmat) of the commodity.	Classifications outlined by the US Department of Transportation. To know about all the classes listed, view list. Select one of the provided Enum options: - class1 - class2 - class3 - class4 - class5 - class6 - class7 - class8 - class9
`name`	Name	`string`	Specifies the name of a commodity or item being transported.
`description`	Description	`string`	Specifies the additional description of the commodity being transported.
`nmfc`	NMFC Code	`string`	Specifies the NMFC(National Motor Freight Classification) code for the commodity.
`isStackable`	Stackable	`boolean`	Indicates whether the items can be stacked on top of other items during transportation.
`isHazardous`	Hazardous	`boolean`	Indicates whether the commodity is hazardous.
`quantity`	Quantity	`number`	Indicates the amount of a specific commodity being transported.
`pieces`	Pieces	`number`	Specifies the count of individual units or packages of the commodity being transported.
`sku`	SKU Number	`string`	Specifies the SKU number of the commodities.
`volume`	Volume	`number`	Specifies the volume of the commodities.
`weightUnit`	Weight	`number`	Indicates the weight of the commodity being transported.
`linearFeet`	Linear Feet	`number`	Indicates the length of the commodity in feet when arranged in a linear dimension.
`length`	Length	`number`	Specifies the length of the commodity measured in inches or centimeters.
`width`	Width	`number`	Specifies the width of the commodity being transported.
`height`	Height	`number`	The height measurement of the commodity being transported.
`properShippingName`	Proper Shipping Name	`string`	Specifies the standard technical name to define the hazard properties and the composition of dangerous goods.
`emergencyContact`	Emergency Contact	`string`	Specifies the emergency contact of the commodity being transported.
`minTemperature`	Minimum Temperature	`number`	Specifies the minimum temperature required for safe transportation of the commodity.
`maxTemperature`	Maximum Temperature	`number`	Specifies the maximum temperature required for safe transportation of the commodity.
`unNumber`	unNumber	`number`	Specifies the UN (United Nations) four-digit number that identifies hazardous materials.
tasks	Tasks	Task connected object array *See Connected object section	Specifies the tasks that are handling this commodity.	Relates to Tasks object.