Skip to main content

ServiceWarehouseListResponse

successbooleanrequired

Always true on a 2xx response.

Example: true
data object[]required

The workspace's warehouses.

  • Array [
  • idstring<uuid>required

    Warehouse id.

    Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
    codestringnullablerequired

    Warehouse code.

    Example: MAIN
    namestringnullablerequired

    Warehouse name.

    Example: Main warehouse
    typestringnullablerequired

    Warehouse type.

    Example: WAREHOUSE
    statusstringnullablerequired

    Operating status.

    Possible values: [ACTIVE, INACTIVE, MAINTENANCE, null]

    address objectnullablerequired

    The warehouse address as key/value pairs.

    property name*anynullable

    The warehouse address as key/value pairs.

    Example: {"street1":"1 Example Street","city":"Exampleville"}
  • ]
  • ServiceWarehouseListResponse
    {
    "success": true,
    "data": [
    {
    "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
    "code": "MAIN",
    "name": "Main warehouse",
    "type": "WAREHOUSE",
    "status": "ACTIVE",
    "address": {
    "street1": "1 Example Street",
    "city": "Exampleville"
    }
    }
    ]
    }