This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /locations
Get list of locations
Description
Returns list of locations
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| keyword[eq] | optional | Search for a location using a keyword. Allowed expression(s): eq, ct | |
| country[eq] | optional | Search for a location by country code. Allowed expression(s): eq | |
| hide_blocked[eq] | optional | Hide locations marked as blocked. Allowed expression(s): eq | 1, 0 |
| tags[eq] | optional | Search for partner locations with a specific tag. Allowed expression(s): eq, in | |
| include | optional | The resources that can be included in this request, delimited by a comma: partner,tags |
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
{
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"name",
"country"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"address": {
"description": "First address line of the location",
"type": "string",
"format": "string",
"example": "Abbey Road"
},
"address_line_2": {
"description": "Additional address line",
"type": "string",
"format": "string",
"example": ""
},
"blocked": {
"description": "If this partner location is blocked - when blocked the partner location can no longer be used on new orders",
"type": "boolean",
"format": "boolean",
"default": false,
"example": true
},
"is_person": {
"description": "If this location represents a person.",
"type": "boolean",
"format": "boolean",
"default": false,
"example": true
},
"is_warehouse": {
"description": "If this location is a warehouse and can be used for pickups and deliveries.",
"type": "boolean",
"format": "boolean",
"default": true,
"example": true
},
"city": {
"description": "City of the location",
"type": "string",
"format": "string",
"example": "London"
},
"contact": {
"description": "Contact information related to the location",
"type": "string",
"format": "string",
"example": "Ring doorbell and ask for Joey"
},
"email": {
"description": "A contact email of the location.",
"type": "string",
"format": "string",
"example": "do.not@email.me"
},
"phone": {
"description": "A contact phone of the location.",
"type": "string",
"format": "string",
"example": "+4500000000"
},
"cell": {
"description": "A contact cell of the location.",
"type": "string",
"format": "string",
"example": "+4500000000"
},
"coords": {
"description": "Coordiantes of the location. The location is geocoded by tracezilla",
"properties": {
"lat": {
"type": "object",
"format": "double",
"example": 10
},
"lng": {
"type": "object",
"format": "double",
"example": 10
}
},
"type": "object",
"readOnly": true
},
"country": {
"description": "ISO 3166-1 alpha-2 Country Code",
"type": "string",
"format": "string",
"example": "DK"
},
"delivery_term_incoterm": {
"description": "The default delivery incoterm to put on orders.",
"type": "string",
"format": "string",
"enum": [
"Ex Works",
"FCA",
"FAS",
"FOB",
"CFR",
"CIF",
"CPT",
"CIP",
"DAT",
"DAP",
"DDP"
],
"example": "FOB"
},
"delivery_term_text": {
"description": "A default standalone delivery term text or a text to displayed with the selected incoterm",
"type": "string",
"format": "string",
"example": "Hamburg"
},
"edi_method": {
"description": "EDI method to use when sending EDI documents to this location\n- *UBL*: UBL/NemHandel invoice\n- *EDI*: EdiFact\n- *BIZ*: PEPPOL",
"type": "string",
"format": "string",
"enum": [
"UBL",
"EDI",
"BIZ"
],
"example": "EDI"
},
"emcs_authority_id": {
"description": "EMCS authority id",
"type": "string",
"format": "string",
"example": "DK1234567"
},
"emcs_trader_id": {
"description": "EMCS trader id",
"type": "string",
"format": "string",
"example": "DK123456789"
},
"free_text_1": {
"description": "Free text value 1",
"type": "string",
"format": "string",
"example": "abc"
},
"free_text_2": {
"description": "Free text value 2",
"type": "string",
"format": "string",
"example": "def"
},
"capacity_limit_1": {
"description": "Capacity limit 1",
"type": "number",
"format": "double",
"example": 1234.123
},
"capacity_limit_2": {
"description": "Capacity limit 2",
"type": "number",
"format": "double",
"example": 1234.123
},
"gln": {
"description": "GLN number of the location",
"type": "integer",
"format": "int64",
"example": 1234567891234
},
"locked": {
"description": "If this partner location is locked. Usually because other entities reference the location. When the location is locked it cannot be deleted.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"name": {
"description": "Name of the location for internal use - will not show up on documents",
"type": "string",
"format": "string",
"example": "Main office"
},
"recipient_name": {
"description": "Name of the location if different from partner name. Will overwrite the partner name on documents",
"type": "string",
"format": "string",
"example": "Acme Inc"
},
"number": {
"description": "Number of the partner location",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"owner_partner_id": {
"description": "Id of the partner thats owns the goods on this location.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"owner_location_id": {
"description": "Id of the location thats owns the goods on this location.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"partner_id": {
"description": "Id to the parent partner",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"peppol_id": {
"description": "Peppol id of the location",
"type": "string",
"format": "string",
"example": "1234567891234"
},
"ref": {
"description": "A reference code for this location that can be used to identify the location accross applications.",
"type": "string",
"format": "string",
"example": "XY22"
},
"state": {
"description": "Name of state or region of the location",
"type": "string",
"format": "string",
"example": "New York"
},
"state_code": {
"description": "Code of state or region of the location",
"type": "string",
"format": "string",
"example": "NY"
},
"zip": {
"description": "Zip code of the location",
"type": "string",
"format": "string",
"example": "7120"
},
"www": {
"description": "Www address",
"type": "string",
"format": "string",
"example": "https://www.tracezilla.com"
},
"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"
}
},
"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"
}
403
Unauthorized request
406
Not acceptable
500
Internal server error