> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Enumerations

## Methods

* [enumeration.list](#enumeration-list)
* [enumeration.info](#enumeration-info)

***

## Entity Properties

* [Enumeration](#enumeration-properties)

***

## `enumeration.list`

`enumeration.list (int|null $warehouseId)`

Get all enumerations.

### Parameters

<ParamField path="warehouseId" type="integer | null">
  Warehouse.
</ParamField>

### Return Value

An array of [Enumerations](#enumeration-properties) or an empty array.

### Example Request

Get all enumerations:

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "enumeration.list"
    ]
}
```

Get all enumerations for warehouse "2":

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "enumeration.list",
        [2]
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "result" : {
        "catalog": {
            "goods_type": {
                "singular_name": "Goods Type",
                "plural_name": "Goods Types",
                "data": [
                    {
                        "key": "HAZMAT",
                        "label": "Regulated"
                    },
                    {
                        "key": "LIMITED_QUANTITIES_COMMODITIES",
                        "label": "Limited Quantities: Consumer Commodity"
                    },
                    {
                        "key": "NORMAL",
                        "label": "Not Regulated"
                    }
                ]
            }
        },
        "shipment": {
            "status": {
                "singular_name": "Status",
                "plural_name": "Statuses",
                "data": [
                    {
                        "key": "canceled",
                        "label": "Canceled"
                    },
                    {
                        "key": "shipped",
                        "label": "Shipped"
                    },
                    {
                        "key": "new",
                        "label": "New"
                    },
                    {
                        "key": "packed",
                        "label": "Packed"
                    },
                    {
                        "key": "packing",
                        "label": "Packing"
                    },
                    {
                        "key": "picked",
                        "label": "Picked"
                    },
                    {
                        "key": "picking",
                        "label": "Picking"
                    },
                    {
                        "key": "voided",
                        "label": "Voided"
                    }
                ]
            }
        }
    }
}
```

## `enumeration.info`

`enumeration.info (string $path, int|null $warehouseId)`

Get enumeration info.

### Parameters

<ParamField path="path" type="string">
  Path.
</ParamField>

<ParamField path="warehouseId" type="integer | null">
  Warehouse.
</ParamField>

### Return Value

[Enumeration](#enumeration-properties).

### Example Request

Get enumeration info:

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "enumeration.info",
        ["catalog/goods_type"]
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "result" : {
        "singular_name": "Goods Type",
        "plural_name": "Goods Types",
        "data": [
            {
                "key": "HAZMAT",
                "label": "Regulated"
            },
            {
                "key": "LIMITED_QUANTITIES_COMMODITIES",
                "label": "Limited Quantities: Consumer Commodity"
            },
            {
                "key": "NORMAL",
                "label": "Not Regulated"
            }
        ]
    }
}
```

## Entity Properties

### Enumeration Properties

<Expandable title="Enumeration Properties">
  <ParamField path="singular_name" type="string">
    The singular name.
  </ParamField>

  <ParamField path="plural_name" type="string">
    The plural name.
  </ParamField>

  <ParamField path="depends_on_merchant" type="boolean">
    Depends on merchant flag is only returned when the value is true.
  </ParamField>

  <ParamField path="depends_on_warehouse" type="boolean">
    Depends on warehouse flag is only returned when the value is true.
  </ParamField>

  <ParamField path="data" type="array">
    Enumeration data.
  </ParamField>
</Expandable>