This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17

GET /scanners/{scannerId}

Get list of Scanners

Description

Returns list of Scanners

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by.  
sortDirection optional Direction of sort. asc, desc
keyword[eq] optional Search for . Allowed expression(s): eq, in  
keyword[eq] optional Search for . Allowed expression(s): eq, ct  
include optional The resources that can be included in this request, delimited by a comma: warehouse_location  

Responses

200

successful operation

406

not acceptable

500

internal server error

POST /scanners/{scannerId}

Create new Scanner

Description

Create a new Scanner

Request body

Description

Target scanner.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "integration_id": {
      "description": "Integration id",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "warehouse_location_id": {
      "description": "Warehouse location id",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "default_order_section": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "name": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "ref": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "scanner_data": {
      "description": "No description is available",
      "format": "",
      "example": ""
    },
    "active": {
      "description": "Boolean indicating if the record is active and could be referenced from other entities",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

200

successful operation

406

not acceptable

500

internal server error