5.7 Compartment Object
An compartment object has the following fields:
- Field: scheme_id
Required: Yes.
Type: String.
Description: The identifier of the compartment scheme to which this compartment belongs.
- Field: id
Required: Yes.
Type: String.
Description: The identifier for the compartment. This must be unique within the scheme
to which this compartment belongs.
- Field: name
Required: No.
Type: String.
Description: A descriptive name for the compartment. This must be unique with the scheme
to which this compartment belongs.
- Field: maximum_weight
Required: Yes.
Type: Number.
Description: The maximum weight capacity of the compartment.
- Field: maximum_volume
Required: Yes.
Type: Number.
Description: The maximum volume capacity of the compartment.
- Field: attributes
Required: No.
Type: Array of strings.
Description: Any attributes attached to this compartment.