This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /lots
Get list of lots
Description
Returns list of lots
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| sortBy | optional | Field to sort by. | |
| sortDirection | optional | Direction of sort. | asc, desc |
| order[eq] | optional | Lots on a specific order. Allowed expression(s): eq, in, ne | |
| not_on_order[eq] | optional | Lots noton a specific order. Allowed expression(s): eq, in | |
| order_type[eq] | optional | Lots on a specific order type. Allowed expression(s): eq, in | |
| order_lot_section[eq] | optional | Order lot lines on a specific order lot section. inbound or outbound. Allowed expression(s): eq, in | |
| trace[eq] | optional | Search for . Allowed expression(s): eq, in, ct | |
| lot[eq] | optional | Search for lot number in traces or in internal tracezilla lot number. Allowed expression(s): eq, in | |
| availability_date[eq] | optional | Search for lots with a given availability date. Allowed expression(s): eq, lt, lte, gt, gte | |
| manufacturing_date[eq] | optional | Search for lots by a given manufacturing date. Allowed expression(s): eq, lt, lte, gt, gte | |
| best_before_date[eq] | optional | Search for lots by a given best before date. Allowed expression(s): eq, lt, lte, gt, gte | |
| use_by_date[eq] | optional | Search for lots by a given use by date. Allowed expression(s): eq, lt, lte, gt, gte | |
| location[eq] | optional | Search for lots by location. Allowed expression(s): eq, in | |
| quantity_available[eq] | optional | Search for lots by quantity available. Allowed expression(s): eq, gt, lt, lte, gte | |
| partner[eq] | optional | Search for lots by the partner it is located at. Allowed expression(s): eq, in | |
| partner_location[eq] | optional | Search for lots by the partner location it is located at. Allowed expression(s): eq, in | |
| status[eq] | optional | Search for lots by status. Allowed expression(s): eq, in, ne | |
| sku[eq] | optional | Search for lots by SKU. Allowed expression(s): eq, in | |
| sku_tag[eq] | optional | Search for by SKU tag. Allowed expression(s): eq, in | |
| sku_category[eq] | optional | Search for lots by SKU category. Allowed expression(s): eq | |
| lot_number_complete[ct] | optional | Search for lots by internal lot number. Allowed expression(s): ct | |
| keyword[ct] | optional | Search for lots by keyword. Allowed expression(s): ct | |
| exclude_empty[eq] | optional | Search for lots. Exclude empty lots (lots with neither an on hand quantity or an available wuantity). Allowed expression(s): eq | |
| exclude_lost[eq] | optional | Exclude lost lots. Allowed expression(s): eq | |
| traceability[eq] | optional | Search for lots by traceability: traced_only or not_traced_only. Allowed expression(s): eq | |
| include | optional | The resources that can be included in this request, delimited by a comma: sku, attributes, attribute_values, attribute_values, dates, inbound_order, inbound_order_lot, lot_predecessor, partner, partner_location, traces, traces_brought_forward, inbound_parcels_count, outbound_parcels_count, inputs, inputs_specified |
Responses
200
successful operation
Response content 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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"availability_date": {
"description": "The date when the lot is available for dispositions",
"type": "string",
"format": "date",
"readOnly": true,
"example": "2019-01-01"
},
"batch_number": {
"description": "Batch number from batch number trace",
"type": "string",
"format": "string",
"readOnly": true,
"example": "ABC123"
},
"eol_date": {
"description": "The date when the final stock movement was made on the lot (End Of Life).",
"type": "string",
"format": "date",
"readOnly": true,
"example": "2019-01-01"
},
"expiry_date": {
"description": "Expiry date of the lot taken from lot dates",
"type": "string",
"format": "date",
"readOnly": true,
"example": "2019-01-01"
},
"inventory_value_actual": {
"description": "The actual inventory value per UoM",
"type": "number",
"format": "double",
"example": 1234.123
},
"inventory_value_budget": {
"description": "The expected inventory value per UoM",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"inventory_value_overhead": {
"description": "The overhead part of the inventory values per UoM",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"locked": {
"description": "If the lot is locked and therefore cannot be deleted",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"lot_number": {
"description": "The sequential lot_number of the lot",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"lot_number_complete": {
"description": "The complete lot number, including SKU-code and lot version",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"lot_predecessor_id": {
"description": "Id of the lot predecessor. Used for return orders and warehouse orders.",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"lot_sequence": {
"description": "The version of the lot",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"lot_sequence_source": {
"description": "The version of source lot (deprecated)",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"order_lines_count": {
"description": "Count of the orders that uses the lot",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"origin_country": {
"description": "The origin country",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"origin_spec_system": {
"description": "No description is available",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"origin_spec_value": {
"description": "No description is available",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"partner_location_id": {
"description": "Reference to the partner location where the lot is located",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"quantity_adjusted": {
"description": "The quantity that have been taken out by adjustments",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"quantity_available": {
"description": "The quantity that is available for dispositions",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"quantity_disposed": {
"description": "The quantity thats has already been disposed",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"quantity_on_hand": {
"description": "The quantity physically on hand",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"sku_id": {
"description": "Id of the sku",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"status": {
"description": "Status of the lot",
"type": "string",
"format": "string",
"enum": [
"draft",
"expected",
"confirmed",
"in_transit",
"partly_on_location",
"on_location",
"lost"
],
"readOnly": true,
"example": "A string"
},
"unit": {
"description": "The unit of the quantities",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"uom_conversion": {
"description": "The conversion factor between the unit of the quantities and the unit of measure on the SKU.",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"readOnly": true,
"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",
"readOnly": true,
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
}
},
"links": {
"description": "Links",
"properties": {
"first": {
"description": "Link to the first page",
"type": "string"
},
"last": {
"description": "Link to the last page",
"type": "string"
},
"next": {
"description": "Link to the next page",
"type": "string"
},
"prev": {
"description": "Link to the previous page",
"type": "string"
}
},
"type": "object"
},
"meta": {
"description": "Meta with pagination",
"properties": {
"current_page": {
"description": "The current page",
"type": "integer"
},
"from": {
"description": "The starting position of the current page results",
"type": "integer"
},
"last_page": {
"description": "The last page",
"type": "integer"
},
"path": {
"description": "The current path of the request",
"type": "string"
},
"per_page": {
"description": "Records that are displayed pr request",
"type": "integer"
},
"to": {
"description": "The ending position of the current page results",
"type": "integer"
},
"total": {
"description": "Number of records that are matched by the current query",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
406
not acceptable
500
internal server error