This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /orders/{orderType}/{orderId}/outbound/skus/{skuId}
Get sku summary
Description
Returns summary of lot lines on order for a specific SKU
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| orderType | required | Type of order: production, warehouse, sales. | production, warehouse, sales |
| orderId | required | Target order. | |
| skuId | required | Target order sku. |
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
{
"properties": {
"properties": {
"traceable": {
"properties": {
"free_units": {
"description": "Free units in lot units",
"type": "integer",
"format": "int32",
"example": 1
},
"free_units_uom": {
"description": "Free units in UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"price_per_uom": {
"description": "Average price per UoM",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity": {
"description": "Total quantity of lot units",
"type": "integer",
"format": "int32",
"example": 12
},
"quantity_delivered": {
"description": "Total quantity delivered of lot units",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 11
},
"quantity_delivered_uom": {
"description": "Total quantity delivered of UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_dispatched": {
"description": "Total quantity dispatched",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 11
},
"quantity_dispatched_uom": {
"description": "Total quantity dispatched of UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_invoiced": {
"description": "Total quantity invoiced",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 12
},
"quantity_invoiced_uom": {
"description": "Total quantity invoiced of UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_lot_selected_uom": {
"description": "Total quantity of UoMs where a lot have been selected",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_parcels": {
"description": "Total quantity of parcels",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1
},
"quantity_picked": {
"description": "Total quantity picked of lot units",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 11
},
"quantity_picked_uom": {
"description": "Total quantity picked of UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_uom": {
"description": "Total quantity of UoMs. Can be used instead the *quantity* attribute. \nHowever it is best to use the *quantity*-attribute when inserting/updating data.",
"type": "number",
"format": "double",
"example": 1234.123
},
"sku_id": {
"description": "Id of the related SKU",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"total_price": {
"description": "Total price",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"traceable": {
"description": "If the summary is for traceable lot lines",
"type": "boolean",
"format": "boolean",
"example": true
},
"uom_conversion": {
"description": "Average UoM conversion",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"line_number": {
"description": "Line number on documents",
"type": "number",
"format": "number",
"readOnly": true,
"example": 1
},
"created_at": {
"description": "The time when the first lot line 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 lot line that was most recently updated was updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"readOnly": true,
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
},
"none_traceable": {
"properties": {
"free_units": {
"description": "Free units in lot units",
"type": "integer",
"format": "int32",
"example": 1
},
"free_units_uom": {
"description": "Free units in UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"price_per_uom": {
"description": "Average price per UoM",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity": {
"description": "Total quantity of lot units",
"type": "integer",
"format": "int32",
"example": 12
},
"quantity_delivered": {
"description": "Total quantity delivered of lot units",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 11
},
"quantity_delivered_uom": {
"description": "Total quantity delivered of UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_dispatched": {
"description": "Total quantity dispatched",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 11
},
"quantity_dispatched_uom": {
"description": "Total quantity dispatched of UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_invoiced": {
"description": "Total quantity invoiced",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 12
},
"quantity_invoiced_uom": {
"description": "Total quantity invoiced of UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_lot_selected_uom": {
"description": "Total quantity of UoMs where a lot have been selected",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_parcels": {
"description": "Total quantity of parcels",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1
},
"quantity_picked": {
"description": "Total quantity picked of lot units",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 11
},
"quantity_picked_uom": {
"description": "Total quantity picked of UoMs",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"quantity_uom": {
"description": "Total quantity of UoMs. Can be used instead the *quantity* attribute. \nHowever it is best to use the *quantity*-attribute when inserting/updating data.",
"type": "number",
"format": "double",
"example": 1234.123
},
"sku_id": {
"description": "Id of the related SKU",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"total_price": {
"description": "Total price",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"traceable": {
"description": "If the summary is for traceable lot lines",
"type": "boolean",
"format": "boolean",
"example": true
},
"uom_conversion": {
"description": "Average UoM conversion",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"line_number": {
"description": "Line number on documents",
"type": "number",
"format": "number",
"readOnly": true,
"example": 1
},
"created_at": {
"description": "The time when the first lot line 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 lot line that was most recently updated was updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"readOnly": true,
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "object"
}
406
not acceptable
500
internal server error
PUT /orders/{orderType}/{orderId}/outbound/skus/{skuId}
Update
Description
Update existing order lot
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| orderType | required | Type of order: production, warehouse, sales. | production, warehouse, sales |
| orderId | required | Target order. | |
| skuId | required | Target sku. |
Request body
Description
Target sku line.
Optional
This parameter is optional.
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
{
"required": [
"quantity"
],
"properties": {
"quantity": {
"format": "int32",
"example": 10
},
"line_text": {
"format": "string",
"example": "Needs extra care"
},
"traceable": {
"format": "boolean",
"example": true
},
"unit_price": {
"format": "double",
"example": 20.22
},
"price_per": {
"description": "*stock_unit*: price per UoM, *lot_unit*: price per *lot_unit* ",
"format": "string",
"enum": [
"stock_unit",
"lot_unit"
],
"example": "stock_unit"
},
"lot_selection": {
"description": "*none*: do not try to select lots for the SKU and do not change existing selections, *any*: try to select lots for quanties that are still missing lot selection",
"format": "string",
"enum": [
"none",
"any",
"not_traced"
],
"example": "any"
}
},
"type": "object"
}
Responses
201
Successful operation
403
Unauthorized request
406
not acceptable
500
Internal server error
DELETE /orders/{orderType}/{orderId}/outbound/skus/{skuId}
Delete all lot lines on the order with the specified SKU
Description
Remove the specified resource from storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| orderId | required | Target order. | |
| skuId | required | Target order sku. |
Responses
204
Delete was succesfull
403
Unauthorized request
406
not acceptable
500
Internal server error