List Scanning Stations

Beta
GET/v1/operations/scanning-stations

This endpoint is idempotent. Learn more

Returns a paginated list of scanning stations for the current account.

cursoroptional string

Query parameter: cursor for List Scanning Stations

limitoptional integer

Query parameter: limit for List Scanning Stations

qoptional string

Query parameter: q for List Scanning Stations

include[]optional arrayenumValues:departmentproduction_steps

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Object type for ScanningStation list

page_infoobject

Pagination metadata for ScanningStation list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of ScanningStation resources in this page

idstring

Scanning station ID.

objectstringenumValues:scanning_station

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:init_batchmerge_batchmove_batch

Scanning station type.

label_sizestringnullableenumValues:1x11x31x4

Label size code.

label_typestringnullableenumValues:tagtraveler

Label type code.

material_check_requiredboolean

Whether material check is required.

departmentobjectExpandablenullable

Department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

Always returned as null in this endpoint.
scanning_stationsobjectnullable

Scanning stations in this department.

Always returned as null in this endpoint.
machinesobjectnullable

Machines in this department.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

production_stepsobjectExpandablenullable

Connected production steps.

objectstringenumValues:list

Object type for ProductionStep list

page_infoobject

Pagination metadata for ProductionStep list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of ProductionStep resources in this page

idstring

Production step ID.

objectstringenumValues:production_step

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

leveling_factorstring (decimal)

Leveling factor as a decimal string.

allowancesstring (decimal)

Allowances as a decimal string.

labor_rateobjectnullable

Labor rate.

Always returned as null in this endpoint.
labor_timeobjectnullable

Labor time.

Always returned as null in this endpoint.
overhead_rateobjectnullable

Overhead rate.

Always returned as null in this endpoint.
productionobjectnullable

Production output.

Always returned as null in this endpoint.
consumptionsarray of object

Consumptions.

Always returned as null in this endpoint.
machinesarray of object

Machines assigned to this step.

Always returned as null in this endpoint.
scanning_stationobjectnullable

Scanning station.

Always returned as null in this endpoint.
in_stepsarray of object

Input steps feeding into this step.

Always returned as null in this endpoint.
out_stepsarray of object

Output steps this step feeds into.

Always returned as null in this endpoint.
departmentobjectnullable

Department.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Scanning Stations