Get Items

GET 
/items

Get all items from the database that match the query.

Parameters

group_by: string (optional)

Field to group items by. If not provided, items will not be grouped.

skip: integer (optional)

Number of items to skip in the result. Must be greater or equal to 0.

limit: integer (optional)

Maximum number of items to return. Must be greater or equal to 0.

start_date: datetime (optional)

Include items created after this date.

end_date: datetime (optional)

Include items created before this date.

Returns

list of Item

A list of items matching the query.

Request

Query Parameters

group_by Group By

Field to group by

skip Skip

Number of items to skip

limit Limit

Maximum number of items to return

start_date date-time

Include items created after this date

end_date date-time

Include items created before this date

Responses

200

Successful Response

application/json

Schema

Schema

• Array [
created_at date-time

The time the item was created

updated_at date-time
owner_id Owner Id

The ID of the user the object belongs to

_id Id

The unique identifier for the object

scanner_account_id Scanner Account Id

The ID of the account that scanned the item

started_at date-timerequired

Time at which user started flow.

ended_at date-timerequired

Time at which user finished entire flow.

flow_id Flow Id

The ID of the flow used during the scanning session

photographing object[]
The list of photographing steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
The time at which the photographing step started
ended_at date-timerequired
The time at which the photographing step ended
photos object[]
The list of photos that were taken during the photographing step
Array [
date date-timerequired
The date and time the photo was taken
url Url
The url of the photo
]
]
dimensioning object[]
The list of dimensioning steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
Time at which user started dimensioning step
ended_at date-timerequired
Time at which user finished dimensioning step
mode object
The mode of dimensioning
anyOf
DimensioningMode
string
MOD2
string
dimensions object
started_at date-timerequired
Time at which user first saw predicted dimensions
ended_at date-timerequired
Time at which user confirmed the final dimensions.
width Widthrequired
The final width of the item
height Heightrequired
The final height of the item
depth Depthrequired
The final depth of the item
unit DimensioningUnit
Possible values: [m, mm, cm, ft, in]
The unit of the dimensions
allowed_rotations object
_id Id
The unique identifier for the object
started_at date-timerequired
Time at which user started filling in allowed rotations
ended_at date-timerequired
Time at which user finished filling in allowed rotations
allow_width_depth_on_floor Allow Width Depth On Floorrequired
Whether the item can be placed down with its width and depth facing the floor
allow_width_height_on_floor Allow Width Height On Floorrequired
Whether the item can be placed down with its width and height facing the floor
allow_depth_height_on_floor Allow Depth Height On Floorrequired
Whether the item can be placed down with its depth and height facing the floor
screenshot object
url Url
The url of the screenshot of the item with the bounding box
date date-time
The date and time the screenshot was taken
bounding_box_manual_edited Bounding Box Manual Edited
Whether the bounding box was manually edited
bounding_box_dims number[]
The final bounding box dimensions
recordings object[]
The list of dimension recordings
Array [
screenshot object
url Url
The url of the screenshot of the item with the bounding box
date date-time
The date and time the screenshot was taken
dims number[]
The dimensions of the bounding box as measured at this specific step in the dimensioning process in meters
frames object[]
The list of frames taken during the recording
Array [
rgb object
date date-timerequired
The date and time the photo was taken
url Url
The url of the photo
]
]
]
weighing object[]
The list of weighing steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
The time at which the weighing step started
ended_at date-timerequired
The time at which the weighing step ended
weight Weightrequired
The weight of the item
unit object
An enumeration.
photos object[]
The photos of the weight scale's display
Array [
date date-timerequired
The date and time the photo was taken
url Url
The url of the photo
]
]
barcode_scanning object[]
The list of barcode scanning steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
Time at which user started barcode collection
ended_at date-timerequired
Time at which user finished barcode collection
code Coderequired
The scanned barcode
]
single_choices object[]
The list of single choice steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
The time at which the single choice step started
ended_at date-timerequired
The time at which the single choice step ended
choice Choice
The choice that has to be made
selected Selected
The selected choice
]
multi_choices object[]
The list of multi choice steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
ended_at date-timerequired
choice Choice
The question
selected string[]
The selected choices
]
custom_inputs object[]
The list of custom input steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
title Titlerequired
The question
started_at date-timerequired
The date and time the custom input module was started
ended_at date-timerequired
The date and time the custom input module was ended
double_val Double Val
The value of the custom input (if it is a number input)
string_val String Val
The value of the custom input (if it is a string input)
]
• ]

Example (from schema)

[
  {
    "startedAt": "2024-12-06T08:36:30.192143",
    "endedAt": "2024-12-06T08:37:30.192157",
    "photographing": [],
    "dimensioning": [],
    "weighing": [],
    "barcodeScanning": []
  }
]

404

Not Found

application/json

Schema

Schema

message Messagerequired
status_code Status Coderequired

Example (from schema)

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

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD2
string
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...