Create Scanning Station
Beta/v1/operations/scanning-stationsIdempotent with Idempotency-Key header. Learn more
Creates a scanning station and assigns it to a department.
Returns a conflict error if a scanning station with the same name already exists.
include[]optional arrayenumValues:departmentproduction_stepsSub-objects to expand in the response. When omitted, sub-objects are returned as null.
namestringDisplay name of the scanning station.
Must be unique within your account; maximum 255 characters.
notesoptional stringFree-form notes about the scanning station.
typestringenumValues:init_batchmerge_batchmove_batchScanning station type, determining which batch operation the station performs.
init_batch: initializes a new batch.merge_batch: merges multiple batches into one.move_batch: moves a batch to another location or step.split_batch: splits a batch into multiple batches.
The type cannot be changed after creation.
operator_requirementstringenumValues:nonematerial_checkWhether 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.
department_idstringID of the department this station belongs to.
label_sizeoptional stringenumValues:1x11x31x4Size of the labels printed at this station, given as width-by-height (for example, 1x1).
label_typeoptional stringenumValues:tagtravelerType 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.
idstringScanning station ID.
objectstringenumValues:scanning_stationResource type identifier.
namestringDisplay name of the scanning station.
Unique within the account.
notesstringnullableFree-form notes about the scanning station.
typestringenumValues:init_batchmerge_batchmove_batchScanning station type, determining which batch operation the station performs.
init_batch: initializes a new batch.merge_batch: merges multiple batches into one.move_batch: moves a batch to another location or step.split_batch: splits a batch into multiple batches.
label_sizestringnullableenumValues:1x11x31x4Size of the labels printed at this station, given as width-by-height (for example, 1x1).
label_typestringnullableenumValues:tagtravelerType 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_checkWhether 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.
departmentdepartmentExpandablenullableThe department this scanning station belongs to.
idstringDepartment ID.
objectstringenumValues:departmentResource type identifier.
namestringDisplay name of the department.
Unique within the account.
notesstringnullableFree-form notes about the department.
locationlocationnullableThe storage location where this department operates.
null in this endpoint.Scanning stations in this department.
null in this endpoint.Machines in this department.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
Production steps connected to this station.
A production step can be connected to at most one scanning station.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of production_stepResources in this page.
idstringProduction step ID.
objectstringenumValues:production_stepResource type identifier.
namestringDisplay name of the step.
notesstringnullableFree-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_rateratenullableCost of labor for this step, expressed as a rate of currency per unit of time (e.g. $ per hr).
null in this endpoint.labor_timeratenullableLabor duration for this step, expressed as a rate (e.g. time per unit of output).
null in this endpoint.overhead_rateratenullableOverhead cost for this step, expressed as a rate of currency per unit of time (e.g. $ per hr).
null in this endpoint.productionproductionnullableThe item and quantity this step produces.
null in this endpoint.Materials this step consumes as inputs, with their quantities and expected waste.
null in this endpoint.Machines assigned to this step.
null in this endpoint.Scanning station where this step's batches are scanned.
null in this endpoint.Steps that feed into this step.
null in this endpoint.Steps that this step feeds into.
null in this endpoint.departmentdepartmentnullableDepartment responsible for this step.
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
Successful response for Create Scanning Station