This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /movements
Get list of movements
Description
Returns list of movements
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| sortBy | optional | Field to sort by. | created_at, updated_at, stock_movement_date |
| sortDirection | optional | Direction of sort. | asc, desc |
| perPage | optional | How many records to include. Max 1000 | |
| created_at[eq] | optional | Search for movements based on when it was created. Allowed expression(s): eq, gt, gte, lt, lte | |
| updated_at[eq] | optional | Search for movements based on when it was updated. Allowed expression(s): eq, gt, gte, lt, lte | |
| stock_movement_date[eq] | optional | Search for movements based on when it affects stock levels. Allowed expression(s): eq, gt, gte, lt, lte | |
| lot[eq] | optional | Search for movements based on lot. Allowed expression(s): eq, in | |
| sku[eq] | optional | Search for movement based on SKU. Allowed expression(s): eq, in | |
| partner_location[eq] | optional | Search for movement based on Partner Location. Allowed expression(s): eq, in | |
| order[eq] | optional | Search for movement based on Order. Allowed expression(s): eq, in | |
| quantity[eq] | optional | Search for movement based on quantity that is being moved. Allowed expression(s): ne, eq, lte, gte, gt, lt | |
| section[eq] | optional | Search for movements based on section. Allowed expression(s): eq | inbound, outbound |
| traceable[eq] | optional | Search for movements based on if they are moveable or not. Allowed expression(s): eq | |
| include | optional | The resources that can be included in this request, delimited by a comma: sku, lot, order, partner_location |
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
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"free_units": {
"description": "How much quantity is free",
"type": "integer",
"format": "int32",
"example": 1234
},
"line_text": {
"description": "Any line text on the movement",
"type": "string",
"format": "string",
"example": "A string"
},
"locked": {
"description": "If this movement is locked and cannot be deleted",
"type": "boolean",
"format": "boolean",
"example": true
},
"lot_id": {
"description": "Id of the Lot this movement belongs to",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_id": {
"description": "Id of the order that this movement belongs to",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"partner_location_id": {
"description": "Reference to the partner location model",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"price_per": {
"description": "No description is available",
"type": "string",
"format": "string",
"enum": [
"lot_unit",
"stock_unit",
"custom_unit",
"parcel_unit"
],
"example": "lot_unit"
},
"quantity": {
"description": "The quantity that is being moved",
"type": "integer",
"format": "int32",
"example": 1234
},
"quantity_delivered": {
"description": "The quantity that has reached the delivered state",
"type": "integer",
"format": "int32",
"example": 1234
},
"quantity_dispatched": {
"description": "The quantity that has reached the dispatched state",
"type": "integer",
"format": "int32",
"example": 1234
},
"quantity_expected": {
"description": "How much was expected. Only relevant for inbound lines. For outbound lines this is represented \non a per sku level.",
"type": "integer",
"format": "int32",
"example": 1234
},
"quantity_invoiced": {
"description": "How much have been invoiced of this movement",
"type": "integer",
"format": "int32",
"example": 1234
},
"quantity_parcels": {
"description": "The parcel quantity of this movement",
"type": "integer",
"format": "int32",
"example": 1234
},
"quantity_floor": {
"description": "How much has reached the floor state or above. \nFor outbound movements this equals the picked quantity and for inbound lines this represents items on arrival space",
"type": "integer",
"format": "int32",
"example": 1234
},
"section": {
"description": "The section of the order where this movement belong",
"type": "string",
"format": "string",
"enum": [
"inbound",
"outbound"
],
"example": "inbound"
},
"inbound_ref": {
"description": "Reference code for an inbound order line or reference code \nlinking an outbound order line to an inbound order",
"type": "string",
"format": "string",
"example": "XYZ123"
},
"sku_id": {
"description": "The id of the SKU this movement belongs to",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"stock_movement_date": {
"description": "The date this stock movement has affect",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"traceable": {
"description": "If this line is traceable or not",
"type": "boolean",
"format": "boolean",
"example": true
},
"unit": {
"description": "The unit of the quantity on the order line",
"type": "string",
"format": "string",
"example": "A string"
},
"unit_price": {
"description": "The unit price",
"type": "number",
"format": "double",
"example": 1234.123
},
"uom_conversion": {
"description": "The conversion between the unit of this order line and the unit of measure of the SKU",
"type": "number",
"format": "double",
"example": 1234.123
},
"uoms_per_price_unit": {
"description": "Number of UoMs per one price unit",
"type": "number",
"format": "double",
"example": 1234.123
},
"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 inboundupdated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"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