5.7 Compartment Object

An compartment object has the following fields:

  1. Field: scheme_id
    Required: Yes.
    Type: String.
    Description: The identifier of the compartment scheme to which this compartment belongs.
  2. Field: id
    Required: Yes.
    Type: String.
    Description: The identifier for the compartment. This must be unique within the scheme to which this compartment belongs.
  3. 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.
  4. Field: maximum_weight
    Required: Yes.
    Type: Number.
    Description: The maximum weight capacity of the compartment.
  5. Field: maximum_volume
    Required: Yes.
    Type: Number.
    Description: The maximum volume capacity of the compartment.
  6. Field: attributes
    Required: No.
    Type: Array of strings.
    Description: Any attributes attached to this compartment.