This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /deliveries
Get list of deliveries
Description
Returns list of deliveries
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| sortBy | optional | Field to sort by. | number, status, pickup_date, delivery_date, pallets, picking_date |
| sortDirection | optional | Direction of sort. | asc, desc |
| number[eq] | optional | Search for deliveries by number. Allowed expression(s): eq, in, ne, lte, gte, lt, gt | |
| lot[eq] | optional | Search for deliveries that contains a specified lot. Allowed expression(s): eq, in, ne | |
| order[eq] | optional | Search for deliveries on a specfic order. Allowed expression(s): eq, in, ne | |
| order_section[eq] | optional | Search for deliveries that are either outbound or inbound. Allowed expression(s): eq | |
| picking_date[eq] | optional | Search for deliveries by picking date. Allowed expression(s): eq, lt, lte, gt, gte | |
| pickup_date[eq] | optional | Search for by planned pickup date. Allowed expression(s): eq, lt, lte, gt, gte | |
| delivery_date[eq] | optional | Search for deliveries by planned delivery date. Allowed expression(s): eq, lt, lte, gt, gte | |
| forwarder_partner[eq] | optional | Search for deliveries by forwarder partner. Allowed expression(s): eq, in, ne | |
| forwarder_location[eq] | optional | Search for deliveries by forwarder location. Allowed expression(s): eq, in, ne | |
| pickup_partner[eq] | optional | Search for deliveries by pickup partner. Allowed expression(s): eq, in, ne | |
| pickup_location[eq] | optional | Search for deliveries by pickup location. Allowed expression(s): eq, in, ne | |
| warehouse_partner[eq] | optional | Search for deliveries by warehouse partner. Allowed expression(s): eq, in, ne | |
| warehouse_location[eq] | optional | Search for deliveries by warehouse location. Allowed expression(s): eq, in, ne | |
| delivery_partner[eq] | optional | Search for deliveries by delivery partner. Allowed expression(s): eq, in, ne | |
| delivery_location[eq] | optional | Search for deliveries by delivery location. Allowed expression(s): eq, in, ne | |
| order_type[eq] | optional | Search for deliveries by order type. Allowed expression(s): eq, in | |
| status[eq] | optional | Search for deliveries by status. Allowed expression(s): eq, in | |
| keyword[ct] | optional | Search for deliveries by keyword. Allowed expression(s): ct | |
| trace[eq] | optional | Search for deliveries by trace. Allowed expression(s): eq, in, ct | |
| trace_delivery[eq] | optional | Search for deliveries by trace on delivery. Allowed expression(s): eq, in, ct | |
| include | optional | The resources that can be included in this request, delimited by a comma: forwarder_partner, forwarder_location, pickup_partner, pickup_location, delivery_partner, delivery_location, weight_gross, remarks, lots, traces, tags, lines_extract |
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
{
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"order_id",
"delivery_partner_id",
"delivery_location_id"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"created_by_id": {
"description": "Id of the user that created the delivery",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"delivery_contact_id": {
"description": "Contact on the delivery",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"delivery_date": {
"description": "Delivery date of the delivery",
"type": "string",
"format": "date",
"readOnly": true,
"example": "2019-01-01"
},
"delivery_location_id": {
"description": "Location id of the location where the delivery should be delivered to",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"ext_ref": {
"description": "Reference to put on documents",
"type": "string",
"format": "string",
"example": "A string"
},
"forwarder_contact_id": {
"description": "No description is available",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"forwarder_id": {
"description": "Partner id of forwarder",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"forwarder_location_id": {
"description": "Location id of forwarder",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"number": {
"description": "Delivery number",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"order_id": {
"description": "Order id of delivery",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_section": {
"description": "The section of the order",
"type": "string",
"format": "string",
"enum": [
"inbound",
"outbound"
],
"readOnly": true,
"example": "A string"
},
"pallets": {
"description": "Number of pallets for this delivery",
"type": "number",
"format": "double",
"example": 1234.123
},
"picking_date": {
"description": "The date the delivery was picked",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"pickup_contact_id": {
"description": "Contact id of contact at pickup location",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"pickup_date": {
"description": "Date of pickup at pickup location",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"pickup_location_id": {
"description": "Location id of pickup location",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"status": {
"description": "Status of delivery",
"type": "string",
"format": "string",
"enum": [
"pending",
"picked",
"dispatched",
"delivered"
],
"example": "pending"
},
"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"
}
},
"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