List Scanning Stations

Beta
GET/v1/operations/scanning-stations

This endpoint is idempotent. Learn more

Returns a paginated list of scanning stations in your account.

The q search term matches the station name.

Permissions requiredValues:scanners:read
The role behind your API key or agent must grant every one of these permissions.
cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:departmentproduction_steps

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of scanning_station

Resources in this page.

idstring

Scanning station ID.

objectstringenumValues:scanning_station

Resource type identifier.

namestring

Display name of the scanning station.

Unique within the account.

notesstringnullable

Free-form notes about the scanning station.

typestringenumValues:init_batchmerge_batchmove_batch

Scanning station type, determining which batch operation an operator performs when they scan here.

  • init_batch: starts a new batch at the beginning of a production flow.
  • merge_batch: combines several scanned batches into one.
  • move_batch: advances a batch through a production step connected to this station.
  • split_batch: divides a batch into several batches.

Fixed when the station is created.

label_sizestringnullableenumValues:1x11x31x4

Size of the labels printed at this station, given as width-by-height (for example, 1x1).

label_typestringnullableenumValues:tagtraveler

Type of label printed at this station.

  • tag: a label attached to the physical product.
  • traveler: a routing sheet that accompanies the batch through every production step.
operator_requirementstringenumValues:nonematerial_check

Whether operators must perform a material check at this station.

  • none: no additional operator check is required.
  • material_check: a material check is expected before the operation.
departmentdepartmentExpandablenullable

The department this scanning station belongs to.

Assigned when the station is created and cannot be reassigned afterward.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationlocationnullable

The storage location where this department operates.

Always returned as null in this endpoint.
scanning_stationslistnullable

Scanning stations in this department.

Always returned as null in this endpoint.
machineslistnullable

Machines in this department.

Always returned as null in this endpoint.
labor_rateratenullable

Hourly labor rate for work done in this department, such as a changeover technician.

Production scheduling costs changeovers with the constraint department's rate when one is set, falling back to the account-wide changeover labor rate setting.

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

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

production_stepslistExpandablenullable

Production steps connected to this station.

A production step can be connected to at most one scanning station, so connecting a step here disconnects it from any other station. Manage the connections with Connect Production Steps to Scanning Station.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of production_step

Resources in this page.

idstring

Production step ID.

objectstringenumValues:production_step

Resource type identifier.

namestring

Display name of the step.

notesstringnullable

Free-form notes about the step.

leveling_factorstring (decimal)

Leveling correction factor applied to labor time in cost calculations, as a decimal string.

Effective labor time per unit is labor_time × (1 + leveling_factor) × (1 + allowances).

allowancesstring (decimal)

Allowance correction factor applied to labor time in cost calculations, as a decimal string.

Effective labor time per unit is labor_time × (1 + leveling_factor) × (1 + allowances).

labor_rateratenullable

Cost of labor for this step, expressed as a rate of currency per unit of time (e.g. $ per hr).

Always returned as null in this endpoint.
labor_timeratenullable

Labor duration for this step, expressed as a rate (e.g. time per unit of output).

Always returned as null in this endpoint.
overhead_rateratenullable

Overhead cost for this step, expressed as a rate of currency per unit of time (e.g. $ per hr).

Always returned as null in this endpoint.
productionproductionnullable

The item and quantity this step produces.

Always returned as null in this endpoint.
consumptionslistnullable

Materials this step consumes as inputs, with their quantities and expected waste.

Always returned as null in this endpoint.
machineslistnullable

Machines assigned to this step.

Always returned as null in this endpoint.
scanning_stationscanning_stationnullable

Scanning station where this step's batches are scanned.

Always returned as null in this endpoint.
in_stepslistnullable

Steps that feed into this step.

Always returned as null in this endpoint.
out_stepslistnullable

Steps that this step feeds into.

Always returned as null in this endpoint.
departmentdepartmentnullable

Department responsible for this step.

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