DoRoutes API · version 1

Catalogue

GET/v1/item-options

The business's item catalogue

Response 200 · object

Done.

item_optionsarray of Item, required
- item_idinteger (int64)
- leg_idinteger (int64)
  On a quote, the leg the item travels on. Ignored when sent.
- typestring
- categorystring
- quantityinteger
- weightinteger
  Kilograms.
- lengthinteger
  Centimetres.
- widthinteger
- heightinteger
- fragileboolean
- handling_minutesinteger
  One person's minutes to handle the item; left out, they come from its size (20 a cubic metre).
- floorinteger
  On a quote, the floor the item is on; -1 is a basement and 0, the default, the ground floor.
- roominteger
  On a quote moved room by room, the index in its rooms of the item's room.
- roomsarray of string
  In the catalogue, the room types the item is usually found in.
- largeboolean
  In the catalogue, whether the item is large or awkward to move.

Example response 200

{
  "item_options": [
    {
      "item_id": 0,
      "leg_id": 0,
      "type": "string",
      "category": "string",
      "quantity": 0,
      "weight": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "fragile": true,
      "handling_minutes": 0,
      "floor": 0,
      "room": 0,
      "rooms": [
        "bedroom"
      ],
      "large": true
    }
  ]
}

Response 401 · Error

No tenant key, or no valid session.

errorobject, required
- codestring, required
  A short machine-readable name, such as not_found.
- messagestring, required
  What went wrong, for people.
request_idstring, required
Matches the X-Request-ID response header.

Example response 401

{
  "error": {
    "code": "string",
    "message": "string"
  },
  "request_id": "string"
}

Response 500 · Error

Something failed on our side.

Fields as in The business's item catalogue

POST/v1/admin/item-options

Add a catalogue item

Needs the settings.write permission.

Request body · Item

item_idinteger (int64)
leg_idinteger (int64)
On a quote, the leg the item travels on. Ignored when sent.
typestring
categorystring
quantityinteger
weightinteger
Kilograms.
lengthinteger
Centimetres.
widthinteger
heightinteger
fragileboolean
handling_minutesinteger
One person's minutes to handle the item; left out, they come from its size (20 a cubic metre).
floorinteger
On a quote, the floor the item is on; -1 is a basement and 0, the default, the ground floor.
roominteger
On a quote moved room by room, the index in its rooms of the item's room.
roomsarray of string
In the catalogue, the room types the item is usually found in.
largeboolean
In the catalogue, whether the item is large or awkward to move.

Example request

{
  "item_id": 0,
  "leg_id": 0,
  "type": "string",
  "category": "string",
  "quantity": 0,
  "weight": 0,
  "length": 0,
  "width": 0,
  "height": 0,
  "fragile": true,
  "handling_minutes": 0,
  "floor": 0,
  "room": 0,
  "rooms": [
    "bedroom"
  ],
  "large": true
}

Response 200 · object

Done.

messagestring, required
item_idinteger (int64), required

Example response 200

{
  "message": "string",
  "item_id": 0
}

Response 400 · Error

The request is not valid.

Fields as in The business's item catalogue

Response 401 · Error

No tenant key, or no valid session.

Fields as in The business's item catalogue

Response 403 · Error

The session may not do this.

Fields as in The business's item catalogue

Response 404 · Error

Not found, or not yours.

Fields as in The business's item catalogue

Response 409 · Error

It clashes with what is stored.

Fields as in The business's item catalogue

Response 500 · Error

Something failed on our side.

Fields as in The business's item catalogue

PUT/v1/admin/item-options/{id}

Change a catalogue item

Needs the settings.write permission.

Parameters

idstring, in the path, required

Request body · Item

Fields as in Add a catalogue item

Response 200 · object

Done.

messagestring, required
item_idinteger (int64), required

Example response 200

{
  "message": "string",
  "item_id": 0
}

Response 400 · Error

The request is not valid.

Fields as in The business's item catalogue

Response 401 · Error

No tenant key, or no valid session.

Fields as in The business's item catalogue

Response 403 · Error

The session may not do this.

Fields as in The business's item catalogue

Response 404 · Error

Not found, or not yours.

Fields as in The business's item catalogue

Response 409 · Error

It clashes with what is stored.

Fields as in The business's item catalogue

Response 500 · Error

Something failed on our side.

Fields as in The business's item catalogue

DELETE/v1/admin/item-options/{id}

Remove a catalogue item

Needs the settings.write permission.

Parameters

idstring, in the path, required

Response 200 · Message

Done.

messagestring, required

Example response 200

{
  "message": "string"
}

Response 400 · Error

The request is not valid.

Fields as in The business's item catalogue

Response 401 · Error

No tenant key, or no valid session.

Fields as in The business's item catalogue

Response 403 · Error

The session may not do this.

Fields as in The business's item catalogue

Response 404 · Error

Not found, or not yours.

Fields as in The business's item catalogue

Response 409 · Error

It clashes with what is stored.

Fields as in The business's item catalogue

Response 500 · Error

Something failed on our side.

Fields as in The business's item catalogue