jumingo 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.rspec +3 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE.txt +21 -0
- data/README.md +110 -0
- data/Rakefile +8 -0
- data/lib/jumingo/client.rb +174 -0
- data/lib/jumingo/configuration.rb +21 -0
- data/lib/jumingo/errors.rb +25 -0
- data/lib/jumingo/models.rb +40 -0
- data/lib/jumingo/version.rb +5 -0
- data/lib/jumingo.rb +17 -0
- data/openapi/jumingo.yaml +4778 -0
- data/sig/jumingo.rbs +16 -0
- metadata +116 -0
|
@@ -0,0 +1,4778 @@
|
|
|
1
|
+
swagger: '2.0'
|
|
2
|
+
info:
|
|
3
|
+
description: |-
|
|
4
|
+
## About
|
|
5
|
+
|
|
6
|
+
With the JUMINGO shipping API you can import your shipments into your JUMINGO account from any source.
|
|
7
|
+
The functionalities of the API include creating and updating shipment drafts, fetching suitable shipment rates for a given shipment and purchasing shipping labels.
|
|
8
|
+
Furthermore, you can retrieve tracking data and fetch shipping labels and documents for all your purchased shipments.
|
|
9
|
+
|
|
10
|
+
The current main purpose of the API is to connect your account to e-commerce systems and marketplaces.
|
|
11
|
+
|
|
12
|
+
## General
|
|
13
|
+
The API is organized around REST. Our API has resource-oriented URLs and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs.
|
|
14
|
+
All API requests must be made over HTTPS. Calls made over plain HTTP will return errors.
|
|
15
|
+
Request data is passed to the API as JSON objects and JSON is also returned by all API responses, including errors, although our API SDKs convert requests and responses to appropriate language-specific objects.
|
|
16
|
+
|
|
17
|
+
Best practice usage of the API and business logic is described in the supplementary [integration guide](https://www.jumingo.com/cms/JUMiNGO_API-integration-guide.pdf "JUMiNGO API Integration Guide").
|
|
18
|
+
|
|
19
|
+
## Base URL
|
|
20
|
+
The base URL for all calls is: `https://api.jumingo.com/v1`
|
|
21
|
+
|
|
22
|
+
## HTTP status codes
|
|
23
|
+
HTTP response codes in the `2xx` range indicate success. Codes in the `4xx` range indicate an error on the client side (e.g. a required parameter is missing). Codes in the `5xx` range indicate an error with our servers. Each error should provide an error code and an error message with further information.
|
|
24
|
+
|
|
25
|
+
HTTP status code | Description
|
|
26
|
+
---------------- | -----------
|
|
27
|
+
200, 201, 204 - OK | Everything worked.
|
|
28
|
+
400 - Bad Request | The request was unacceptable, often due to missing a required parameter or a validation error.
|
|
29
|
+
401 - Unauthorized | No valid API key has been provided or your account is disabled.
|
|
30
|
+
403 - Forbidden | You are not allowed to talk to this endpoint. This can either be due to a wrong authentication or when you’re trying to reach an endpoint that your account isn’t allowed to access.
|
|
31
|
+
404 - Not Found | The requested resource doesn’t exist.
|
|
32
|
+
500, 502, 503, 504 - Server Errors | Something went wrong on our side. Please contact our support if you receive this error.
|
|
33
|
+
|
|
34
|
+
## Authentication
|
|
35
|
+
All API requests requires authentication. Unauthorized calls will return errors.
|
|
36
|
+
|
|
37
|
+
Authenticate by including your API key in the `X-AUTH-TOKEN` HTTP header of each API call, e.g.:
|
|
38
|
+
|
|
39
|
+
`X-AUTH-TOKEN: INSERT_YOUR_API_KEY`
|
|
40
|
+
|
|
41
|
+
You can find your API key in your JUMINGO user account. You can get access to the JUMiNGO customer API by enabling it in your [user account](https://www.jumingo.com/de-de/users/connections/create/8). After activation, you will get your personal API key.
|
|
42
|
+
|
|
43
|
+
## Date/Time Format
|
|
44
|
+
All values of type `string <date-time>` are defined in a specific [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6) format and must also be formatted accordingly for requests.
|
|
45
|
+
|
|
46
|
+
The format is: YYYY-MM-DD hh:mm:ss
|
|
47
|
+
|
|
48
|
+
Example: 2018-07-26 15:54:13
|
|
49
|
+
|
|
50
|
+
All dates and times are specified in UTC (Coordinated Universal Time).
|
|
51
|
+
version: 1.0.4
|
|
52
|
+
title: JUMINGO API Reference
|
|
53
|
+
contact:
|
|
54
|
+
name: JUMiNGO GmbH
|
|
55
|
+
email: connections@jumingo.com
|
|
56
|
+
host: api.jumingo.com
|
|
57
|
+
basePath: /
|
|
58
|
+
schemes:
|
|
59
|
+
- https
|
|
60
|
+
consumes:
|
|
61
|
+
- application/json
|
|
62
|
+
produces:
|
|
63
|
+
- application/json
|
|
64
|
+
securityDefinitions:
|
|
65
|
+
v1:
|
|
66
|
+
name: X-AUTH-TOKEN
|
|
67
|
+
type: apiKey
|
|
68
|
+
in: header
|
|
69
|
+
description: 'Value: {X-AUTH-TOKEN}'
|
|
70
|
+
security:
|
|
71
|
+
- v1: []
|
|
72
|
+
paths:
|
|
73
|
+
/v1/carrier/access-points-search:
|
|
74
|
+
post:
|
|
75
|
+
summary: Get carrier aaccess points by an address with some radius in kilometers
|
|
76
|
+
consumes:
|
|
77
|
+
- application/json
|
|
78
|
+
produces:
|
|
79
|
+
- application/json
|
|
80
|
+
parameters:
|
|
81
|
+
- name: accessPointSearch
|
|
82
|
+
in: body
|
|
83
|
+
required: true
|
|
84
|
+
schema:
|
|
85
|
+
properties:
|
|
86
|
+
carrierCodes:
|
|
87
|
+
type: array
|
|
88
|
+
items:
|
|
89
|
+
type: string
|
|
90
|
+
example: ups
|
|
91
|
+
description: The carrier codes
|
|
92
|
+
countryCode:
|
|
93
|
+
example: DE
|
|
94
|
+
type: string
|
|
95
|
+
description: The country as ISO 3166-1 alpha-2 code
|
|
96
|
+
city:
|
|
97
|
+
example: Neuss
|
|
98
|
+
type: string
|
|
99
|
+
description: The city name
|
|
100
|
+
postCode:
|
|
101
|
+
example: '41460'
|
|
102
|
+
type: string
|
|
103
|
+
description: The postcode
|
|
104
|
+
street:
|
|
105
|
+
example: Markt 2
|
|
106
|
+
type: string
|
|
107
|
+
description: The street name and building number
|
|
108
|
+
state:
|
|
109
|
+
example: ''
|
|
110
|
+
type: string
|
|
111
|
+
description: Abbreviation of the state; the state required only for US and Canada
|
|
112
|
+
radius:
|
|
113
|
+
example: 10
|
|
114
|
+
type: integer
|
|
115
|
+
description: The radius in kilometers around the specified address
|
|
116
|
+
onlyOpen:
|
|
117
|
+
example: false
|
|
118
|
+
type: boolean
|
|
119
|
+
description: Show only open access points
|
|
120
|
+
required:
|
|
121
|
+
- radius
|
|
122
|
+
- countryCode
|
|
123
|
+
- carrierCodes
|
|
124
|
+
- onlyOpen
|
|
125
|
+
type: object
|
|
126
|
+
responses:
|
|
127
|
+
'200':
|
|
128
|
+
description: The Carrier aaccess points collection response
|
|
129
|
+
schema:
|
|
130
|
+
items:
|
|
131
|
+
$ref: '#/definitions/AccessPointsResponse'
|
|
132
|
+
type: array
|
|
133
|
+
tags:
|
|
134
|
+
- Carrier
|
|
135
|
+
/v1/cart/total:
|
|
136
|
+
post:
|
|
137
|
+
summary: Get cart total
|
|
138
|
+
description: Get cart total costs with a description of the calculations
|
|
139
|
+
operationId: postCartTotal
|
|
140
|
+
consumes:
|
|
141
|
+
- application/json
|
|
142
|
+
produces:
|
|
143
|
+
- application/json
|
|
144
|
+
parameters:
|
|
145
|
+
- name: cart
|
|
146
|
+
in: body
|
|
147
|
+
required: true
|
|
148
|
+
description: The List of shipment id and voucher code
|
|
149
|
+
schema:
|
|
150
|
+
$ref: '#/definitions/CartTotalInput'
|
|
151
|
+
responses:
|
|
152
|
+
'201':
|
|
153
|
+
description: Total shipments cost with description of the calculation.
|
|
154
|
+
schema:
|
|
155
|
+
$ref: '#/definitions/CartTotalOutput'
|
|
156
|
+
'400':
|
|
157
|
+
description: Bad Request
|
|
158
|
+
schema:
|
|
159
|
+
$ref: '#/definitions/ErrorResponse'
|
|
160
|
+
'404':
|
|
161
|
+
description: You cart is empty!
|
|
162
|
+
tags:
|
|
163
|
+
- Cart
|
|
164
|
+
/v1/connections:
|
|
165
|
+
get:
|
|
166
|
+
summary: Retrieves the collection of Connection resources.
|
|
167
|
+
produces:
|
|
168
|
+
- application/json
|
|
169
|
+
parameters:
|
|
170
|
+
- name: status
|
|
171
|
+
in: query
|
|
172
|
+
required: false
|
|
173
|
+
description: Status of connections
|
|
174
|
+
type: string
|
|
175
|
+
enum:
|
|
176
|
+
- new
|
|
177
|
+
- in_progress
|
|
178
|
+
- error
|
|
179
|
+
- success
|
|
180
|
+
- name: connectionType
|
|
181
|
+
in: query
|
|
182
|
+
required: false
|
|
183
|
+
description: Connection type ID
|
|
184
|
+
type: number
|
|
185
|
+
- name: sort[status]
|
|
186
|
+
in: query
|
|
187
|
+
required: false
|
|
188
|
+
type: string
|
|
189
|
+
description: Sort by status
|
|
190
|
+
enum:
|
|
191
|
+
- asc
|
|
192
|
+
- desc
|
|
193
|
+
- name: sort[connectionType]
|
|
194
|
+
in: query
|
|
195
|
+
required: false
|
|
196
|
+
type: string
|
|
197
|
+
description: Sort by connectionType
|
|
198
|
+
enum:
|
|
199
|
+
- asc
|
|
200
|
+
- desc
|
|
201
|
+
- name: sort[modified]
|
|
202
|
+
in: query
|
|
203
|
+
required: false
|
|
204
|
+
type: string
|
|
205
|
+
description: Sort by modified
|
|
206
|
+
enum:
|
|
207
|
+
- asc
|
|
208
|
+
- desc
|
|
209
|
+
- name: page
|
|
210
|
+
in: query
|
|
211
|
+
required: false
|
|
212
|
+
description: The collection page number
|
|
213
|
+
type: integer
|
|
214
|
+
- name: itemsPerPage
|
|
215
|
+
in: query
|
|
216
|
+
required: false
|
|
217
|
+
description: The number of items per page
|
|
218
|
+
type: integer
|
|
219
|
+
responses:
|
|
220
|
+
'200':
|
|
221
|
+
description: Connection collection response
|
|
222
|
+
schema:
|
|
223
|
+
items:
|
|
224
|
+
$ref: '#/definitions/ConnectionsCollection'
|
|
225
|
+
type: array
|
|
226
|
+
tags:
|
|
227
|
+
- Connection
|
|
228
|
+
post:
|
|
229
|
+
summary: Create a Connection
|
|
230
|
+
description: |-
|
|
231
|
+
Creates a new connection.
|
|
232
|
+
|
|
233
|
+
**This API call is for e-commerce / shop plugin developers only.**
|
|
234
|
+
|
|
235
|
+
As a registered plugin developer, you have received additional, separate information for this call.
|
|
236
|
+
If you would like to create a new shop plugin, please contact our customer support for more information.
|
|
237
|
+
operationId: CreateConnection
|
|
238
|
+
consumes: []
|
|
239
|
+
produces:
|
|
240
|
+
- application/json
|
|
241
|
+
parameters:
|
|
242
|
+
- name: body
|
|
243
|
+
in: body
|
|
244
|
+
required: true
|
|
245
|
+
schema:
|
|
246
|
+
$ref: '#/definitions/CreateConnection'
|
|
247
|
+
responses:
|
|
248
|
+
'201':
|
|
249
|
+
description: The connection resource created
|
|
250
|
+
schema:
|
|
251
|
+
$ref: '#/definitions/CreateConnectionResult'
|
|
252
|
+
'400':
|
|
253
|
+
description: Bad Request
|
|
254
|
+
schema:
|
|
255
|
+
$ref: '#/definitions/ErrorResponse'
|
|
256
|
+
tags:
|
|
257
|
+
- Connection
|
|
258
|
+
/v1/connections/{uuid}:
|
|
259
|
+
get:
|
|
260
|
+
summary: Get the Connection
|
|
261
|
+
produces:
|
|
262
|
+
- application/json
|
|
263
|
+
parameters:
|
|
264
|
+
- name: uuid
|
|
265
|
+
in: path
|
|
266
|
+
description: 'Connection uuid. For example: s_d6694ae6eb37465a81c35ebaa0045b8c'
|
|
267
|
+
required: true
|
|
268
|
+
type: string
|
|
269
|
+
maxLength: 34
|
|
270
|
+
responses:
|
|
271
|
+
'200':
|
|
272
|
+
description: The connection resource updated
|
|
273
|
+
schema:
|
|
274
|
+
$ref: '#/definitions/Connection'
|
|
275
|
+
'404':
|
|
276
|
+
description: the Connection not found
|
|
277
|
+
schema:
|
|
278
|
+
$ref: '#/definitions/Exception'
|
|
279
|
+
tags:
|
|
280
|
+
- Connection
|
|
281
|
+
/v1/orders:
|
|
282
|
+
get:
|
|
283
|
+
summary: Retrieves the collection of Order resources.
|
|
284
|
+
operationId: get_appOrderCollection
|
|
285
|
+
produces:
|
|
286
|
+
- application/json
|
|
287
|
+
parameters:
|
|
288
|
+
- name: export
|
|
289
|
+
in: query
|
|
290
|
+
required: false
|
|
291
|
+
type: integer
|
|
292
|
+
description: 'Use this parameter with value 1 to export data. For example: 1'
|
|
293
|
+
- name: paymentMethod[]
|
|
294
|
+
in: query
|
|
295
|
+
required: false
|
|
296
|
+
type: array
|
|
297
|
+
items:
|
|
298
|
+
type: string
|
|
299
|
+
description: 'Filter by array of exact payment method names. For example: ["paypal", "sofort"]'
|
|
300
|
+
collectionFormat: multi
|
|
301
|
+
- name: paymentStatus
|
|
302
|
+
in: query
|
|
303
|
+
required: false
|
|
304
|
+
type: string
|
|
305
|
+
description: Filter by Payment status number. Use prefix 1 for unpaid and 0 for paid"
|
|
306
|
+
- name: created[before]
|
|
307
|
+
in: query
|
|
308
|
+
required: false
|
|
309
|
+
type: string
|
|
310
|
+
description: 'Filter by created before the date and/or time. For example: "2020-09-19T00:00:00.000"'
|
|
311
|
+
- name: created[after]
|
|
312
|
+
in: query
|
|
313
|
+
required: false
|
|
314
|
+
type: string
|
|
315
|
+
description: 'Filter by created after the date and/or time. For example: "2020-09-19T00:00:00.000"'
|
|
316
|
+
- name: sort[created]
|
|
317
|
+
in: query
|
|
318
|
+
required: false
|
|
319
|
+
type: string
|
|
320
|
+
description: 'Sort by created. For example: "asc"'
|
|
321
|
+
- name: sort[gross]
|
|
322
|
+
in: query
|
|
323
|
+
required: false
|
|
324
|
+
type: string
|
|
325
|
+
description: 'Sort by gross. For example: "desc"'
|
|
326
|
+
- name: sort[orderNumber]
|
|
327
|
+
in: query
|
|
328
|
+
required: false
|
|
329
|
+
type: string
|
|
330
|
+
description: 'Sort by orderNumber. For example: "asc"'
|
|
331
|
+
- name: sort[unpaid]
|
|
332
|
+
in: query
|
|
333
|
+
required: false
|
|
334
|
+
type: string
|
|
335
|
+
description: 'Sort by unpaid. For example: "desc"'
|
|
336
|
+
- name: search
|
|
337
|
+
in: query
|
|
338
|
+
required: false
|
|
339
|
+
type: string
|
|
340
|
+
description: 'Full text search by data: - Shipping number - Tracking number - Pickup code - Sender address (return address) - Recipient address - Billing address - E-mail address (email_label_copy OR email_tracking)'
|
|
341
|
+
- name: page
|
|
342
|
+
in: query
|
|
343
|
+
required: false
|
|
344
|
+
description: The collection page number
|
|
345
|
+
type: integer
|
|
346
|
+
- name: itemsPerPage
|
|
347
|
+
in: query
|
|
348
|
+
required: false
|
|
349
|
+
description: The number of items per page, 10 by default
|
|
350
|
+
type: integer
|
|
351
|
+
responses:
|
|
352
|
+
'200':
|
|
353
|
+
description: Order collection response
|
|
354
|
+
schema:
|
|
355
|
+
items:
|
|
356
|
+
$ref: '#/definitions/OrdersOutput'
|
|
357
|
+
type: array
|
|
358
|
+
'404':
|
|
359
|
+
description: Resource not found
|
|
360
|
+
tags:
|
|
361
|
+
- Order
|
|
362
|
+
post:
|
|
363
|
+
summary: Make a payment.
|
|
364
|
+
operationId: postOrders
|
|
365
|
+
consumes:
|
|
366
|
+
- application/json
|
|
367
|
+
produces:
|
|
368
|
+
- application/json
|
|
369
|
+
parameters:
|
|
370
|
+
- name: order
|
|
371
|
+
in: body
|
|
372
|
+
schema:
|
|
373
|
+
$ref: '#/definitions/OrdersPostInput'
|
|
374
|
+
responses:
|
|
375
|
+
'200':
|
|
376
|
+
description: Payment resource created
|
|
377
|
+
schema:
|
|
378
|
+
$ref: '#/definitions/OrdersPostOutput'
|
|
379
|
+
'400':
|
|
380
|
+
description: Invalid input
|
|
381
|
+
schema:
|
|
382
|
+
$ref: '#/definitions/ErrorResponse'
|
|
383
|
+
'404':
|
|
384
|
+
description: Resource not found
|
|
385
|
+
schema:
|
|
386
|
+
$ref: '#/definitions/Exception'
|
|
387
|
+
tags:
|
|
388
|
+
- Order
|
|
389
|
+
/v1/orders/{id}:
|
|
390
|
+
get:
|
|
391
|
+
summary: Retrieves a Order resource.
|
|
392
|
+
produces:
|
|
393
|
+
- application/json
|
|
394
|
+
parameters:
|
|
395
|
+
- name: id
|
|
396
|
+
in: path
|
|
397
|
+
required: true
|
|
398
|
+
type: string
|
|
399
|
+
responses:
|
|
400
|
+
'200':
|
|
401
|
+
description: Order resource response
|
|
402
|
+
schema:
|
|
403
|
+
$ref: '#/definitions/OrderOutput'
|
|
404
|
+
'404':
|
|
405
|
+
description: Resource not found
|
|
406
|
+
tags:
|
|
407
|
+
- Order
|
|
408
|
+
/v1/orders/{id}/documents:
|
|
409
|
+
get:
|
|
410
|
+
summary: Retrieves a OrderDocuments resource.
|
|
411
|
+
produces:
|
|
412
|
+
- application/json
|
|
413
|
+
parameters:
|
|
414
|
+
- name: id
|
|
415
|
+
in: path
|
|
416
|
+
required: true
|
|
417
|
+
type: string
|
|
418
|
+
description: Order number
|
|
419
|
+
responses:
|
|
420
|
+
'200':
|
|
421
|
+
description: OrderDocuments resource response
|
|
422
|
+
schema:
|
|
423
|
+
$ref: '#/definitions/OrderDocuments'
|
|
424
|
+
'404':
|
|
425
|
+
description: Resource not found
|
|
426
|
+
tags:
|
|
427
|
+
- Order
|
|
428
|
+
/v1/shipments:
|
|
429
|
+
get:
|
|
430
|
+
tags:
|
|
431
|
+
- Shipment
|
|
432
|
+
summary: Get Shipments
|
|
433
|
+
description: Gets a list of all shipments. You can filter and sort the shipments. The pagination is done by limit and offset parameters.
|
|
434
|
+
operationId: GetShipments
|
|
435
|
+
produces:
|
|
436
|
+
- application/json
|
|
437
|
+
parameters:
|
|
438
|
+
- name: status
|
|
439
|
+
in: query
|
|
440
|
+
required: false
|
|
441
|
+
description: Status of shipments
|
|
442
|
+
type: string
|
|
443
|
+
default: all
|
|
444
|
+
enum:
|
|
445
|
+
- all
|
|
446
|
+
- missing_data
|
|
447
|
+
- ready
|
|
448
|
+
- completed
|
|
449
|
+
- in_transit
|
|
450
|
+
- in_delivery
|
|
451
|
+
- delivered
|
|
452
|
+
- in_progress
|
|
453
|
+
- exception
|
|
454
|
+
- undelivered
|
|
455
|
+
- archived
|
|
456
|
+
- drafts
|
|
457
|
+
- ordered
|
|
458
|
+
- isThirdParty
|
|
459
|
+
- checkout
|
|
460
|
+
- get_rates
|
|
461
|
+
- save_changes
|
|
462
|
+
- delete
|
|
463
|
+
- buy
|
|
464
|
+
- buy_in_progress
|
|
465
|
+
- name: importProgressStatus
|
|
466
|
+
in: query
|
|
467
|
+
required: false
|
|
468
|
+
description: Import Progress Status of shipments
|
|
469
|
+
type: string
|
|
470
|
+
enum:
|
|
471
|
+
- checkout
|
|
472
|
+
- get_rates
|
|
473
|
+
- save_changes
|
|
474
|
+
- delete
|
|
475
|
+
- buy
|
|
476
|
+
- buy_in_progress
|
|
477
|
+
- name: created[before]
|
|
478
|
+
in: query
|
|
479
|
+
required: false
|
|
480
|
+
type: string
|
|
481
|
+
description: 'Filter by created before the date and/or time. For example: "2020-09-19T00:00:00.000"'
|
|
482
|
+
- name: created[after]
|
|
483
|
+
in: query
|
|
484
|
+
required: false
|
|
485
|
+
type: string
|
|
486
|
+
description: 'Filter by created after the date and/or time. For example: "2020-09-19T00:00:00.000"'
|
|
487
|
+
- name: sort[created]
|
|
488
|
+
in: query
|
|
489
|
+
required: false
|
|
490
|
+
type: string
|
|
491
|
+
description: 'Sort by created. For example: "asc"'
|
|
492
|
+
- name: sort[modified]
|
|
493
|
+
in: query
|
|
494
|
+
required: false
|
|
495
|
+
type: string
|
|
496
|
+
description: 'Sort by modified. For example: "desc"'
|
|
497
|
+
- name: search
|
|
498
|
+
in: query
|
|
499
|
+
required: false
|
|
500
|
+
description: Full text search
|
|
501
|
+
type: string
|
|
502
|
+
- name: orderNumber
|
|
503
|
+
in: query
|
|
504
|
+
required: false
|
|
505
|
+
type: string
|
|
506
|
+
description: Filter shipments by orderNumber
|
|
507
|
+
- name: page
|
|
508
|
+
in: query
|
|
509
|
+
required: false
|
|
510
|
+
description: The collection page number
|
|
511
|
+
type: integer
|
|
512
|
+
- name: itemsPerPage
|
|
513
|
+
in: query
|
|
514
|
+
required: false
|
|
515
|
+
description: The number of items per page
|
|
516
|
+
type: integer
|
|
517
|
+
- name: pagination
|
|
518
|
+
in: query
|
|
519
|
+
required: false
|
|
520
|
+
description: Client enable pagination
|
|
521
|
+
type: boolean
|
|
522
|
+
responses:
|
|
523
|
+
'200':
|
|
524
|
+
description: Status 200
|
|
525
|
+
schema:
|
|
526
|
+
items:
|
|
527
|
+
$ref: '#/definitions/Shipment'
|
|
528
|
+
type: array
|
|
529
|
+
'400':
|
|
530
|
+
description: Bad Request
|
|
531
|
+
schema:
|
|
532
|
+
$ref: '#/definitions/ErrorResponse'
|
|
533
|
+
post:
|
|
534
|
+
tags:
|
|
535
|
+
- Shipment
|
|
536
|
+
summary: Create a Shipment
|
|
537
|
+
description: |
|
|
538
|
+
Creates a new shipment.
|
|
539
|
+
If you are using an e-commerce connection, you must specify the order data with "connection_custom_data".
|
|
540
|
+
operationId: CreateShipment
|
|
541
|
+
consumes:
|
|
542
|
+
- application/json
|
|
543
|
+
produces:
|
|
544
|
+
- application/json
|
|
545
|
+
parameters:
|
|
546
|
+
- name: body
|
|
547
|
+
in: body
|
|
548
|
+
required: true
|
|
549
|
+
schema:
|
|
550
|
+
$ref: '#/definitions/CreateShipment'
|
|
551
|
+
responses:
|
|
552
|
+
'200':
|
|
553
|
+
description: Status 200
|
|
554
|
+
schema:
|
|
555
|
+
$ref: '#/definitions/CreateShipmentResult'
|
|
556
|
+
'400':
|
|
557
|
+
description: Bad Request
|
|
558
|
+
schema:
|
|
559
|
+
$ref: '#/definitions/ErrorResponse'
|
|
560
|
+
/v1/shipments/{shipment_id}:
|
|
561
|
+
get:
|
|
562
|
+
tags:
|
|
563
|
+
- Shipment
|
|
564
|
+
summary: Retrieve a Shipment
|
|
565
|
+
description: Get a specific shipment based on the given shipment ID.
|
|
566
|
+
operationId: GetShipment
|
|
567
|
+
produces:
|
|
568
|
+
- application/json
|
|
569
|
+
parameters:
|
|
570
|
+
- name: shipment_id
|
|
571
|
+
in: path
|
|
572
|
+
required: true
|
|
573
|
+
type: string
|
|
574
|
+
x-example: s_fb1bc92aba1c4d70a3eaa44d687ae179
|
|
575
|
+
responses:
|
|
576
|
+
'200':
|
|
577
|
+
description: Status 200
|
|
578
|
+
schema:
|
|
579
|
+
$ref: '#/definitions/Shipment'
|
|
580
|
+
'400':
|
|
581
|
+
description: Bad Request
|
|
582
|
+
schema:
|
|
583
|
+
$ref: '#/definitions/ErrorResponse'
|
|
584
|
+
put:
|
|
585
|
+
summary: Replaces the Shipment resource.
|
|
586
|
+
consumes:
|
|
587
|
+
- application/json
|
|
588
|
+
produces:
|
|
589
|
+
- application/json
|
|
590
|
+
parameters:
|
|
591
|
+
- name: shipment_id
|
|
592
|
+
in: path
|
|
593
|
+
required: true
|
|
594
|
+
type: string
|
|
595
|
+
- name: shipment
|
|
596
|
+
in: body
|
|
597
|
+
description: The updated Shipment resource
|
|
598
|
+
schema:
|
|
599
|
+
$ref: '#/definitions/UpdateShipment'
|
|
600
|
+
responses:
|
|
601
|
+
'200':
|
|
602
|
+
description: Shipment resource updated
|
|
603
|
+
schema:
|
|
604
|
+
$ref: '#/definitions/Shipment'
|
|
605
|
+
'400':
|
|
606
|
+
description: Invalid input
|
|
607
|
+
schema:
|
|
608
|
+
$ref: '#/definitions/Exception'
|
|
609
|
+
'404':
|
|
610
|
+
description: Resource not found
|
|
611
|
+
schema:
|
|
612
|
+
$ref: '#/definitions/Exception'
|
|
613
|
+
tags:
|
|
614
|
+
- Shipment
|
|
615
|
+
patch:
|
|
616
|
+
summary: Updates the Shipment resource.
|
|
617
|
+
operationId: patch_v1ShipmentItem
|
|
618
|
+
consumes:
|
|
619
|
+
- application/merge-patch+json
|
|
620
|
+
produces:
|
|
621
|
+
- application/json
|
|
622
|
+
parameters:
|
|
623
|
+
- name: shipment_id
|
|
624
|
+
in: path
|
|
625
|
+
required: true
|
|
626
|
+
type: string
|
|
627
|
+
- name: shipment
|
|
628
|
+
in: body
|
|
629
|
+
description: The updated Shipment resource
|
|
630
|
+
schema:
|
|
631
|
+
$ref: '#/definitions/CreateShipment'
|
|
632
|
+
responses:
|
|
633
|
+
'200':
|
|
634
|
+
description: Shipment resource updated
|
|
635
|
+
schema:
|
|
636
|
+
$ref: '#/definitions/Shipment'
|
|
637
|
+
'400':
|
|
638
|
+
description: Invalid input
|
|
639
|
+
schema:
|
|
640
|
+
$ref: '#/definitions/Exception'
|
|
641
|
+
'404':
|
|
642
|
+
description: Resource not found
|
|
643
|
+
schema:
|
|
644
|
+
$ref: '#/definitions/Exception'
|
|
645
|
+
tags:
|
|
646
|
+
- Shipment
|
|
647
|
+
delete:
|
|
648
|
+
summary: Removes the Shipment resource.
|
|
649
|
+
parameters:
|
|
650
|
+
- name: shipment_id
|
|
651
|
+
in: path
|
|
652
|
+
required: true
|
|
653
|
+
type: string
|
|
654
|
+
responses:
|
|
655
|
+
'204':
|
|
656
|
+
description: Shipment resource deleted
|
|
657
|
+
'404':
|
|
658
|
+
description: Resource not found
|
|
659
|
+
schema:
|
|
660
|
+
$ref: '#/definitions/Exception'
|
|
661
|
+
tags:
|
|
662
|
+
- Shipment
|
|
663
|
+
/v1/shipments/cheapest:
|
|
664
|
+
post:
|
|
665
|
+
summary: Update shipments rate
|
|
666
|
+
description: Update shipments rate with cheapest tariff
|
|
667
|
+
operationId: updateShipmentRateCheapestTariffV1
|
|
668
|
+
consumes:
|
|
669
|
+
- application/json
|
|
670
|
+
produces:
|
|
671
|
+
- application/json
|
|
672
|
+
parameters:
|
|
673
|
+
- name: shipment
|
|
674
|
+
in: body
|
|
675
|
+
description: The new Shipment resource
|
|
676
|
+
required: true
|
|
677
|
+
schema:
|
|
678
|
+
type: object
|
|
679
|
+
properties:
|
|
680
|
+
shipmentIds:
|
|
681
|
+
type: array
|
|
682
|
+
items:
|
|
683
|
+
type: string
|
|
684
|
+
description: Shipment uuids
|
|
685
|
+
example: s_ca213cb9368c412291b8441c90c95592
|
|
686
|
+
rateInput:
|
|
687
|
+
$ref: '#/definitions/ShipmentCheapestRateInput'
|
|
688
|
+
- name: shippingType
|
|
689
|
+
in: query
|
|
690
|
+
required: false
|
|
691
|
+
description: Rate shipping type
|
|
692
|
+
type: string
|
|
693
|
+
enum:
|
|
694
|
+
- pickup
|
|
695
|
+
- shop
|
|
696
|
+
- name: tariffType
|
|
697
|
+
in: query
|
|
698
|
+
required: false
|
|
699
|
+
description: Rate tariff type
|
|
700
|
+
type: string
|
|
701
|
+
enum:
|
|
702
|
+
- Same Day
|
|
703
|
+
- Express
|
|
704
|
+
- Economy
|
|
705
|
+
- Standard
|
|
706
|
+
- name: carrier
|
|
707
|
+
in: query
|
|
708
|
+
required: false
|
|
709
|
+
description: Rate carrier
|
|
710
|
+
type: string
|
|
711
|
+
enum:
|
|
712
|
+
- UPS
|
|
713
|
+
- DHL Express
|
|
714
|
+
- TNT
|
|
715
|
+
- FedEx
|
|
716
|
+
- dpd
|
|
717
|
+
- GLS
|
|
718
|
+
- JUMiNGO Cargo
|
|
719
|
+
- JUMiNGO Direct
|
|
720
|
+
- JUMiNGO Express
|
|
721
|
+
- Der Kurier
|
|
722
|
+
- bgm
|
|
723
|
+
- name: sort
|
|
724
|
+
in: query
|
|
725
|
+
required: false
|
|
726
|
+
description: Results sorting
|
|
727
|
+
type: string
|
|
728
|
+
enum:
|
|
729
|
+
- fastest
|
|
730
|
+
- cheapest
|
|
731
|
+
responses:
|
|
732
|
+
'201':
|
|
733
|
+
description: Status 201
|
|
734
|
+
'400':
|
|
735
|
+
description: Status 400 (Bad Request)
|
|
736
|
+
schema:
|
|
737
|
+
$ref: '#/definitions/Exception'
|
|
738
|
+
tags:
|
|
739
|
+
- Shipment
|
|
740
|
+
/v1/shipments/{uuid}/file/upload/{type}:
|
|
741
|
+
post:
|
|
742
|
+
summary: Uploads a commercial invoice or an export declaration for a shipment
|
|
743
|
+
consumes:
|
|
744
|
+
- multipart/form-data
|
|
745
|
+
produces:
|
|
746
|
+
- application/json
|
|
747
|
+
parameters:
|
|
748
|
+
- name: uuid
|
|
749
|
+
in: path
|
|
750
|
+
required: true
|
|
751
|
+
type: string
|
|
752
|
+
description: The shipment uuid. E.g. s_fbf8e2a57185478194fa264583b5b388
|
|
753
|
+
- name: type
|
|
754
|
+
in: path
|
|
755
|
+
required: true
|
|
756
|
+
type: string
|
|
757
|
+
description: The document type for the shipment to be uploaded. E.g. <b>commercial-invoice</b> or <b>export-declaration</b>
|
|
758
|
+
- name: file
|
|
759
|
+
in: formData
|
|
760
|
+
required: false
|
|
761
|
+
type: file
|
|
762
|
+
responses:
|
|
763
|
+
'200':
|
|
764
|
+
description: File was uploaded
|
|
765
|
+
'400':
|
|
766
|
+
description: Bad Request
|
|
767
|
+
schema:
|
|
768
|
+
$ref: '#/definitions/Exception'
|
|
769
|
+
tags:
|
|
770
|
+
- Shipment
|
|
771
|
+
delete:
|
|
772
|
+
summary: Deletes a commercial invoice or an export declaration for a shipment
|
|
773
|
+
parameters:
|
|
774
|
+
- name: uuid
|
|
775
|
+
in: path
|
|
776
|
+
required: true
|
|
777
|
+
type: string
|
|
778
|
+
description: The shipment uuid. E.g. s_fbf8e2a57185478194fa264583b5b388
|
|
779
|
+
- name: type
|
|
780
|
+
in: path
|
|
781
|
+
required: true
|
|
782
|
+
type: string
|
|
783
|
+
description: The document type for the shipment to be deleted. E.g. <b>commercial-invoice</b> or <b>export-declaration</b>
|
|
784
|
+
responses:
|
|
785
|
+
'204':
|
|
786
|
+
description: File was deleted
|
|
787
|
+
'400':
|
|
788
|
+
description: Bad Request
|
|
789
|
+
schema:
|
|
790
|
+
$ref: '#/definitions/Exception'
|
|
791
|
+
tags:
|
|
792
|
+
- Shipment
|
|
793
|
+
/v1/shipment-rates:
|
|
794
|
+
post:
|
|
795
|
+
tags:
|
|
796
|
+
- ShipmentRate
|
|
797
|
+
consumes:
|
|
798
|
+
- application/json
|
|
799
|
+
produces:
|
|
800
|
+
- application/json
|
|
801
|
+
summary: Returns shipment rates for a given shipment.
|
|
802
|
+
description: |
|
|
803
|
+
With this endpoint you can fetch available shipment rates for a given shipment. It is necessary to include a valid shipmentId in the request body. Best practice is to create a shipment first, including the sender and delivery address, the packaging type and all package dimensions. The returned shipment ID can be used in the shipment-rates call to get all available rates for this shipment from the JUMiNGO system.
|
|
804
|
+
|
|
805
|
+
**Minimum input**
|
|
806
|
+
replace shipment id with shipment from your account to receive available rates. Although it is not required to include the packaging type ID in the request, the results will be more relevant if you add one.
|
|
807
|
+
```
|
|
808
|
+
{
|
|
809
|
+
"shipmentId":"s_2b28a63d65684f0aa4bcca24dafdc9df",
|
|
810
|
+
"filterData": {
|
|
811
|
+
"timeMax": 1440,
|
|
812
|
+
"timeMin": 0
|
|
813
|
+
},
|
|
814
|
+
"settings":{
|
|
815
|
+
"mode":"m"
|
|
816
|
+
}
|
|
817
|
+
}
|
|
818
|
+
```
|
|
819
|
+
**Get data for a single rate**
|
|
820
|
+
replace shipment id with shipment from your account and valid tariffId that is suitable for this shipment id
|
|
821
|
+
```
|
|
822
|
+
{
|
|
823
|
+
"shipmentId": "s_2b28a63d65684f0aa4bcca24dafdc9df",
|
|
824
|
+
"filterData": {
|
|
825
|
+
"timeMax": 1440,
|
|
826
|
+
"timeMin": 0
|
|
827
|
+
},
|
|
828
|
+
"settings": {
|
|
829
|
+
"mode": "single",
|
|
830
|
+
"tariffId": "s-420"
|
|
831
|
+
}
|
|
832
|
+
}
|
|
833
|
+
```
|
|
834
|
+
parameters:
|
|
835
|
+
- name: shipmentRate
|
|
836
|
+
in: body
|
|
837
|
+
schema:
|
|
838
|
+
$ref: '#/definitions/ShipmentRateInput'
|
|
839
|
+
responses:
|
|
840
|
+
'200':
|
|
841
|
+
description: ShipmentRate resource retrieved
|
|
842
|
+
schema:
|
|
843
|
+
$ref: '#/definitions/ShipmentRateOutput'
|
|
844
|
+
'400':
|
|
845
|
+
description: Bad Request
|
|
846
|
+
schema:
|
|
847
|
+
$ref: '#/definitions/ErrorResponse'
|
|
848
|
+
definitions:
|
|
849
|
+
AccessPoints:
|
|
850
|
+
type: object
|
|
851
|
+
description: Contains the data of the carrier access points.
|
|
852
|
+
properties:
|
|
853
|
+
id:
|
|
854
|
+
type: integer
|
|
855
|
+
description: Carrier Access Point id
|
|
856
|
+
example: 118911
|
|
857
|
+
name:
|
|
858
|
+
type: string
|
|
859
|
+
description: Carrier Access Point name
|
|
860
|
+
example: NEUSSER SCHUHREPARATUR & SCHLU
|
|
861
|
+
type:
|
|
862
|
+
type: string
|
|
863
|
+
description: Carrier Access Point type
|
|
864
|
+
example: UPS Access Point™
|
|
865
|
+
city:
|
|
866
|
+
type: string
|
|
867
|
+
description: City of the Carrier Access Point
|
|
868
|
+
example: NEUSS
|
|
869
|
+
street:
|
|
870
|
+
type: string
|
|
871
|
+
description: The adress of the Carrier Access Point
|
|
872
|
+
example: NIEDERWALLSTRASSE 31
|
|
873
|
+
postCode:
|
|
874
|
+
type: string
|
|
875
|
+
description: Postal code of the Carrier Access Point
|
|
876
|
+
example: 41460
|
|
877
|
+
countryCode:
|
|
878
|
+
$ref: '#/definitions/CountryCode'
|
|
879
|
+
state:
|
|
880
|
+
$ref: '#/definitions/State'
|
|
881
|
+
latitude:
|
|
882
|
+
type: string
|
|
883
|
+
description: The latitude of geo position
|
|
884
|
+
example: '6.687880039'
|
|
885
|
+
longitude:
|
|
886
|
+
type: string
|
|
887
|
+
description: The longitude of geo position
|
|
888
|
+
example: '6.687880039'
|
|
889
|
+
distance:
|
|
890
|
+
type: string
|
|
891
|
+
description: The distance from selected location in request
|
|
892
|
+
example: '0.5'
|
|
893
|
+
distanceCode:
|
|
894
|
+
type: string
|
|
895
|
+
description: The distance units
|
|
896
|
+
maxLength: 2
|
|
897
|
+
example: KM
|
|
898
|
+
hoursOfOperation:
|
|
899
|
+
type: array
|
|
900
|
+
items:
|
|
901
|
+
type: object
|
|
902
|
+
description: The carrier Access Point hours of operation time
|
|
903
|
+
properties:
|
|
904
|
+
dayName:
|
|
905
|
+
type: string
|
|
906
|
+
description: The day name in the current language.
|
|
907
|
+
example: Montag
|
|
908
|
+
workingHours:
|
|
909
|
+
type: string
|
|
910
|
+
description: Range of working hours throughout the day
|
|
911
|
+
example: 05:00-19:00
|
|
912
|
+
lunchBreak:
|
|
913
|
+
type: string
|
|
914
|
+
description: Range of lunch breaking hours
|
|
915
|
+
example: 13:00-14:00
|
|
916
|
+
workingDay:
|
|
917
|
+
type: boolean
|
|
918
|
+
description: Is a workable day
|
|
919
|
+
example: true
|
|
920
|
+
workState:
|
|
921
|
+
type: string
|
|
922
|
+
description: Current working state
|
|
923
|
+
example: opened
|
|
924
|
+
enum:
|
|
925
|
+
- opened
|
|
926
|
+
- closes soon
|
|
927
|
+
- closed
|
|
928
|
+
AccessPointsResponse:
|
|
929
|
+
type: object
|
|
930
|
+
description: Contains the data of the carrier response.
|
|
931
|
+
properties:
|
|
932
|
+
id:
|
|
933
|
+
type: integer
|
|
934
|
+
description: Request id
|
|
935
|
+
example: 1
|
|
936
|
+
accessPoints:
|
|
937
|
+
type: array
|
|
938
|
+
items:
|
|
939
|
+
$ref: '#/definitions/AccessPoints'
|
|
940
|
+
errors:
|
|
941
|
+
type: array
|
|
942
|
+
items:
|
|
943
|
+
type: object
|
|
944
|
+
description: Error messages for invalid carriers
|
|
945
|
+
properties:
|
|
946
|
+
carrier:
|
|
947
|
+
type: string
|
|
948
|
+
description: Carrier code
|
|
949
|
+
example: ups
|
|
950
|
+
messages:
|
|
951
|
+
type: array
|
|
952
|
+
items:
|
|
953
|
+
type: string
|
|
954
|
+
example: 'postCode: This value should not be blank'
|
|
955
|
+
CartTotalCalculatorResult:
|
|
956
|
+
type: object
|
|
957
|
+
required:
|
|
958
|
+
- shipmentIds
|
|
959
|
+
properties:
|
|
960
|
+
id:
|
|
961
|
+
type: integer
|
|
962
|
+
description: id
|
|
963
|
+
example: 1
|
|
964
|
+
tax:
|
|
965
|
+
type: number
|
|
966
|
+
format: float
|
|
967
|
+
description: The tax value
|
|
968
|
+
example: 2.82
|
|
969
|
+
taxNet:
|
|
970
|
+
type: number
|
|
971
|
+
format: float
|
|
972
|
+
description: The tax net
|
|
973
|
+
example: 14.84
|
|
974
|
+
taxFreeNet:
|
|
975
|
+
type: number
|
|
976
|
+
format: float
|
|
977
|
+
description: The taxfree net
|
|
978
|
+
example: 12.17
|
|
979
|
+
taxes:
|
|
980
|
+
type: object
|
|
981
|
+
properties:
|
|
982
|
+
DE:
|
|
983
|
+
type: object
|
|
984
|
+
description: Country code
|
|
985
|
+
properties:
|
|
986
|
+
tax_name:
|
|
987
|
+
type: string
|
|
988
|
+
example: MwSt.
|
|
989
|
+
tax_countryCode:
|
|
990
|
+
$ref: '#/definitions/CountryCode'
|
|
991
|
+
tax_rate:
|
|
992
|
+
type: number
|
|
993
|
+
format: float
|
|
994
|
+
example: 19
|
|
995
|
+
tax_id:
|
|
996
|
+
type: integer
|
|
997
|
+
example: 1
|
|
998
|
+
tax_amount:
|
|
999
|
+
type: number
|
|
1000
|
+
format: float
|
|
1001
|
+
example: 2.82
|
|
1002
|
+
taxDefaultName:
|
|
1003
|
+
type: string
|
|
1004
|
+
description: The tax default name
|
|
1005
|
+
example: MwSt.
|
|
1006
|
+
taxId:
|
|
1007
|
+
type: string
|
|
1008
|
+
description: The tax id
|
|
1009
|
+
example: DE293163480
|
|
1010
|
+
voucherValue:
|
|
1011
|
+
type: number
|
|
1012
|
+
format: float
|
|
1013
|
+
description: The value by the voucher
|
|
1014
|
+
example: 0
|
|
1015
|
+
voucherPercent:
|
|
1016
|
+
type: number
|
|
1017
|
+
format: float
|
|
1018
|
+
description: The percent by the voucher
|
|
1019
|
+
example: 0
|
|
1020
|
+
voucherCode:
|
|
1021
|
+
type: string
|
|
1022
|
+
description: The voucher code
|
|
1023
|
+
example: ''
|
|
1024
|
+
voucherType:
|
|
1025
|
+
type: string
|
|
1026
|
+
description: The type of voucher
|
|
1027
|
+
example: ''
|
|
1028
|
+
voucherOrderNumbers:
|
|
1029
|
+
type: string
|
|
1030
|
+
description: The order number of vaucher
|
|
1031
|
+
example: ''
|
|
1032
|
+
gross:
|
|
1033
|
+
type: number
|
|
1034
|
+
format: floatt
|
|
1035
|
+
description: The gross
|
|
1036
|
+
example: 29.83
|
|
1037
|
+
subtotal:
|
|
1038
|
+
type: number
|
|
1039
|
+
format: float
|
|
1040
|
+
description: The Subtotal cost
|
|
1041
|
+
example: 29.83
|
|
1042
|
+
surcharges:
|
|
1043
|
+
type: number
|
|
1044
|
+
format: float
|
|
1045
|
+
description: The surcharges
|
|
1046
|
+
example: 0
|
|
1047
|
+
plusProductSurcharges:
|
|
1048
|
+
type: object
|
|
1049
|
+
properties:
|
|
1050
|
+
id:
|
|
1051
|
+
type: integer
|
|
1052
|
+
description: id
|
|
1053
|
+
example: 1
|
|
1054
|
+
minSurcharge:
|
|
1055
|
+
type: number
|
|
1056
|
+
format: float
|
|
1057
|
+
description: The minimal surcharge
|
|
1058
|
+
example: 0.42
|
|
1059
|
+
percentSurcharge:
|
|
1060
|
+
type: integer
|
|
1061
|
+
description: The percent of surcharge
|
|
1062
|
+
example: 10
|
|
1063
|
+
price:
|
|
1064
|
+
type: number
|
|
1065
|
+
format: float
|
|
1066
|
+
description: The price
|
|
1067
|
+
example: 0.5
|
|
1068
|
+
currency:
|
|
1069
|
+
type: string
|
|
1070
|
+
description: Designation Currency
|
|
1071
|
+
minLength: 3
|
|
1072
|
+
maxLength: 3
|
|
1073
|
+
example: EUR
|
|
1074
|
+
additionalServicesSeparately:
|
|
1075
|
+
type: object
|
|
1076
|
+
properties:
|
|
1077
|
+
standard_insurance_total:
|
|
1078
|
+
type: number
|
|
1079
|
+
format: float
|
|
1080
|
+
description: total of all standard insurance costs
|
|
1081
|
+
example: 0.5
|
|
1082
|
+
standard_insurance_total_uvp:
|
|
1083
|
+
type: number
|
|
1084
|
+
format: float
|
|
1085
|
+
description: total of all uvp/original standard insurance costs if discount applies
|
|
1086
|
+
example: 0.5
|
|
1087
|
+
premium_insurance_total:
|
|
1088
|
+
type: number
|
|
1089
|
+
format: float
|
|
1090
|
+
description: total of all premium insurance costs
|
|
1091
|
+
example: 0.5
|
|
1092
|
+
premium_insurance_total_uvp:
|
|
1093
|
+
type: number
|
|
1094
|
+
format: float
|
|
1095
|
+
description: total of all uvp/original premium insurance costs if discount applies
|
|
1096
|
+
example: 0.5
|
|
1097
|
+
export_declaration_total:
|
|
1098
|
+
type: number
|
|
1099
|
+
format: float
|
|
1100
|
+
description: total of all export declaration costs
|
|
1101
|
+
example: 0.5
|
|
1102
|
+
export_declaration_total_uvp:
|
|
1103
|
+
type: number
|
|
1104
|
+
format: float
|
|
1105
|
+
description: total of all uvp/original export declaration costs if discount applies
|
|
1106
|
+
example: 0.5
|
|
1107
|
+
shipping_costs_total_uvp:
|
|
1108
|
+
type: number
|
|
1109
|
+
format: float
|
|
1110
|
+
description: total of all uvp/original rate costs if discount applies
|
|
1111
|
+
example: 0.5
|
|
1112
|
+
description: Contains the data of the cart total calculator result.
|
|
1113
|
+
CartTotalInput:
|
|
1114
|
+
type: object
|
|
1115
|
+
required:
|
|
1116
|
+
- shipmentIds
|
|
1117
|
+
properties:
|
|
1118
|
+
shipmentIds:
|
|
1119
|
+
type: array
|
|
1120
|
+
items:
|
|
1121
|
+
type: string
|
|
1122
|
+
description: The list of shipment uuid
|
|
1123
|
+
example:
|
|
1124
|
+
- s_642bf5ab244c4380a379f0c8877f69b3
|
|
1125
|
+
- s_42499ae0e73843ada5e313f1eaca8779
|
|
1126
|
+
voucherCode:
|
|
1127
|
+
type: string
|
|
1128
|
+
description: The voucher code
|
|
1129
|
+
example: XmasDiscount
|
|
1130
|
+
description: Contains the List of shipment uuid and voucher code.
|
|
1131
|
+
CartTotalOutput:
|
|
1132
|
+
type: object
|
|
1133
|
+
required:
|
|
1134
|
+
- total
|
|
1135
|
+
- paymentMethods
|
|
1136
|
+
properties:
|
|
1137
|
+
total:
|
|
1138
|
+
type: object
|
|
1139
|
+
description: Cart Total Result
|
|
1140
|
+
$ref: '#/definitions/CartTotalCalculatorResult'
|
|
1141
|
+
paymentMethods:
|
|
1142
|
+
type: array
|
|
1143
|
+
description: List of available payment methods
|
|
1144
|
+
items:
|
|
1145
|
+
$ref: '#/definitions/PaymentMethodsOutput'
|
|
1146
|
+
shipments:
|
|
1147
|
+
type: array
|
|
1148
|
+
description: List of calculated shipments
|
|
1149
|
+
items:
|
|
1150
|
+
$ref: '#/definitions/Shipment'
|
|
1151
|
+
description: Contains total and payment metods data
|
|
1152
|
+
ConfirmationDocument:
|
|
1153
|
+
type: object
|
|
1154
|
+
properties:
|
|
1155
|
+
name:
|
|
1156
|
+
type: string
|
|
1157
|
+
description: Document name
|
|
1158
|
+
example: A-200206AJ75-1.pdf
|
|
1159
|
+
type:
|
|
1160
|
+
type: string
|
|
1161
|
+
description: Type of document
|
|
1162
|
+
example: confirmation
|
|
1163
|
+
reference:
|
|
1164
|
+
type: string
|
|
1165
|
+
description: Reference
|
|
1166
|
+
example: 200206AJ75-1
|
|
1167
|
+
file:
|
|
1168
|
+
type: string
|
|
1169
|
+
description: Base64 file content
|
|
1170
|
+
Connection:
|
|
1171
|
+
type: object
|
|
1172
|
+
properties:
|
|
1173
|
+
id:
|
|
1174
|
+
type: integer
|
|
1175
|
+
description: Connection id
|
|
1176
|
+
example: 1
|
|
1177
|
+
uuid:
|
|
1178
|
+
type: string
|
|
1179
|
+
description: identifier of connection
|
|
1180
|
+
example: 5e3c1411
|
|
1181
|
+
name:
|
|
1182
|
+
type: string
|
|
1183
|
+
description: Name of connection
|
|
1184
|
+
example: test
|
|
1185
|
+
connectionTypeId:
|
|
1186
|
+
type: integer
|
|
1187
|
+
description: identifier of connection type
|
|
1188
|
+
example: test
|
|
1189
|
+
active:
|
|
1190
|
+
type: integer
|
|
1191
|
+
description: identifier whether connection active or not
|
|
1192
|
+
example: test
|
|
1193
|
+
lastSynced:
|
|
1194
|
+
type: string
|
|
1195
|
+
description: identifier last sync date
|
|
1196
|
+
example: noch nie
|
|
1197
|
+
initSync:
|
|
1198
|
+
type: string
|
|
1199
|
+
description: identifier connection sync period
|
|
1200
|
+
example: 0d
|
|
1201
|
+
syncPeriod:
|
|
1202
|
+
type: string
|
|
1203
|
+
description: identifier whether connection active or not
|
|
1204
|
+
example: 4h
|
|
1205
|
+
sendTrackingMail:
|
|
1206
|
+
type: integer
|
|
1207
|
+
description: identifier whether send tracking email or not
|
|
1208
|
+
example: 1
|
|
1209
|
+
default: 0
|
|
1210
|
+
connectionDetails:
|
|
1211
|
+
type: array
|
|
1212
|
+
items:
|
|
1213
|
+
type: string
|
|
1214
|
+
description: Connection details
|
|
1215
|
+
status:
|
|
1216
|
+
type: string
|
|
1217
|
+
description: Connection status
|
|
1218
|
+
example: new
|
|
1219
|
+
message:
|
|
1220
|
+
type: string
|
|
1221
|
+
webhookUrl:
|
|
1222
|
+
type: string
|
|
1223
|
+
description: Webhook url address
|
|
1224
|
+
deleted:
|
|
1225
|
+
type: integer
|
|
1226
|
+
description: identifier whether connection was deleted or not
|
|
1227
|
+
example: 1
|
|
1228
|
+
default: 0
|
|
1229
|
+
created:
|
|
1230
|
+
type: string
|
|
1231
|
+
format: date-time
|
|
1232
|
+
description: Connection creation date
|
|
1233
|
+
example: 21.04.2020 2 Uhr
|
|
1234
|
+
modified:
|
|
1235
|
+
type: string
|
|
1236
|
+
format: date-time
|
|
1237
|
+
description: Connection creation date
|
|
1238
|
+
example: 21.04.2020 2 Uhr
|
|
1239
|
+
connectionType:
|
|
1240
|
+
$ref: '#/definitions/ConnectionType'
|
|
1241
|
+
syncPeriodText:
|
|
1242
|
+
type: string
|
|
1243
|
+
description: Description of sync period
|
|
1244
|
+
example: alle 4 Stunden
|
|
1245
|
+
dates_aggregation:
|
|
1246
|
+
type: array
|
|
1247
|
+
items:
|
|
1248
|
+
type: object
|
|
1249
|
+
description: 'The key of item is name of the date. For example: "LastSynced"'
|
|
1250
|
+
properties:
|
|
1251
|
+
date:
|
|
1252
|
+
type: string
|
|
1253
|
+
description: Date in Y-m-d format
|
|
1254
|
+
example: '2020-02-06'
|
|
1255
|
+
time:
|
|
1256
|
+
type: string
|
|
1257
|
+
description: Time in H:i:s format
|
|
1258
|
+
example: '14:21:28'
|
|
1259
|
+
minutes:
|
|
1260
|
+
type: integer
|
|
1261
|
+
description: Time minutes
|
|
1262
|
+
example: 1440
|
|
1263
|
+
receiveWebhook:
|
|
1264
|
+
type: boolean
|
|
1265
|
+
description: Is receive webhook enabled for connection
|
|
1266
|
+
ConnectionCustomData:
|
|
1267
|
+
type: object
|
|
1268
|
+
required:
|
|
1269
|
+
- buyer_name
|
|
1270
|
+
- items
|
|
1271
|
+
- order_date
|
|
1272
|
+
- order_number
|
|
1273
|
+
- order_status
|
|
1274
|
+
- shipping_cost_amount
|
|
1275
|
+
- shipping_cost_currency
|
|
1276
|
+
- shipping_method
|
|
1277
|
+
- sub_total_amount
|
|
1278
|
+
- sub_total_currency
|
|
1279
|
+
- tax_amount
|
|
1280
|
+
- tax_currency
|
|
1281
|
+
- total_amount
|
|
1282
|
+
- total_currency
|
|
1283
|
+
properties:
|
|
1284
|
+
order_number:
|
|
1285
|
+
type: string
|
|
1286
|
+
description: Order number
|
|
1287
|
+
maxLength: 255
|
|
1288
|
+
example: 123-456-789
|
|
1289
|
+
order_date:
|
|
1290
|
+
type: string
|
|
1291
|
+
format: date-time
|
|
1292
|
+
description: Order date
|
|
1293
|
+
example: '2018-06-30T12:52:03Z'
|
|
1294
|
+
order_status:
|
|
1295
|
+
type: string
|
|
1296
|
+
description: Order Status
|
|
1297
|
+
maxLength: 255
|
|
1298
|
+
example: paid
|
|
1299
|
+
sub_total_amount:
|
|
1300
|
+
type: number
|
|
1301
|
+
format: float
|
|
1302
|
+
description: Subtotal
|
|
1303
|
+
minimum: 0
|
|
1304
|
+
example: 15.66
|
|
1305
|
+
sub_total_currency:
|
|
1306
|
+
$ref: '#/definitions/Currency'
|
|
1307
|
+
tax_amount:
|
|
1308
|
+
type: number
|
|
1309
|
+
format: float
|
|
1310
|
+
description: Tax amount
|
|
1311
|
+
minimum: 0
|
|
1312
|
+
example: 5.19
|
|
1313
|
+
tax_currency:
|
|
1314
|
+
$ref: '#/definitions/Currency'
|
|
1315
|
+
shipping_cost_amount:
|
|
1316
|
+
type: number
|
|
1317
|
+
format: float
|
|
1318
|
+
description: Shipping costs of the order
|
|
1319
|
+
minimum: 0
|
|
1320
|
+
example: 2.99
|
|
1321
|
+
shipping_cost_currency:
|
|
1322
|
+
$ref: '#/definitions/Currency'
|
|
1323
|
+
total_amount:
|
|
1324
|
+
type: number
|
|
1325
|
+
format: float
|
|
1326
|
+
description: Total
|
|
1327
|
+
minimum: 0
|
|
1328
|
+
example: 13.44
|
|
1329
|
+
total_currency:
|
|
1330
|
+
$ref: '#/definitions/Currency'
|
|
1331
|
+
shipping_method:
|
|
1332
|
+
type: string
|
|
1333
|
+
description: Customer-selected delivery method
|
|
1334
|
+
maxLength: 255
|
|
1335
|
+
example: next day
|
|
1336
|
+
earliest_delivery_date:
|
|
1337
|
+
type: string
|
|
1338
|
+
format: date
|
|
1339
|
+
description: Earliest delivery date
|
|
1340
|
+
example: '2018-07-01'
|
|
1341
|
+
latest_delivery_date:
|
|
1342
|
+
type: string
|
|
1343
|
+
format: date
|
|
1344
|
+
description: Latest delivery date
|
|
1345
|
+
example: '2018-07-01'
|
|
1346
|
+
payment_method:
|
|
1347
|
+
type: string
|
|
1348
|
+
description: Payment method
|
|
1349
|
+
maxLength: 255
|
|
1350
|
+
example: others
|
|
1351
|
+
payment_date:
|
|
1352
|
+
type: string
|
|
1353
|
+
format: date-time
|
|
1354
|
+
description: Payment date
|
|
1355
|
+
example: '2018-06-30T12:52:03Z'
|
|
1356
|
+
buyer_name:
|
|
1357
|
+
type: string
|
|
1358
|
+
description: Full name of the buyer
|
|
1359
|
+
maxLength: 255
|
|
1360
|
+
example: John Doe
|
|
1361
|
+
buyer_email:
|
|
1362
|
+
type: string
|
|
1363
|
+
description: Email address of the buyer
|
|
1364
|
+
maxLength: 254
|
|
1365
|
+
example: email@example.org
|
|
1366
|
+
buyer_tax_id:
|
|
1367
|
+
type: string
|
|
1368
|
+
description: Tax number of the buyer
|
|
1369
|
+
maxLength: 255
|
|
1370
|
+
example: DE123456789
|
|
1371
|
+
sale_channel:
|
|
1372
|
+
type: string
|
|
1373
|
+
description: Sales channel
|
|
1374
|
+
maxLength: 255
|
|
1375
|
+
example: main shop
|
|
1376
|
+
notes:
|
|
1377
|
+
type: string
|
|
1378
|
+
description: Custom notes about the order
|
|
1379
|
+
maxLength: 255
|
|
1380
|
+
example: Treat with priority
|
|
1381
|
+
items:
|
|
1382
|
+
type: array
|
|
1383
|
+
description: Items of the order
|
|
1384
|
+
items:
|
|
1385
|
+
$ref: '#/definitions/ConnectionCustomDataItem'
|
|
1386
|
+
description: |-
|
|
1387
|
+
Used to submit additional order data from e-commerce systems.
|
|
1388
|
+
Contains the data of the order and one or more included items.
|
|
1389
|
+
Required for shop / e-commerce connections, optional for API connections.
|
|
1390
|
+
ConnectionCustomDataItem:
|
|
1391
|
+
type: object
|
|
1392
|
+
required:
|
|
1393
|
+
- id
|
|
1394
|
+
- price_amount
|
|
1395
|
+
- price_currency
|
|
1396
|
+
- quantity
|
|
1397
|
+
- title
|
|
1398
|
+
properties:
|
|
1399
|
+
id:
|
|
1400
|
+
type: string
|
|
1401
|
+
description: Item ID
|
|
1402
|
+
maxLength: 255
|
|
1403
|
+
example: a-id-123
|
|
1404
|
+
quantity:
|
|
1405
|
+
type: integer
|
|
1406
|
+
format: int32
|
|
1407
|
+
description: The quantity of this item
|
|
1408
|
+
minimum: 1
|
|
1409
|
+
maximum: 999999999
|
|
1410
|
+
example: 3
|
|
1411
|
+
title:
|
|
1412
|
+
type: string
|
|
1413
|
+
description: Title of the item
|
|
1414
|
+
maxLength: 255
|
|
1415
|
+
example: T-Shirt
|
|
1416
|
+
variant:
|
|
1417
|
+
type: string
|
|
1418
|
+
description: Variant of the item
|
|
1419
|
+
maxLength: 255
|
|
1420
|
+
example: size M, color red
|
|
1421
|
+
sku:
|
|
1422
|
+
type: string
|
|
1423
|
+
description: Stock keeping unit value
|
|
1424
|
+
maxLength: 255
|
|
1425
|
+
example: sku123
|
|
1426
|
+
condition:
|
|
1427
|
+
type: string
|
|
1428
|
+
description: Condition of the article
|
|
1429
|
+
maxLength: 255
|
|
1430
|
+
example: new
|
|
1431
|
+
price_amount:
|
|
1432
|
+
type: number
|
|
1433
|
+
format: float
|
|
1434
|
+
description: Total price of item(s)
|
|
1435
|
+
minimum: 0
|
|
1436
|
+
example: 1.23
|
|
1437
|
+
price_currency:
|
|
1438
|
+
$ref: '#/definitions/Currency'
|
|
1439
|
+
ConnectionType:
|
|
1440
|
+
type: object
|
|
1441
|
+
properties:
|
|
1442
|
+
id:
|
|
1443
|
+
type: integer
|
|
1444
|
+
description: Connection id
|
|
1445
|
+
example: 1
|
|
1446
|
+
version:
|
|
1447
|
+
type: integer
|
|
1448
|
+
description: Connection version
|
|
1449
|
+
example: 1
|
|
1450
|
+
description:
|
|
1451
|
+
type: object
|
|
1452
|
+
properties:
|
|
1453
|
+
name:
|
|
1454
|
+
type: string
|
|
1455
|
+
description: Name of connection type
|
|
1456
|
+
example: eBay
|
|
1457
|
+
description:
|
|
1458
|
+
type: string
|
|
1459
|
+
description: Description of connection type
|
|
1460
|
+
image:
|
|
1461
|
+
type: string
|
|
1462
|
+
description: Location of connection type image
|
|
1463
|
+
example: /img/connections/ebay.png
|
|
1464
|
+
metaKeywords:
|
|
1465
|
+
type: string
|
|
1466
|
+
description: Meta keywords of connection type
|
|
1467
|
+
metaDescription:
|
|
1468
|
+
type: string
|
|
1469
|
+
description: Meta description of connection type
|
|
1470
|
+
formFields:
|
|
1471
|
+
type: array
|
|
1472
|
+
items:
|
|
1473
|
+
type: object
|
|
1474
|
+
properties:
|
|
1475
|
+
name:
|
|
1476
|
+
type: string
|
|
1477
|
+
example: siteId
|
|
1478
|
+
label:
|
|
1479
|
+
type: string
|
|
1480
|
+
example: eBay Webseite (Land)
|
|
1481
|
+
type:
|
|
1482
|
+
type: string
|
|
1483
|
+
example: select
|
|
1484
|
+
options:
|
|
1485
|
+
type: array
|
|
1486
|
+
items:
|
|
1487
|
+
type: string
|
|
1488
|
+
required:
|
|
1489
|
+
type: boolean
|
|
1490
|
+
example: true
|
|
1491
|
+
info:
|
|
1492
|
+
type: string
|
|
1493
|
+
example: info
|
|
1494
|
+
isCreationViaApiAllowed:
|
|
1495
|
+
type: boolean
|
|
1496
|
+
description: Indicates whether the connection and shipments can only be created via api or via an account
|
|
1497
|
+
example: true
|
|
1498
|
+
isVisible:
|
|
1499
|
+
type: boolean
|
|
1500
|
+
description: Indicates whether the connection in the account can be selected when creating a new one
|
|
1501
|
+
example: true
|
|
1502
|
+
isSyncable:
|
|
1503
|
+
type: boolean
|
|
1504
|
+
description: Indicates whether the jumingo account can be synced with a button (ebay, amazon) or not (api, plugins)
|
|
1505
|
+
example: true
|
|
1506
|
+
showApiToken:
|
|
1507
|
+
type: boolean
|
|
1508
|
+
description: Specifies whether the api token should be displayed (for api and shop plugins)
|
|
1509
|
+
example: true
|
|
1510
|
+
hasCreateForm:
|
|
1511
|
+
type: boolean
|
|
1512
|
+
description: Indicates whether a connection is created via form or not (from external via shop plugin)
|
|
1513
|
+
example: true
|
|
1514
|
+
ConnectionsCollection:
|
|
1515
|
+
type: array
|
|
1516
|
+
items:
|
|
1517
|
+
$ref: '#/definitions/Connection'
|
|
1518
|
+
Country:
|
|
1519
|
+
type: object
|
|
1520
|
+
description: Country
|
|
1521
|
+
properties:
|
|
1522
|
+
id:
|
|
1523
|
+
type: integer
|
|
1524
|
+
description: Country id
|
|
1525
|
+
example: 21
|
|
1526
|
+
isoCode:
|
|
1527
|
+
$ref: '#/definitions/CountryCode'
|
|
1528
|
+
taxFree:
|
|
1529
|
+
type: integer
|
|
1530
|
+
description: Indicates that shipping from or to this country is VAT free
|
|
1531
|
+
example: 1
|
|
1532
|
+
default: 0
|
|
1533
|
+
name:
|
|
1534
|
+
type: string
|
|
1535
|
+
description: Country name
|
|
1536
|
+
maxLength: 50
|
|
1537
|
+
example: Andorra
|
|
1538
|
+
postCodeFree:
|
|
1539
|
+
type: integer
|
|
1540
|
+
description: Indicates that country does not have post codes
|
|
1541
|
+
example: 1
|
|
1542
|
+
default: 0
|
|
1543
|
+
settings:
|
|
1544
|
+
type: array
|
|
1545
|
+
description: Custom country data
|
|
1546
|
+
items:
|
|
1547
|
+
type: object
|
|
1548
|
+
example: []
|
|
1549
|
+
CountryCode:
|
|
1550
|
+
type: string
|
|
1551
|
+
description: Country as ISO 3166-1 alpha-2 code
|
|
1552
|
+
example: US
|
|
1553
|
+
enum:
|
|
1554
|
+
- AD
|
|
1555
|
+
- AE
|
|
1556
|
+
- AF
|
|
1557
|
+
- AG
|
|
1558
|
+
- AI
|
|
1559
|
+
- AL
|
|
1560
|
+
- AM
|
|
1561
|
+
- AO
|
|
1562
|
+
- AQ
|
|
1563
|
+
- AR
|
|
1564
|
+
- AS
|
|
1565
|
+
- AT
|
|
1566
|
+
- AU
|
|
1567
|
+
- AW
|
|
1568
|
+
- AX
|
|
1569
|
+
- AZ
|
|
1570
|
+
- BA
|
|
1571
|
+
- BB
|
|
1572
|
+
- BD
|
|
1573
|
+
- BE
|
|
1574
|
+
- BF
|
|
1575
|
+
- BG
|
|
1576
|
+
- BH
|
|
1577
|
+
- BI
|
|
1578
|
+
- BJ
|
|
1579
|
+
- BL
|
|
1580
|
+
- BM
|
|
1581
|
+
- BN
|
|
1582
|
+
- BO
|
|
1583
|
+
- BQ
|
|
1584
|
+
- BR
|
|
1585
|
+
- BS
|
|
1586
|
+
- BT
|
|
1587
|
+
- BV
|
|
1588
|
+
- BW
|
|
1589
|
+
- BY
|
|
1590
|
+
- BZ
|
|
1591
|
+
- CA
|
|
1592
|
+
- CC
|
|
1593
|
+
- CD
|
|
1594
|
+
- CF
|
|
1595
|
+
- CG
|
|
1596
|
+
- CH
|
|
1597
|
+
- CI
|
|
1598
|
+
- CK
|
|
1599
|
+
- CL
|
|
1600
|
+
- CM
|
|
1601
|
+
- CN
|
|
1602
|
+
- CO
|
|
1603
|
+
- CR
|
|
1604
|
+
- CU
|
|
1605
|
+
- CV
|
|
1606
|
+
- CW
|
|
1607
|
+
- CX
|
|
1608
|
+
- CY
|
|
1609
|
+
- CZ
|
|
1610
|
+
- DE
|
|
1611
|
+
- DJ
|
|
1612
|
+
- DK
|
|
1613
|
+
- DM
|
|
1614
|
+
- DO
|
|
1615
|
+
- DZ
|
|
1616
|
+
- EC
|
|
1617
|
+
- EE
|
|
1618
|
+
- EG
|
|
1619
|
+
- EH
|
|
1620
|
+
- ER
|
|
1621
|
+
- ES
|
|
1622
|
+
- ET
|
|
1623
|
+
- FI
|
|
1624
|
+
- FJ
|
|
1625
|
+
- FK
|
|
1626
|
+
- FM
|
|
1627
|
+
- FO
|
|
1628
|
+
- FR
|
|
1629
|
+
- GA
|
|
1630
|
+
- GB
|
|
1631
|
+
- GD
|
|
1632
|
+
- GE
|
|
1633
|
+
- GF
|
|
1634
|
+
- GG
|
|
1635
|
+
- GH
|
|
1636
|
+
- GI
|
|
1637
|
+
- GL
|
|
1638
|
+
- GM
|
|
1639
|
+
- GN
|
|
1640
|
+
- GP
|
|
1641
|
+
- GQ
|
|
1642
|
+
- GR
|
|
1643
|
+
- GS
|
|
1644
|
+
- GT
|
|
1645
|
+
- GU
|
|
1646
|
+
- GW
|
|
1647
|
+
- GY
|
|
1648
|
+
- HK
|
|
1649
|
+
- HM
|
|
1650
|
+
- HN
|
|
1651
|
+
- HR
|
|
1652
|
+
- HT
|
|
1653
|
+
- HU
|
|
1654
|
+
- IC
|
|
1655
|
+
- ID
|
|
1656
|
+
- IE
|
|
1657
|
+
- IL
|
|
1658
|
+
- IM
|
|
1659
|
+
- IN
|
|
1660
|
+
- IO
|
|
1661
|
+
- IQ
|
|
1662
|
+
- IR
|
|
1663
|
+
- IS
|
|
1664
|
+
- IT
|
|
1665
|
+
- JE
|
|
1666
|
+
- JM
|
|
1667
|
+
- JO
|
|
1668
|
+
- JP
|
|
1669
|
+
- KE
|
|
1670
|
+
- KG
|
|
1671
|
+
- KH
|
|
1672
|
+
- KI
|
|
1673
|
+
- KM
|
|
1674
|
+
- KN
|
|
1675
|
+
- KP
|
|
1676
|
+
- KR
|
|
1677
|
+
- KW
|
|
1678
|
+
- KY
|
|
1679
|
+
- KZ
|
|
1680
|
+
- LA
|
|
1681
|
+
- LB
|
|
1682
|
+
- LC
|
|
1683
|
+
- LI
|
|
1684
|
+
- LK
|
|
1685
|
+
- LR
|
|
1686
|
+
- LS
|
|
1687
|
+
- LT
|
|
1688
|
+
- LU
|
|
1689
|
+
- LV
|
|
1690
|
+
- LY
|
|
1691
|
+
- MA
|
|
1692
|
+
- MC
|
|
1693
|
+
- MD
|
|
1694
|
+
- ME
|
|
1695
|
+
- MF
|
|
1696
|
+
- MG
|
|
1697
|
+
- MH
|
|
1698
|
+
- MK
|
|
1699
|
+
- ML
|
|
1700
|
+
- MM
|
|
1701
|
+
- MN
|
|
1702
|
+
- MO
|
|
1703
|
+
- MP
|
|
1704
|
+
- MQ
|
|
1705
|
+
- MR
|
|
1706
|
+
- MS
|
|
1707
|
+
- MT
|
|
1708
|
+
- MU
|
|
1709
|
+
- MV
|
|
1710
|
+
- MW
|
|
1711
|
+
- MX
|
|
1712
|
+
- MY
|
|
1713
|
+
- MZ
|
|
1714
|
+
- NA
|
|
1715
|
+
- NC
|
|
1716
|
+
- NE
|
|
1717
|
+
- NF
|
|
1718
|
+
- NG
|
|
1719
|
+
- NI
|
|
1720
|
+
- NL
|
|
1721
|
+
- 'NO'
|
|
1722
|
+
- NP
|
|
1723
|
+
- NR
|
|
1724
|
+
- NU
|
|
1725
|
+
- NZ
|
|
1726
|
+
- OM
|
|
1727
|
+
- PA
|
|
1728
|
+
- PE
|
|
1729
|
+
- PF
|
|
1730
|
+
- PG
|
|
1731
|
+
- PH
|
|
1732
|
+
- PK
|
|
1733
|
+
- PL
|
|
1734
|
+
- PM
|
|
1735
|
+
- PN
|
|
1736
|
+
- PR
|
|
1737
|
+
- PS
|
|
1738
|
+
- PT
|
|
1739
|
+
- PW
|
|
1740
|
+
- PY
|
|
1741
|
+
- QA
|
|
1742
|
+
- RE
|
|
1743
|
+
- RO
|
|
1744
|
+
- RS
|
|
1745
|
+
- RU
|
|
1746
|
+
- RW
|
|
1747
|
+
- SA
|
|
1748
|
+
- SB
|
|
1749
|
+
- SC
|
|
1750
|
+
- SD
|
|
1751
|
+
- SE
|
|
1752
|
+
- SG
|
|
1753
|
+
- SH
|
|
1754
|
+
- SI
|
|
1755
|
+
- SJ
|
|
1756
|
+
- SK
|
|
1757
|
+
- SL
|
|
1758
|
+
- SM
|
|
1759
|
+
- SN
|
|
1760
|
+
- SO
|
|
1761
|
+
- SR
|
|
1762
|
+
- SS
|
|
1763
|
+
- ST
|
|
1764
|
+
- SV
|
|
1765
|
+
- SX
|
|
1766
|
+
- SY
|
|
1767
|
+
- SZ
|
|
1768
|
+
- TC
|
|
1769
|
+
- TD
|
|
1770
|
+
- TF
|
|
1771
|
+
- TG
|
|
1772
|
+
- TH
|
|
1773
|
+
- TJ
|
|
1774
|
+
- TK
|
|
1775
|
+
- TL
|
|
1776
|
+
- TM
|
|
1777
|
+
- TN
|
|
1778
|
+
- TO
|
|
1779
|
+
- TR
|
|
1780
|
+
- TT
|
|
1781
|
+
- TV
|
|
1782
|
+
- TW
|
|
1783
|
+
- TZ
|
|
1784
|
+
- UA
|
|
1785
|
+
- UG
|
|
1786
|
+
- UM
|
|
1787
|
+
- US
|
|
1788
|
+
- UY
|
|
1789
|
+
- UZ
|
|
1790
|
+
- VA
|
|
1791
|
+
- VC
|
|
1792
|
+
- VE
|
|
1793
|
+
- VG
|
|
1794
|
+
- VI
|
|
1795
|
+
- VN
|
|
1796
|
+
- VU
|
|
1797
|
+
- WF
|
|
1798
|
+
- WS
|
|
1799
|
+
- XK
|
|
1800
|
+
- YE
|
|
1801
|
+
- YT
|
|
1802
|
+
- ZA
|
|
1803
|
+
- ZM
|
|
1804
|
+
- ZW
|
|
1805
|
+
CreateConnection:
|
|
1806
|
+
type: object
|
|
1807
|
+
required:
|
|
1808
|
+
- name
|
|
1809
|
+
- plugin_name
|
|
1810
|
+
- plugin_version
|
|
1811
|
+
- settings
|
|
1812
|
+
- shop_url
|
|
1813
|
+
- shop_version
|
|
1814
|
+
- type_id
|
|
1815
|
+
- webhook_url
|
|
1816
|
+
properties:
|
|
1817
|
+
name:
|
|
1818
|
+
type: string
|
|
1819
|
+
description: Name of the shop
|
|
1820
|
+
maxLength: 255
|
|
1821
|
+
example: my shop connection
|
|
1822
|
+
type_id:
|
|
1823
|
+
type: integer
|
|
1824
|
+
example: 1
|
|
1825
|
+
description: Connection type ID; please see external list of valid connection type IDs.
|
|
1826
|
+
webhook_url:
|
|
1827
|
+
type: string
|
|
1828
|
+
description: URL to which the webhooks should be sent
|
|
1829
|
+
maxLength: 2000
|
|
1830
|
+
example: https://www.example.org/
|
|
1831
|
+
shop_url:
|
|
1832
|
+
type: string
|
|
1833
|
+
description: URL of the shop
|
|
1834
|
+
maxLength: 2000
|
|
1835
|
+
example: https://www.example.org/
|
|
1836
|
+
shop_version:
|
|
1837
|
+
type: string
|
|
1838
|
+
description: Version of the shop
|
|
1839
|
+
maxLength: 255
|
|
1840
|
+
example: v1.0 beta
|
|
1841
|
+
plugin_name:
|
|
1842
|
+
type: string
|
|
1843
|
+
description: Name of the plugin
|
|
1844
|
+
maxLength: 255
|
|
1845
|
+
example: my shop plugin
|
|
1846
|
+
plugin_version:
|
|
1847
|
+
type: string
|
|
1848
|
+
description: Version of the plugin
|
|
1849
|
+
maxLength: 255
|
|
1850
|
+
example: v1.1
|
|
1851
|
+
settings:
|
|
1852
|
+
type: string
|
|
1853
|
+
description: Shop settings
|
|
1854
|
+
maxLength: 5000
|
|
1855
|
+
description: Body for request to create a connection.
|
|
1856
|
+
CreateConnectionResult:
|
|
1857
|
+
type: object
|
|
1858
|
+
properties:
|
|
1859
|
+
connection_uuid:
|
|
1860
|
+
type: string
|
|
1861
|
+
example: c_dfd82f79758545adb67e22d4a6102f47
|
|
1862
|
+
description: Returns the connection ID.
|
|
1863
|
+
CreateShipment:
|
|
1864
|
+
type: object
|
|
1865
|
+
required:
|
|
1866
|
+
- details
|
|
1867
|
+
- packages
|
|
1868
|
+
- from_address
|
|
1869
|
+
- to_address
|
|
1870
|
+
properties:
|
|
1871
|
+
from_address:
|
|
1872
|
+
$ref: '#/definitions/CreateShipmentAddress'
|
|
1873
|
+
to_address:
|
|
1874
|
+
$ref: '#/definitions/CreateShipmentAddress'
|
|
1875
|
+
details:
|
|
1876
|
+
$ref: '#/definitions/CreateShipmentDetails'
|
|
1877
|
+
packages:
|
|
1878
|
+
type: array
|
|
1879
|
+
description: Packages of the shipment
|
|
1880
|
+
items:
|
|
1881
|
+
$ref: '#/definitions/CreateShipmentPackage'
|
|
1882
|
+
customs_invoice:
|
|
1883
|
+
$ref: '#/definitions/CustomsInvoiceInput'
|
|
1884
|
+
connection:
|
|
1885
|
+
$ref: '#/definitions/CreateShipmentConnection'
|
|
1886
|
+
rate:
|
|
1887
|
+
$ref: '#/definitions/CreateShipmentRate'
|
|
1888
|
+
label_format:
|
|
1889
|
+
type: string
|
|
1890
|
+
description: Label format
|
|
1891
|
+
enum:
|
|
1892
|
+
- A4
|
|
1893
|
+
- A6
|
|
1894
|
+
UpdateShipment:
|
|
1895
|
+
type: object
|
|
1896
|
+
required:
|
|
1897
|
+
- details
|
|
1898
|
+
- packages
|
|
1899
|
+
- from_address
|
|
1900
|
+
- to_address
|
|
1901
|
+
properties:
|
|
1902
|
+
from_address:
|
|
1903
|
+
$ref: '#/definitions/CreateShipmentAddress'
|
|
1904
|
+
to_address:
|
|
1905
|
+
$ref: '#/definitions/CreateShipmentAddress'
|
|
1906
|
+
billing_address:
|
|
1907
|
+
$ref: '#/definitions/ShipmentAddress'
|
|
1908
|
+
details:
|
|
1909
|
+
$ref: '#/definitions/CreateShipmentDetails'
|
|
1910
|
+
packages:
|
|
1911
|
+
type: array
|
|
1912
|
+
description: Packages of the shipment
|
|
1913
|
+
items:
|
|
1914
|
+
$ref: '#/definitions/CreateShipmentPackage'
|
|
1915
|
+
customs_invoice:
|
|
1916
|
+
$ref: '#/definitions/CustomsInvoiceInput'
|
|
1917
|
+
connection:
|
|
1918
|
+
$ref: '#/definitions/CreateShipmentConnection'
|
|
1919
|
+
rate:
|
|
1920
|
+
$ref: '#/definitions/CreateShipmentRate'
|
|
1921
|
+
label_format:
|
|
1922
|
+
type: string
|
|
1923
|
+
description: Label format
|
|
1924
|
+
enum:
|
|
1925
|
+
- A4
|
|
1926
|
+
- A6
|
|
1927
|
+
CreateShipmentAddress:
|
|
1928
|
+
type: object
|
|
1929
|
+
required:
|
|
1930
|
+
- city
|
|
1931
|
+
- country
|
|
1932
|
+
- name
|
|
1933
|
+
- street
|
|
1934
|
+
properties:
|
|
1935
|
+
company:
|
|
1936
|
+
type: string
|
|
1937
|
+
description: Company name
|
|
1938
|
+
maxLength: 35
|
|
1939
|
+
example: Test Corp.
|
|
1940
|
+
name:
|
|
1941
|
+
type: string
|
|
1942
|
+
description: First and Last Name
|
|
1943
|
+
maxLength: 35
|
|
1944
|
+
example: John Doe
|
|
1945
|
+
street:
|
|
1946
|
+
type: string
|
|
1947
|
+
description: First address line (usually street name and house number)
|
|
1948
|
+
maxLength: 35
|
|
1949
|
+
example: 100 West 33rd Street
|
|
1950
|
+
street2:
|
|
1951
|
+
type: string
|
|
1952
|
+
description: Second address line for further information
|
|
1953
|
+
maxLength: 35
|
|
1954
|
+
example: Apt 123
|
|
1955
|
+
zip:
|
|
1956
|
+
type: string
|
|
1957
|
+
description: Postal code of the address; is required if the country needs a postal code
|
|
1958
|
+
maxLength: 10
|
|
1959
|
+
example: '10001'
|
|
1960
|
+
city:
|
|
1961
|
+
type: string
|
|
1962
|
+
description: Name of the city
|
|
1963
|
+
maxLength: 30
|
|
1964
|
+
example: New York
|
|
1965
|
+
state:
|
|
1966
|
+
$ref: '#/definitions/StateCode'
|
|
1967
|
+
country:
|
|
1968
|
+
$ref: '#/definitions/CountryCode'
|
|
1969
|
+
phone:
|
|
1970
|
+
type: string
|
|
1971
|
+
description: Phone number
|
|
1972
|
+
maxLength: 35
|
|
1973
|
+
example: '1234567890'
|
|
1974
|
+
settings:
|
|
1975
|
+
type: object
|
|
1976
|
+
properties:
|
|
1977
|
+
email:
|
|
1978
|
+
type: string
|
|
1979
|
+
example: test@email.com
|
|
1980
|
+
description: Custom address data
|
|
1981
|
+
CreateShipmentConnection:
|
|
1982
|
+
type: object
|
|
1983
|
+
required:
|
|
1984
|
+
- connection_uuid
|
|
1985
|
+
properties:
|
|
1986
|
+
connection_uuid:
|
|
1987
|
+
type: string
|
|
1988
|
+
description: The ID of the connection to be used. Each connected e-commerce system has a Connection ID. An overview of the systems including the IDs can be found in your user account.
|
|
1989
|
+
example: c_891547f2fca547e798ba61dbf89acdde
|
|
1990
|
+
connection_item_uuid:
|
|
1991
|
+
type: string
|
|
1992
|
+
description: Your individual item ID of the shipment. Mostly corresponds to the order number in your shop. Item IDs must be unique. Required for shop / e-commerce connections, optional for API connections.
|
|
1993
|
+
example: my-unique-item-id
|
|
1994
|
+
validation_mode:
|
|
1995
|
+
type: string
|
|
1996
|
+
description: This sets the validation mode. In strict mode, each validation error (e.g. more characters than allowed) results in an error response. In lax mode, the shipment is created despite validation errors. Incorrect values are removed or shortened accordingly. The lax validation mode is intended to be able to safely import the shipments from e-commerce systems and to complete them afterwards.
|
|
1997
|
+
default: strict
|
|
1998
|
+
enum:
|
|
1999
|
+
- strict
|
|
2000
|
+
- lax
|
|
2001
|
+
example: strict
|
|
2002
|
+
connection_custom_data:
|
|
2003
|
+
$ref: '#/definitions/ConnectionCustomData'
|
|
2004
|
+
CreateShipmentDetails:
|
|
2005
|
+
type: object
|
|
2006
|
+
required:
|
|
2007
|
+
- content_description
|
|
2008
|
+
- value_amount
|
|
2009
|
+
- value_currency
|
|
2010
|
+
- email
|
|
2011
|
+
properties:
|
|
2012
|
+
value_amount:
|
|
2013
|
+
type: integer
|
|
2014
|
+
format: int32
|
|
2015
|
+
description: Goods value of the consignment; needed for the customs
|
|
2016
|
+
minimum: 1
|
|
2017
|
+
maximum: 9999999
|
|
2018
|
+
example: 200
|
|
2019
|
+
value_currency:
|
|
2020
|
+
$ref: '#/definitions/CurrencyCode'
|
|
2021
|
+
content_description:
|
|
2022
|
+
type: string
|
|
2023
|
+
description: Description of the contents of the package(s); needed for the customs
|
|
2024
|
+
maxLength: 35
|
|
2025
|
+
example: sample
|
|
2026
|
+
reference_number:
|
|
2027
|
+
type: string
|
|
2028
|
+
description: A reference text that you can use to identify your shipment, e.g. an order number of your merchandise management system. Will be printed on the shipping label in most cases.
|
|
2029
|
+
maxLength: 35
|
|
2030
|
+
example: my-reference
|
|
2031
|
+
email:
|
|
2032
|
+
type: string
|
|
2033
|
+
description: If specified, after the order has been placed, an email will be use for user registration
|
|
2034
|
+
maxLength: 254
|
|
2035
|
+
example: email@example.org
|
|
2036
|
+
email_tracking:
|
|
2037
|
+
type: string
|
|
2038
|
+
description: If specified, after the order has been placed, an email will be sent to this email address with the tracking link
|
|
2039
|
+
maxLength: 254
|
|
2040
|
+
example: email@example.org
|
|
2041
|
+
email_label_copy:
|
|
2042
|
+
type: string
|
|
2043
|
+
description: If specified, after the order has been placed, an additional email with the shipping label will be sent to this email address
|
|
2044
|
+
maxLength: 254
|
|
2045
|
+
example: email@example.org
|
|
2046
|
+
insurance_amount:
|
|
2047
|
+
type: integer
|
|
2048
|
+
format: int32
|
|
2049
|
+
description: Amount of additional insurance value
|
|
2050
|
+
minimum: 0
|
|
2051
|
+
maximum: 20000
|
|
2052
|
+
example: 200
|
|
2053
|
+
insurance_currency:
|
|
2054
|
+
$ref: '#/definitions/CurrencyCode'
|
|
2055
|
+
extra_insurance_value:
|
|
2056
|
+
type: integer
|
|
2057
|
+
description: Amount of extra insurance value
|
|
2058
|
+
example: 300
|
|
2059
|
+
extra_insurance_type:
|
|
2060
|
+
type: string
|
|
2061
|
+
description: 'Type of insurance. Possible values: standard | premium'
|
|
2062
|
+
enum:
|
|
2063
|
+
- standard
|
|
2064
|
+
- premium
|
|
2065
|
+
default: standard
|
|
2066
|
+
export_license:
|
|
2067
|
+
type: boolean
|
|
2068
|
+
description: Indicate if you need an export license and want to buy it along with the shipment
|
|
2069
|
+
packaging_type:
|
|
2070
|
+
$ref: '#/definitions/PackagingType'
|
|
2071
|
+
hs_tariff_number:
|
|
2072
|
+
type: string
|
|
2073
|
+
description: Hs number for import/export goods defining the type of the good for customs.
|
|
2074
|
+
example: '61091000'
|
|
2075
|
+
extra_export_license_number:
|
|
2076
|
+
type: string
|
|
2077
|
+
description: Extra export license number
|
|
2078
|
+
example: '4200042'
|
|
2079
|
+
settings:
|
|
2080
|
+
type: object
|
|
2081
|
+
description: Custom settings
|
|
2082
|
+
example: []
|
|
2083
|
+
CreateShipmentPackage:
|
|
2084
|
+
type: object
|
|
2085
|
+
required:
|
|
2086
|
+
- height
|
|
2087
|
+
- length
|
|
2088
|
+
- weight
|
|
2089
|
+
- width
|
|
2090
|
+
properties:
|
|
2091
|
+
weight:
|
|
2092
|
+
type: number
|
|
2093
|
+
format: float
|
|
2094
|
+
description: Weight of the package in kg
|
|
2095
|
+
minimum: 0.1
|
|
2096
|
+
maximum: 9999999
|
|
2097
|
+
example: 0.1
|
|
2098
|
+
length:
|
|
2099
|
+
type: integer
|
|
2100
|
+
format: int32
|
|
2101
|
+
description: Length of the package in cm
|
|
2102
|
+
minimum: 1
|
|
2103
|
+
maximum: 99999
|
|
2104
|
+
example: 18
|
|
2105
|
+
width:
|
|
2106
|
+
type: integer
|
|
2107
|
+
format: int32
|
|
2108
|
+
description: Width of the package in cm
|
|
2109
|
+
minimum: 1
|
|
2110
|
+
maximum: 99999
|
|
2111
|
+
example: 19
|
|
2112
|
+
height:
|
|
2113
|
+
type: integer
|
|
2114
|
+
format: int32
|
|
2115
|
+
description: Height of the package in cm
|
|
2116
|
+
minimum: 1
|
|
2117
|
+
maximum: 99999
|
|
2118
|
+
example: 20
|
|
2119
|
+
CreateShipmentRate:
|
|
2120
|
+
type: object
|
|
2121
|
+
required:
|
|
2122
|
+
- shipper_tariff_id
|
|
2123
|
+
- shipping_type
|
|
2124
|
+
- pickup_date
|
|
2125
|
+
- pickup_min_time
|
|
2126
|
+
- pickup_max_time
|
|
2127
|
+
properties:
|
|
2128
|
+
shipper_tariff_id:
|
|
2129
|
+
type: string
|
|
2130
|
+
description: The shipper tariff id
|
|
2131
|
+
example: '2'
|
|
2132
|
+
shipping_type:
|
|
2133
|
+
type: string
|
|
2134
|
+
description: The shipping type indicates whether the shipment must be delivered in a shop or picked up by a driver.
|
|
2135
|
+
enum:
|
|
2136
|
+
- pickup
|
|
2137
|
+
- shop
|
|
2138
|
+
example: pickup
|
|
2139
|
+
pickup_date:
|
|
2140
|
+
type: string
|
|
2141
|
+
format: date
|
|
2142
|
+
description: The date for which the collection was arranged.
|
|
2143
|
+
example: '2020-07-14T17:10:37Z'
|
|
2144
|
+
pickup_min_time:
|
|
2145
|
+
type: string
|
|
2146
|
+
description: The earliest time at which the shipment is picked up.
|
|
2147
|
+
example: '10:00:00'
|
|
2148
|
+
pickup_max_time:
|
|
2149
|
+
type: string
|
|
2150
|
+
description: The latest time by which the shipment is picked up.
|
|
2151
|
+
example: '18:00:00'
|
|
2152
|
+
CreateShipmentResult:
|
|
2153
|
+
type: object
|
|
2154
|
+
properties:
|
|
2155
|
+
shipment_id:
|
|
2156
|
+
type: string
|
|
2157
|
+
example: s_fb1bc92aba1c4d70a3eaa44d687ae179
|
|
2158
|
+
warnings:
|
|
2159
|
+
type: object
|
|
2160
|
+
properties:
|
|
2161
|
+
messages:
|
|
2162
|
+
type: array
|
|
2163
|
+
items:
|
|
2164
|
+
type: string
|
|
2165
|
+
example: error message
|
|
2166
|
+
count:
|
|
2167
|
+
type: integer
|
|
2168
|
+
description: Returns the shipment ID.
|
|
2169
|
+
Currency:
|
|
2170
|
+
type: string
|
|
2171
|
+
description: Currency as ISO 4217 code
|
|
2172
|
+
enum:
|
|
2173
|
+
- EUR
|
|
2174
|
+
- GBP
|
|
2175
|
+
- USD
|
|
2176
|
+
- CAD
|
|
2177
|
+
- CHF
|
|
2178
|
+
- JPY
|
|
2179
|
+
- ILS
|
|
2180
|
+
- HKD
|
|
2181
|
+
- RUB
|
|
2182
|
+
- DKK
|
|
2183
|
+
- SEK
|
|
2184
|
+
- NOK
|
|
2185
|
+
- CZK
|
|
2186
|
+
- HUF
|
|
2187
|
+
- PLN
|
|
2188
|
+
- AUD
|
|
2189
|
+
- BRL
|
|
2190
|
+
- MYR
|
|
2191
|
+
- MXN
|
|
2192
|
+
- TWD
|
|
2193
|
+
- NZD
|
|
2194
|
+
- PHP
|
|
2195
|
+
- SGD
|
|
2196
|
+
- THB
|
|
2197
|
+
CurrencyCode:
|
|
2198
|
+
type: string
|
|
2199
|
+
description: Currency as ISO 4217 code
|
|
2200
|
+
enum:
|
|
2201
|
+
- EUR
|
|
2202
|
+
- GBP
|
|
2203
|
+
- USD
|
|
2204
|
+
- CAD
|
|
2205
|
+
- CHF
|
|
2206
|
+
- JPY
|
|
2207
|
+
- ILS
|
|
2208
|
+
- HKD
|
|
2209
|
+
- RUB
|
|
2210
|
+
- DKK
|
|
2211
|
+
- SEK
|
|
2212
|
+
- NOK
|
|
2213
|
+
- CZK
|
|
2214
|
+
- HUF
|
|
2215
|
+
- PLN
|
|
2216
|
+
- AUD
|
|
2217
|
+
- BRL
|
|
2218
|
+
- MYR
|
|
2219
|
+
- MXN
|
|
2220
|
+
- TWD
|
|
2221
|
+
- NZD
|
|
2222
|
+
- PHP
|
|
2223
|
+
- SGD
|
|
2224
|
+
- THB
|
|
2225
|
+
CustomsInvoiceInput:
|
|
2226
|
+
type: object
|
|
2227
|
+
properties:
|
|
2228
|
+
invoiceNumber:
|
|
2229
|
+
type: string
|
|
2230
|
+
description: Invoice Number
|
|
2231
|
+
example: invoice_number_123
|
|
2232
|
+
invoiceDate:
|
|
2233
|
+
type: string
|
|
2234
|
+
format: date
|
|
2235
|
+
description: Invoice Date
|
|
2236
|
+
example: '2022-08-28'
|
|
2237
|
+
currency:
|
|
2238
|
+
$ref: '#/definitions/CurrencyCode'
|
|
2239
|
+
exportReason:
|
|
2240
|
+
type: string
|
|
2241
|
+
enum:
|
|
2242
|
+
- Gift
|
|
2243
|
+
- Commercial
|
|
2244
|
+
- Personal
|
|
2245
|
+
- Return
|
|
2246
|
+
- Claim
|
|
2247
|
+
- Temporary
|
|
2248
|
+
- Relocation
|
|
2249
|
+
- Sample
|
|
2250
|
+
remarks:
|
|
2251
|
+
type: array
|
|
2252
|
+
items:
|
|
2253
|
+
type: string
|
|
2254
|
+
example: NIEDERWALLSTRASSE 31
|
|
2255
|
+
description: Remarks
|
|
2256
|
+
minItems: 0
|
|
2257
|
+
maxItems: 3
|
|
2258
|
+
lineItems:
|
|
2259
|
+
type: array
|
|
2260
|
+
items:
|
|
2261
|
+
$ref: '#/definitions/CustomsLineItemInput'
|
|
2262
|
+
CustomsInvoiceOutput:
|
|
2263
|
+
type: object
|
|
2264
|
+
properties:
|
|
2265
|
+
invoiceNumber:
|
|
2266
|
+
type: string
|
|
2267
|
+
description: Invoice Number
|
|
2268
|
+
example: invoice_number_123
|
|
2269
|
+
invoiceDate:
|
|
2270
|
+
type: string
|
|
2271
|
+
format: date
|
|
2272
|
+
description: Invoice Date
|
|
2273
|
+
example: '2022-08-28'
|
|
2274
|
+
currency:
|
|
2275
|
+
$ref: '#/definitions/CurrencyCode'
|
|
2276
|
+
exportReason:
|
|
2277
|
+
type: string
|
|
2278
|
+
enum:
|
|
2279
|
+
- Gift
|
|
2280
|
+
- Commercial
|
|
2281
|
+
- Personal
|
|
2282
|
+
- Return
|
|
2283
|
+
- Claim
|
|
2284
|
+
- Temporary
|
|
2285
|
+
- Relocation
|
|
2286
|
+
- Sample
|
|
2287
|
+
remarks:
|
|
2288
|
+
type: array
|
|
2289
|
+
items:
|
|
2290
|
+
type: string
|
|
2291
|
+
example: NIEDERWALLSTRASSE 31
|
|
2292
|
+
description: Remarks
|
|
2293
|
+
minItems: 0
|
|
2294
|
+
maxItems: 3
|
|
2295
|
+
lineItems:
|
|
2296
|
+
type: array
|
|
2297
|
+
items:
|
|
2298
|
+
$ref: '#/definitions/CustomsLineItemOutput'
|
|
2299
|
+
CustomsLineItemInput:
|
|
2300
|
+
type: object
|
|
2301
|
+
properties:
|
|
2302
|
+
content:
|
|
2303
|
+
type: string
|
|
2304
|
+
description: Shipment content
|
|
2305
|
+
example: T-Shirts
|
|
2306
|
+
quantity:
|
|
2307
|
+
type: integer
|
|
2308
|
+
description: Quantity of items
|
|
2309
|
+
example: 12
|
|
2310
|
+
unitOfMeasurement:
|
|
2311
|
+
type: string
|
|
2312
|
+
description: Unit Of Measurement
|
|
2313
|
+
enum:
|
|
2314
|
+
- PCS
|
|
2315
|
+
- M
|
|
2316
|
+
- M2
|
|
2317
|
+
- M3
|
|
2318
|
+
- L
|
|
2319
|
+
- KG
|
|
2320
|
+
netWeight:
|
|
2321
|
+
type: number
|
|
2322
|
+
format: float
|
|
2323
|
+
description: Gross Weight
|
|
2324
|
+
example: 15.5
|
|
2325
|
+
value:
|
|
2326
|
+
type: number
|
|
2327
|
+
format: float
|
|
2328
|
+
description: Shipment value
|
|
2329
|
+
example: 155.5
|
|
2330
|
+
hsTariffNumber:
|
|
2331
|
+
type: string
|
|
2332
|
+
description: hsTariffNumber
|
|
2333
|
+
example: '61091000'
|
|
2334
|
+
manufacturingCountry:
|
|
2335
|
+
$ref: '#/definitions/CountryCode'
|
|
2336
|
+
CustomsLineItemOutput:
|
|
2337
|
+
type: object
|
|
2338
|
+
properties:
|
|
2339
|
+
id:
|
|
2340
|
+
type: integer
|
|
2341
|
+
description: ID
|
|
2342
|
+
example: 12
|
|
2343
|
+
content:
|
|
2344
|
+
type: string
|
|
2345
|
+
description: Shipment content
|
|
2346
|
+
example: T-Shirts
|
|
2347
|
+
quantity:
|
|
2348
|
+
type: integer
|
|
2349
|
+
description: Quantity of items
|
|
2350
|
+
example: 12
|
|
2351
|
+
unitOfMeasurement:
|
|
2352
|
+
type: string
|
|
2353
|
+
description: Unit Of Measurement
|
|
2354
|
+
enum:
|
|
2355
|
+
- PCS
|
|
2356
|
+
- M
|
|
2357
|
+
- M2
|
|
2358
|
+
- M3
|
|
2359
|
+
- L
|
|
2360
|
+
- KG
|
|
2361
|
+
netWeight:
|
|
2362
|
+
type: number
|
|
2363
|
+
format: float
|
|
2364
|
+
description: Gross Weight
|
|
2365
|
+
example: 15.5
|
|
2366
|
+
value:
|
|
2367
|
+
type: number
|
|
2368
|
+
format: float
|
|
2369
|
+
description: Shipment value
|
|
2370
|
+
example: 155.5
|
|
2371
|
+
hsTariffNumber:
|
|
2372
|
+
type: string
|
|
2373
|
+
description: hsTariffNumber
|
|
2374
|
+
example: '61091000'
|
|
2375
|
+
manufacturingCountry:
|
|
2376
|
+
$ref: '#/definitions/CountryCode'
|
|
2377
|
+
Error:
|
|
2378
|
+
type: object
|
|
2379
|
+
required:
|
|
2380
|
+
- code
|
|
2381
|
+
- message
|
|
2382
|
+
properties:
|
|
2383
|
+
message:
|
|
2384
|
+
type: string
|
|
2385
|
+
example: Required value for "name" is missing (empty value is not allowed).
|
|
2386
|
+
code:
|
|
2387
|
+
type: integer
|
|
2388
|
+
format: int32
|
|
2389
|
+
example: 1009
|
|
2390
|
+
description: An error code and an error message with further information are provided.
|
|
2391
|
+
ErrorResponse:
|
|
2392
|
+
type: object
|
|
2393
|
+
required:
|
|
2394
|
+
- error
|
|
2395
|
+
properties:
|
|
2396
|
+
title:
|
|
2397
|
+
type: string
|
|
2398
|
+
example: An error occurred
|
|
2399
|
+
description: Title of the error message
|
|
2400
|
+
detail:
|
|
2401
|
+
type: string
|
|
2402
|
+
description: Details of the error message
|
|
2403
|
+
violations:
|
|
2404
|
+
type: array
|
|
2405
|
+
items:
|
|
2406
|
+
$ref: '#/definitions/Error'
|
|
2407
|
+
description: Every error response should contain an error object.
|
|
2408
|
+
Exception:
|
|
2409
|
+
type: object
|
|
2410
|
+
properties:
|
|
2411
|
+
title:
|
|
2412
|
+
type: string
|
|
2413
|
+
example: An error occurred
|
|
2414
|
+
detail:
|
|
2415
|
+
type: string
|
|
2416
|
+
example: No result was found for query although at least one row was expected
|
|
2417
|
+
description: Exception response.
|
|
2418
|
+
Insurance:
|
|
2419
|
+
type: object
|
|
2420
|
+
properties:
|
|
2421
|
+
percent:
|
|
2422
|
+
type: integer
|
|
2423
|
+
description: Percent of insurance
|
|
2424
|
+
example: 1
|
|
2425
|
+
min:
|
|
2426
|
+
type: number
|
|
2427
|
+
format: float
|
|
2428
|
+
description: Min amount
|
|
2429
|
+
example: 3.99
|
|
2430
|
+
minGross:
|
|
2431
|
+
type: number
|
|
2432
|
+
format: float
|
|
2433
|
+
description: Min amount gross
|
|
2434
|
+
example: 3.99
|
|
2435
|
+
InvoiceDocument:
|
|
2436
|
+
type: object
|
|
2437
|
+
properties:
|
|
2438
|
+
name:
|
|
2439
|
+
type: string
|
|
2440
|
+
description: Document name
|
|
2441
|
+
example: R-200206200544.pdf
|
|
2442
|
+
type:
|
|
2443
|
+
type: string
|
|
2444
|
+
description: Type of document
|
|
2445
|
+
example: invoice
|
|
2446
|
+
reference:
|
|
2447
|
+
type: string
|
|
2448
|
+
description: Reference
|
|
2449
|
+
example: 200206200544
|
|
2450
|
+
file:
|
|
2451
|
+
type: string
|
|
2452
|
+
description: Base64 file content
|
|
2453
|
+
LabelDocument:
|
|
2454
|
+
type: object
|
|
2455
|
+
properties:
|
|
2456
|
+
name:
|
|
2457
|
+
type: string
|
|
2458
|
+
description: Document name
|
|
2459
|
+
example: L-200206AJ75-1.pdf
|
|
2460
|
+
type:
|
|
2461
|
+
type: string
|
|
2462
|
+
description: Type of document
|
|
2463
|
+
example: label
|
|
2464
|
+
reference:
|
|
2465
|
+
type: string
|
|
2466
|
+
description: Reference
|
|
2467
|
+
example: 200206AJ75-1
|
|
2468
|
+
file:
|
|
2469
|
+
type: string
|
|
2470
|
+
description: Base64 file content
|
|
2471
|
+
OrdersOutput:
|
|
2472
|
+
type: object
|
|
2473
|
+
properties:
|
|
2474
|
+
orderNumber:
|
|
2475
|
+
type: string
|
|
2476
|
+
description: Order number
|
|
2477
|
+
example: 200206OM6Y
|
|
2478
|
+
customer:
|
|
2479
|
+
type: object
|
|
2480
|
+
properties:
|
|
2481
|
+
customerNumber:
|
|
2482
|
+
type: integer
|
|
2483
|
+
description: Customer number
|
|
2484
|
+
example: 100001
|
|
2485
|
+
paymentMethod:
|
|
2486
|
+
type: string
|
|
2487
|
+
description: Order payment method
|
|
2488
|
+
example: bill
|
|
2489
|
+
accountOwner:
|
|
2490
|
+
type: string
|
|
2491
|
+
description: Account Owner
|
|
2492
|
+
example: Owner
|
|
2493
|
+
iban:
|
|
2494
|
+
type: string
|
|
2495
|
+
description: International Bank Account Number (IBAN)
|
|
2496
|
+
example: SE35 5000 0000 0549 1000 0003
|
|
2497
|
+
bic:
|
|
2498
|
+
type: string
|
|
2499
|
+
description: Business Identifier Code (BIC)
|
|
2500
|
+
example: BARCGB22XXX
|
|
2501
|
+
lastschriftmandat:
|
|
2502
|
+
type: string
|
|
2503
|
+
description: Lastschrift mandatory
|
|
2504
|
+
example: ''
|
|
2505
|
+
paypalEmail:
|
|
2506
|
+
type: string
|
|
2507
|
+
description: PayPal email
|
|
2508
|
+
example: user@mail.com
|
|
2509
|
+
paypalTransactionId:
|
|
2510
|
+
type: string
|
|
2511
|
+
description: PayPal transaction id
|
|
2512
|
+
example: VADE0B248932
|
|
2513
|
+
paypalPuiReferenceNumber:
|
|
2514
|
+
type: string
|
|
2515
|
+
description: PayPal Pay upon Invoice (PUI) reference number
|
|
2516
|
+
example: VADE0B248932
|
|
2517
|
+
paypalPuiBankName:
|
|
2518
|
+
type: string
|
|
2519
|
+
description: PayPal Pay upon Invoice (PUI) Bank name
|
|
2520
|
+
example: Bank
|
|
2521
|
+
paypalPuiAccountHolderName:
|
|
2522
|
+
type: string
|
|
2523
|
+
description: PayPal Pay upon Invoice (PUI) holder name
|
|
2524
|
+
example: Dou John
|
|
2525
|
+
paypalPuiInternationalBankAccountNumber:
|
|
2526
|
+
type: string
|
|
2527
|
+
description: PayPal Pay upon Invoice (PUI) Banck number
|
|
2528
|
+
example: VADE0B123545
|
|
2529
|
+
paypalPuiBankIdentifierCode:
|
|
2530
|
+
type: string
|
|
2531
|
+
description: PayPal Pay upon Invoice (PUI) Banck number
|
|
2532
|
+
example: VADE0B123545
|
|
2533
|
+
paypalPuiValue:
|
|
2534
|
+
type: string
|
|
2535
|
+
description: PayPal Pay upon Invoice (PUI) amount
|
|
2536
|
+
example: 22.3
|
|
2537
|
+
paypalPuiCurrency:
|
|
2538
|
+
type: string
|
|
2539
|
+
description: PayPal Pay upon Invoice (PUI) currency
|
|
2540
|
+
example: EUR
|
|
2541
|
+
paypalPuiPaymentDueDate:
|
|
2542
|
+
type: string
|
|
2543
|
+
format: date-time
|
|
2544
|
+
description: PayPal Pay upon Invoice (PUI) due date
|
|
2545
|
+
example: '2020-06-30T12:52:03Z'
|
|
2546
|
+
sofortTransactionId:
|
|
2547
|
+
type: string
|
|
2548
|
+
description: Sofort transaction id
|
|
2549
|
+
example: UR55578852
|
|
2550
|
+
paymentTransactionId:
|
|
2551
|
+
type: string
|
|
2552
|
+
description: Payment transaction id
|
|
2553
|
+
example: UR55578852
|
|
2554
|
+
paymentCreditcardNumber:
|
|
2555
|
+
type: string
|
|
2556
|
+
description: Payment credit card number
|
|
2557
|
+
example: 5362 0000 0000 0003
|
|
2558
|
+
paymentData:
|
|
2559
|
+
type: string
|
|
2560
|
+
description: Payment data
|
|
2561
|
+
example: Payment data
|
|
2562
|
+
taxNet:
|
|
2563
|
+
type: number
|
|
2564
|
+
format: float
|
|
2565
|
+
description: Invoice tax netto
|
|
2566
|
+
example: 183.66
|
|
2567
|
+
taxFreeNet:
|
|
2568
|
+
type: number
|
|
2569
|
+
format: float
|
|
2570
|
+
description: Invoice tax free netto
|
|
2571
|
+
example: 0
|
|
2572
|
+
tax:
|
|
2573
|
+
type: number
|
|
2574
|
+
format: float
|
|
2575
|
+
description: Tax amount
|
|
2576
|
+
example: 34.9
|
|
2577
|
+
taxes:
|
|
2578
|
+
type: object
|
|
2579
|
+
properties:
|
|
2580
|
+
DE:
|
|
2581
|
+
type: object
|
|
2582
|
+
description: Country code
|
|
2583
|
+
properties:
|
|
2584
|
+
tax_name:
|
|
2585
|
+
type: string
|
|
2586
|
+
example: MwSt.
|
|
2587
|
+
tax_countryCode:
|
|
2588
|
+
$ref: '#/definitions/CountryCode'
|
|
2589
|
+
tax_rate:
|
|
2590
|
+
type: number
|
|
2591
|
+
format: float
|
|
2592
|
+
example: 19
|
|
2593
|
+
tax_id:
|
|
2594
|
+
type: integer
|
|
2595
|
+
example: 1
|
|
2596
|
+
tax_amount:
|
|
2597
|
+
type: number
|
|
2598
|
+
format: float
|
|
2599
|
+
example: 2.82
|
|
2600
|
+
gross:
|
|
2601
|
+
type: number
|
|
2602
|
+
format: float
|
|
2603
|
+
description: Invoice amount gross
|
|
2604
|
+
example: 218.56
|
|
2605
|
+
paymentReceipt:
|
|
2606
|
+
type: string
|
|
2607
|
+
description: Payment receipt
|
|
2608
|
+
example: ''
|
|
2609
|
+
paymentDate:
|
|
2610
|
+
type: string
|
|
2611
|
+
format: date-time
|
|
2612
|
+
description: Payment date
|
|
2613
|
+
example: '2020-06-30T12:52:03Z'
|
|
2614
|
+
voucherCode:
|
|
2615
|
+
type: string
|
|
2616
|
+
description: Voucher code
|
|
2617
|
+
example: ED455DF44541
|
|
2618
|
+
voucherValue:
|
|
2619
|
+
type: number
|
|
2620
|
+
format: float
|
|
2621
|
+
description: Voucher value
|
|
2622
|
+
example: 0
|
|
2623
|
+
voucherPercent:
|
|
2624
|
+
type: number
|
|
2625
|
+
format: float
|
|
2626
|
+
description: Voucher value
|
|
2627
|
+
example: 0
|
|
2628
|
+
voucherType:
|
|
2629
|
+
type: string
|
|
2630
|
+
description: Voucher type
|
|
2631
|
+
example: Discount
|
|
2632
|
+
subtotal:
|
|
2633
|
+
type: number
|
|
2634
|
+
format: float
|
|
2635
|
+
description: Sub total of order
|
|
2636
|
+
example: 16.64
|
|
2637
|
+
discountPercent:
|
|
2638
|
+
type: number
|
|
2639
|
+
format: float
|
|
2640
|
+
description: Discount of percent
|
|
2641
|
+
example: 0
|
|
2642
|
+
currency:
|
|
2643
|
+
type: string
|
|
2644
|
+
description: Currency
|
|
2645
|
+
example: EUR
|
|
2646
|
+
currencyDetails:
|
|
2647
|
+
type: array
|
|
2648
|
+
items:
|
|
2649
|
+
type: string
|
|
2650
|
+
created:
|
|
2651
|
+
type: string
|
|
2652
|
+
format: date-time
|
|
2653
|
+
description: Payment date
|
|
2654
|
+
example: '2020-06-30T12:52:03Z'
|
|
2655
|
+
surcharges:
|
|
2656
|
+
type: number
|
|
2657
|
+
format: float
|
|
2658
|
+
description: Additional charges
|
|
2659
|
+
example: 1.53
|
|
2660
|
+
paymentSurcharge:
|
|
2661
|
+
type: number
|
|
2662
|
+
format: float
|
|
2663
|
+
description: Additional payment charge
|
|
2664
|
+
example: 2.02
|
|
2665
|
+
shipments:
|
|
2666
|
+
type: array
|
|
2667
|
+
items:
|
|
2668
|
+
type: object
|
|
2669
|
+
properties:
|
|
2670
|
+
id:
|
|
2671
|
+
type: integer
|
|
2672
|
+
format: int32
|
|
2673
|
+
description: Id of shipment entity
|
|
2674
|
+
example: 1
|
|
2675
|
+
orderShipmentNumber:
|
|
2676
|
+
type: string
|
|
2677
|
+
description: Shipment number
|
|
2678
|
+
example: 200206OM6Y
|
|
2679
|
+
shipmentContent:
|
|
2680
|
+
type: string
|
|
2681
|
+
description: Shipment content
|
|
2682
|
+
example: Content description
|
|
2683
|
+
shipmentValue:
|
|
2684
|
+
type: integer
|
|
2685
|
+
description: Shipment value
|
|
2686
|
+
example: 112
|
|
2687
|
+
trackingNumber:
|
|
2688
|
+
type: string
|
|
2689
|
+
description: Tracking number
|
|
2690
|
+
example: 3384339954
|
|
2691
|
+
unpaid:
|
|
2692
|
+
type: boolean
|
|
2693
|
+
description: Status of order
|
|
2694
|
+
cancelOrderLink:
|
|
2695
|
+
type: string
|
|
2696
|
+
description: FYQ link with info how to cansel order
|
|
2697
|
+
example: 2/94
|
|
2698
|
+
documents:
|
|
2699
|
+
$ref: '#/definitions/OrderDocuments'
|
|
2700
|
+
OrdersPostInput:
|
|
2701
|
+
type: object
|
|
2702
|
+
required:
|
|
2703
|
+
- paymentMethod
|
|
2704
|
+
- shipmentIds
|
|
2705
|
+
properties:
|
|
2706
|
+
shipmentIds:
|
|
2707
|
+
type: array
|
|
2708
|
+
description: array of shipmens ids
|
|
2709
|
+
items:
|
|
2710
|
+
type: string
|
|
2711
|
+
method:
|
|
2712
|
+
type: string
|
|
2713
|
+
example: lastschrift
|
|
2714
|
+
voucherCode:
|
|
2715
|
+
type: string
|
|
2716
|
+
description: The voucher code
|
|
2717
|
+
example: jum100
|
|
2718
|
+
data:
|
|
2719
|
+
type: object
|
|
2720
|
+
properties:
|
|
2721
|
+
accountOwner:
|
|
2722
|
+
type: string
|
|
2723
|
+
description: Payment method additianal data
|
|
2724
|
+
OrdersPostOutput:
|
|
2725
|
+
type: object
|
|
2726
|
+
required:
|
|
2727
|
+
- success
|
|
2728
|
+
properties:
|
|
2729
|
+
orderNumber:
|
|
2730
|
+
type: string
|
|
2731
|
+
description: Order number formated
|
|
2732
|
+
example: 200525TLDC
|
|
2733
|
+
success:
|
|
2734
|
+
type: boolean
|
|
2735
|
+
description: Payment status
|
|
2736
|
+
token:
|
|
2737
|
+
type: string
|
|
2738
|
+
description: Token for using in requests
|
|
2739
|
+
returnUrl:
|
|
2740
|
+
type: string
|
|
2741
|
+
description: Url for user redirect
|
|
2742
|
+
hadOrderBefore:
|
|
2743
|
+
type: boolean
|
|
2744
|
+
description: It is true if this user has paid orders except current
|
|
2745
|
+
OrderAggregatedData:
|
|
2746
|
+
type: object
|
|
2747
|
+
properties:
|
|
2748
|
+
daysSinceLastOrder:
|
|
2749
|
+
type: integer
|
|
2750
|
+
description: The blog article id
|
|
2751
|
+
example: 21
|
|
2752
|
+
totalOrdersCount:
|
|
2753
|
+
type: integer
|
|
2754
|
+
description: The blog article url
|
|
2755
|
+
example: 22
|
|
2756
|
+
totalOrdersValue:
|
|
2757
|
+
type: number
|
|
2758
|
+
format: float
|
|
2759
|
+
description: Total user orders value
|
|
2760
|
+
example: 9155.28
|
|
2761
|
+
averageOrdersValue:
|
|
2762
|
+
type: number
|
|
2763
|
+
format: float
|
|
2764
|
+
description: Average user orders value
|
|
2765
|
+
example: 155.28
|
|
2766
|
+
OrderDocuments:
|
|
2767
|
+
type: object
|
|
2768
|
+
properties:
|
|
2769
|
+
id:
|
|
2770
|
+
type: string
|
|
2771
|
+
description: Order number
|
|
2772
|
+
example: 200206OM6Y
|
|
2773
|
+
invoicesCount:
|
|
2774
|
+
type: integer
|
|
2775
|
+
description: Expected invoices count
|
|
2776
|
+
example: 1
|
|
2777
|
+
proformasCount:
|
|
2778
|
+
type: integer
|
|
2779
|
+
description: Expected proformas count
|
|
2780
|
+
example: 1
|
|
2781
|
+
confirmationsCount:
|
|
2782
|
+
type: integer
|
|
2783
|
+
description: Expected order confirmations count
|
|
2784
|
+
example: 1
|
|
2785
|
+
invoices:
|
|
2786
|
+
type: array
|
|
2787
|
+
items:
|
|
2788
|
+
$ref: '#/definitions/InvoiceDocument'
|
|
2789
|
+
confirmations:
|
|
2790
|
+
type: array
|
|
2791
|
+
items:
|
|
2792
|
+
$ref: '#/definitions/ConfirmationDocument'
|
|
2793
|
+
proformas:
|
|
2794
|
+
type: array
|
|
2795
|
+
items:
|
|
2796
|
+
$ref: '#/definitions/ProformaDocument'
|
|
2797
|
+
labels:
|
|
2798
|
+
type: array
|
|
2799
|
+
items:
|
|
2800
|
+
$ref: '#/definitions/LabelDocument'
|
|
2801
|
+
commercialInvoices:
|
|
2802
|
+
type: array
|
|
2803
|
+
items:
|
|
2804
|
+
$ref: '#/definitions/ShipmentFileDocument'
|
|
2805
|
+
exportDeclarations:
|
|
2806
|
+
type: array
|
|
2807
|
+
items:
|
|
2808
|
+
$ref: '#/definitions/ShipmentFileDocument'
|
|
2809
|
+
OrderOutput:
|
|
2810
|
+
type: object
|
|
2811
|
+
properties:
|
|
2812
|
+
orderNumber:
|
|
2813
|
+
type: string
|
|
2814
|
+
description: Order number
|
|
2815
|
+
example: 200206OM6Y
|
|
2816
|
+
customer:
|
|
2817
|
+
type: object
|
|
2818
|
+
properties:
|
|
2819
|
+
customerNumber:
|
|
2820
|
+
type: integer
|
|
2821
|
+
description: Customer number
|
|
2822
|
+
example: 100001
|
|
2823
|
+
paymentMethod:
|
|
2824
|
+
type: string
|
|
2825
|
+
description: Order payment method
|
|
2826
|
+
example: bill
|
|
2827
|
+
accountOwner:
|
|
2828
|
+
type: string
|
|
2829
|
+
description: Account Owner
|
|
2830
|
+
example: Owner
|
|
2831
|
+
iban:
|
|
2832
|
+
type: string
|
|
2833
|
+
description: International Bank Account Number (IBAN)
|
|
2834
|
+
example: SE35 5000 0000 0549 1000 0003
|
|
2835
|
+
bic:
|
|
2836
|
+
type: string
|
|
2837
|
+
description: Business Identifier Code (BIC)
|
|
2838
|
+
example: BARCGB22XXX
|
|
2839
|
+
lastschriftmandat:
|
|
2840
|
+
type: string
|
|
2841
|
+
description: Lastschrift mandatory
|
|
2842
|
+
example: ''
|
|
2843
|
+
paypalEmail:
|
|
2844
|
+
type: string
|
|
2845
|
+
description: PayPal email
|
|
2846
|
+
example: user@mail.com
|
|
2847
|
+
paypalTransactionId:
|
|
2848
|
+
type: string
|
|
2849
|
+
description: PayPal transaction id
|
|
2850
|
+
example: VADE0B248932
|
|
2851
|
+
paypalPuiReferenceNumber:
|
|
2852
|
+
type: string
|
|
2853
|
+
description: PayPal Pay upon Invoice (PUI) reference number
|
|
2854
|
+
example: VADE0B248932
|
|
2855
|
+
paypalPuiBankName:
|
|
2856
|
+
type: string
|
|
2857
|
+
description: PayPal Pay upon Invoice (PUI) Bank name
|
|
2858
|
+
example: Bank
|
|
2859
|
+
paypalPuiAccountHolderName:
|
|
2860
|
+
type: string
|
|
2861
|
+
description: PayPal Pay upon Invoice (PUI) holder name
|
|
2862
|
+
example: Dou John
|
|
2863
|
+
paypalPuiInternationalBankAccountNumber:
|
|
2864
|
+
type: string
|
|
2865
|
+
description: PayPal Pay upon Invoice (PUI) Banck number
|
|
2866
|
+
example: VADE0B123545
|
|
2867
|
+
paypalPuiBankIdentifierCode:
|
|
2868
|
+
type: string
|
|
2869
|
+
description: PayPal Pay upon Invoice (PUI) Banck number
|
|
2870
|
+
example: VADE0B123545
|
|
2871
|
+
paypalPuiValue:
|
|
2872
|
+
type: string
|
|
2873
|
+
description: PayPal Pay upon Invoice (PUI) amount
|
|
2874
|
+
example: 22.3
|
|
2875
|
+
paypalPuiCurrency:
|
|
2876
|
+
type: string
|
|
2877
|
+
description: PayPal Pay upon Invoice (PUI) currency
|
|
2878
|
+
example: EUR
|
|
2879
|
+
paypalPuiPaymentDueDate:
|
|
2880
|
+
type: string
|
|
2881
|
+
format: date-time
|
|
2882
|
+
description: PayPal Pay upon Invoice (PUI) due date
|
|
2883
|
+
example: '2020-06-30T12:52:03Z'
|
|
2884
|
+
sofortTransactionId:
|
|
2885
|
+
type: string
|
|
2886
|
+
description: Sofort transaction id
|
|
2887
|
+
example: UR55578852
|
|
2888
|
+
paymentTransactionId:
|
|
2889
|
+
type: string
|
|
2890
|
+
description: Payment transaction id
|
|
2891
|
+
example: UR55578852
|
|
2892
|
+
paymentCreditcardNumber:
|
|
2893
|
+
type: string
|
|
2894
|
+
description: Payment credit card number
|
|
2895
|
+
example: 5362 0000 0000 0003
|
|
2896
|
+
paymentData:
|
|
2897
|
+
type: string
|
|
2898
|
+
description: Payment data
|
|
2899
|
+
example: Payment data
|
|
2900
|
+
taxNet:
|
|
2901
|
+
type: number
|
|
2902
|
+
format: float
|
|
2903
|
+
description: Invoice tax netto
|
|
2904
|
+
example: 183.66
|
|
2905
|
+
taxFreeNet:
|
|
2906
|
+
type: number
|
|
2907
|
+
format: float
|
|
2908
|
+
description: Invoice tax free netto
|
|
2909
|
+
example: 0
|
|
2910
|
+
tax:
|
|
2911
|
+
type: number
|
|
2912
|
+
format: float
|
|
2913
|
+
description: Tax amount
|
|
2914
|
+
example: 34.9
|
|
2915
|
+
taxes:
|
|
2916
|
+
type: object
|
|
2917
|
+
properties:
|
|
2918
|
+
DE:
|
|
2919
|
+
type: object
|
|
2920
|
+
description: Country code
|
|
2921
|
+
properties:
|
|
2922
|
+
tax_name:
|
|
2923
|
+
type: string
|
|
2924
|
+
example: MwSt.
|
|
2925
|
+
tax_countryCode:
|
|
2926
|
+
$ref: '#/definitions/CountryCode'
|
|
2927
|
+
tax_rate:
|
|
2928
|
+
type: number
|
|
2929
|
+
format: float
|
|
2930
|
+
example: 19
|
|
2931
|
+
tax_id:
|
|
2932
|
+
type: integer
|
|
2933
|
+
example: 1
|
|
2934
|
+
tax_amount:
|
|
2935
|
+
type: number
|
|
2936
|
+
format: float
|
|
2937
|
+
example: 2.82
|
|
2938
|
+
gross:
|
|
2939
|
+
type: number
|
|
2940
|
+
format: float
|
|
2941
|
+
description: Invoice amount gross
|
|
2942
|
+
example: 218.56
|
|
2943
|
+
paymentReceipt:
|
|
2944
|
+
type: string
|
|
2945
|
+
description: Payment receipt
|
|
2946
|
+
example: ''
|
|
2947
|
+
paymentDate:
|
|
2948
|
+
type: string
|
|
2949
|
+
format: date-time
|
|
2950
|
+
description: Payment date
|
|
2951
|
+
example: '2020-06-30T12:52:03Z'
|
|
2952
|
+
voucherCode:
|
|
2953
|
+
type: string
|
|
2954
|
+
description: Voucher code
|
|
2955
|
+
example: ED455DF44541
|
|
2956
|
+
voucherValue:
|
|
2957
|
+
type: number
|
|
2958
|
+
format: float
|
|
2959
|
+
description: Voucher value
|
|
2960
|
+
example: 0
|
|
2961
|
+
voucherPercent:
|
|
2962
|
+
type: number
|
|
2963
|
+
format: float
|
|
2964
|
+
description: Voucher value
|
|
2965
|
+
example: 0
|
|
2966
|
+
voucherType:
|
|
2967
|
+
type: string
|
|
2968
|
+
description: Voucher type
|
|
2969
|
+
example: Discount
|
|
2970
|
+
subtotal:
|
|
2971
|
+
type: number
|
|
2972
|
+
format: float
|
|
2973
|
+
description: Sub total of order
|
|
2974
|
+
example: 16.64
|
|
2975
|
+
discountPercent:
|
|
2976
|
+
type: number
|
|
2977
|
+
format: float
|
|
2978
|
+
description: Discount of percent
|
|
2979
|
+
example: 0
|
|
2980
|
+
currency:
|
|
2981
|
+
type: string
|
|
2982
|
+
description: Currency
|
|
2983
|
+
example: EUR
|
|
2984
|
+
currencyDetails:
|
|
2985
|
+
type: array
|
|
2986
|
+
items:
|
|
2987
|
+
type: string
|
|
2988
|
+
created:
|
|
2989
|
+
type: string
|
|
2990
|
+
format: date-time
|
|
2991
|
+
description: Payment date
|
|
2992
|
+
example: '2020-06-30T12:52:03Z'
|
|
2993
|
+
surcharges:
|
|
2994
|
+
type: number
|
|
2995
|
+
format: float
|
|
2996
|
+
description: Additional charges
|
|
2997
|
+
example: 1.53
|
|
2998
|
+
aggregatedData:
|
|
2999
|
+
$ref: '#/definitions/OrderAggregatedData'
|
|
3000
|
+
paymentSurcharge:
|
|
3001
|
+
type: number
|
|
3002
|
+
format: float
|
|
3003
|
+
description: Additional payment charge
|
|
3004
|
+
example: 2.02
|
|
3005
|
+
shipments:
|
|
3006
|
+
type: array
|
|
3007
|
+
items:
|
|
3008
|
+
type: object
|
|
3009
|
+
properties:
|
|
3010
|
+
id:
|
|
3011
|
+
type: integer
|
|
3012
|
+
format: int32
|
|
3013
|
+
description: Id of shipment entity
|
|
3014
|
+
example: 1
|
|
3015
|
+
orderShipmentNumber:
|
|
3016
|
+
type: string
|
|
3017
|
+
description: Shipment number
|
|
3018
|
+
example: 200206OM6Y
|
|
3019
|
+
shipmentContent:
|
|
3020
|
+
type: string
|
|
3021
|
+
description: Shipment content
|
|
3022
|
+
example: Content description
|
|
3023
|
+
shipmentValue:
|
|
3024
|
+
type: integer
|
|
3025
|
+
description: Shipment value
|
|
3026
|
+
example: 112
|
|
3027
|
+
trackingNumber:
|
|
3028
|
+
type: string
|
|
3029
|
+
description: Tracking number
|
|
3030
|
+
example: 3384339954
|
|
3031
|
+
unpaid:
|
|
3032
|
+
type: boolean
|
|
3033
|
+
description: Status of order
|
|
3034
|
+
cancelOrderLink:
|
|
3035
|
+
type: string
|
|
3036
|
+
description: FYQ link with info how to cansel order
|
|
3037
|
+
example: 2/94
|
|
3038
|
+
documents:
|
|
3039
|
+
$ref: '#/definitions/OrderDocuments'
|
|
3040
|
+
dates:
|
|
3041
|
+
type: array
|
|
3042
|
+
items:
|
|
3043
|
+
type: object
|
|
3044
|
+
description: 'The key of item is name of the date. For example: "created" or "paymentDate"'
|
|
3045
|
+
properties:
|
|
3046
|
+
date:
|
|
3047
|
+
type: string
|
|
3048
|
+
description: Date in Y-m-d format
|
|
3049
|
+
example: '2020-02-06'
|
|
3050
|
+
time:
|
|
3051
|
+
type: string
|
|
3052
|
+
description: Time in H:i:s format
|
|
3053
|
+
example: '14:21:28'
|
|
3054
|
+
PackageType:
|
|
3055
|
+
type: object
|
|
3056
|
+
properties:
|
|
3057
|
+
id:
|
|
3058
|
+
type: integer
|
|
3059
|
+
description: Package id
|
|
3060
|
+
example: 1
|
|
3061
|
+
name:
|
|
3062
|
+
type: string
|
|
3063
|
+
description: Package name
|
|
3064
|
+
example: Paket
|
|
3065
|
+
description:
|
|
3066
|
+
type: object
|
|
3067
|
+
properties:
|
|
3068
|
+
name:
|
|
3069
|
+
type: string
|
|
3070
|
+
description: Deep explanation of package name
|
|
3071
|
+
example: Paket
|
|
3072
|
+
description:
|
|
3073
|
+
type: string
|
|
3074
|
+
description: Description of package
|
|
3075
|
+
example: <p>Ein normaler quaderförmiger Karton, der stapelbar ist.</p>
|
|
3076
|
+
machineName:
|
|
3077
|
+
$ref: '#/definitions/PackagingType'
|
|
3078
|
+
PackagingType:
|
|
3079
|
+
type: string
|
|
3080
|
+
description: Specifies the type of packaging of the packages
|
|
3081
|
+
enum:
|
|
3082
|
+
- parcel
|
|
3083
|
+
- document
|
|
3084
|
+
- bulk
|
|
3085
|
+
- pallet
|
|
3086
|
+
- tires
|
|
3087
|
+
- suitcase
|
|
3088
|
+
default: parcel
|
|
3089
|
+
PaymentMethodsOutput:
|
|
3090
|
+
type: object
|
|
3091
|
+
required:
|
|
3092
|
+
- name
|
|
3093
|
+
- additionalData
|
|
3094
|
+
properties:
|
|
3095
|
+
name:
|
|
3096
|
+
type: string
|
|
3097
|
+
description: Payment method name
|
|
3098
|
+
example: bill
|
|
3099
|
+
additionalData:
|
|
3100
|
+
type: array
|
|
3101
|
+
items:
|
|
3102
|
+
type: string
|
|
3103
|
+
description: Payment method additianal data
|
|
3104
|
+
ProformaDocument:
|
|
3105
|
+
type: object
|
|
3106
|
+
properties:
|
|
3107
|
+
name:
|
|
3108
|
+
type: string
|
|
3109
|
+
description: Document name
|
|
3110
|
+
example: P-200206AJ75-1.pdf
|
|
3111
|
+
type:
|
|
3112
|
+
type: string
|
|
3113
|
+
description: Type of document
|
|
3114
|
+
example: proforma
|
|
3115
|
+
reference:
|
|
3116
|
+
type: string
|
|
3117
|
+
description: Reference
|
|
3118
|
+
example: 200206AJ75-1
|
|
3119
|
+
file:
|
|
3120
|
+
type: string
|
|
3121
|
+
description: Base64 file content
|
|
3122
|
+
Shipment:
|
|
3123
|
+
type: object
|
|
3124
|
+
properties:
|
|
3125
|
+
id:
|
|
3126
|
+
type: string
|
|
3127
|
+
description: The unique ID of the shipment
|
|
3128
|
+
example: s_c6aa551badab4223a75da01316ce0752
|
|
3129
|
+
customer_number:
|
|
3130
|
+
type: integer
|
|
3131
|
+
format: int32
|
|
3132
|
+
description: Your customer number
|
|
3133
|
+
example: 920119
|
|
3134
|
+
customer_personal_name:
|
|
3135
|
+
type: string
|
|
3136
|
+
description: Your personal name, it's allowed only if you are a team member
|
|
3137
|
+
example: John Doe
|
|
3138
|
+
created:
|
|
3139
|
+
type: string
|
|
3140
|
+
format: date-time
|
|
3141
|
+
description: Creation date of the shipment
|
|
3142
|
+
example: '2018-07-14T17:08:29Z'
|
|
3143
|
+
last_modified:
|
|
3144
|
+
type: string
|
|
3145
|
+
format: date-time
|
|
3146
|
+
description: Date on which the shipment was last modified
|
|
3147
|
+
example: '2018-07-14T17:10:37Z'
|
|
3148
|
+
status:
|
|
3149
|
+
type: string
|
|
3150
|
+
description: The processing status of the shipment
|
|
3151
|
+
enum:
|
|
3152
|
+
- missing_data
|
|
3153
|
+
- ready
|
|
3154
|
+
- completed
|
|
3155
|
+
- in_transit
|
|
3156
|
+
- in_delivery
|
|
3157
|
+
- delivered
|
|
3158
|
+
- in_progress
|
|
3159
|
+
example: completed
|
|
3160
|
+
source:
|
|
3161
|
+
type: string
|
|
3162
|
+
description: The data source of the shipment
|
|
3163
|
+
enum:
|
|
3164
|
+
- Excel
|
|
3165
|
+
- CSV
|
|
3166
|
+
- API
|
|
3167
|
+
- Calculator
|
|
3168
|
+
- Tracking
|
|
3169
|
+
example: API
|
|
3170
|
+
from_address:
|
|
3171
|
+
$ref: '#/definitions/ShipmentAddress'
|
|
3172
|
+
to_address:
|
|
3173
|
+
$ref: '#/definitions/ShipmentAddress'
|
|
3174
|
+
details:
|
|
3175
|
+
$ref: '#/definitions/ShipmentDetails'
|
|
3176
|
+
customs_invoice:
|
|
3177
|
+
$ref: '#/definitions/CustomsInvoiceOutput'
|
|
3178
|
+
packages:
|
|
3179
|
+
type: array
|
|
3180
|
+
description: Packages of the shipment
|
|
3181
|
+
items:
|
|
3182
|
+
$ref: '#/definitions/ShipmentPackage'
|
|
3183
|
+
connection:
|
|
3184
|
+
$ref: '#/definitions/ShipmentConnection'
|
|
3185
|
+
rate:
|
|
3186
|
+
$ref: '#/definitions/ShipmentRate'
|
|
3187
|
+
tracking:
|
|
3188
|
+
$ref: '#/definitions/ShipmentTracking'
|
|
3189
|
+
dates_in_the_past:
|
|
3190
|
+
type: boolean
|
|
3191
|
+
description: Is pickup or delivery dates in the past according country timezones.
|
|
3192
|
+
example: true
|
|
3193
|
+
settings:
|
|
3194
|
+
type: object
|
|
3195
|
+
description: Shipment settings
|
|
3196
|
+
properties:
|
|
3197
|
+
source_type:
|
|
3198
|
+
type: string
|
|
3199
|
+
description: Source of shipment
|
|
3200
|
+
example: SCC
|
|
3201
|
+
label_format:
|
|
3202
|
+
type: string
|
|
3203
|
+
description: Prefered label format
|
|
3204
|
+
enum:
|
|
3205
|
+
- A4
|
|
3206
|
+
- A6
|
|
3207
|
+
use_commercial_invoice:
|
|
3208
|
+
type: boolean
|
|
3209
|
+
description: An indicator that shows whether to use a commercial invoice or a proforma invoice
|
|
3210
|
+
picked_up:
|
|
3211
|
+
type: boolean
|
|
3212
|
+
description: The parcel had not been collected successfully during the initial pickup time frame.
|
|
3213
|
+
example: false
|
|
3214
|
+
update_ordered_delivery_address_allowed:
|
|
3215
|
+
type: boolean
|
|
3216
|
+
description: Parameter to show can we update delivery address for an already ordered shipment or not
|
|
3217
|
+
example: false
|
|
3218
|
+
pickup_status:
|
|
3219
|
+
type: integer
|
|
3220
|
+
description: 'Statuses for a new pickup: ''0'' - default status; ''1'' - ''schedule a new pickup'' email has been sent; ''2'' - second pickup scheduled; ''3'' - support email after failed second pickup has been sent;'
|
|
3221
|
+
example: 0
|
|
3222
|
+
ShipmentAddress:
|
|
3223
|
+
type: object
|
|
3224
|
+
properties:
|
|
3225
|
+
company:
|
|
3226
|
+
type: string
|
|
3227
|
+
description: Company name
|
|
3228
|
+
maxLength: 35
|
|
3229
|
+
example: Test Corp.
|
|
3230
|
+
name:
|
|
3231
|
+
type: string
|
|
3232
|
+
description: First and Last Name
|
|
3233
|
+
maxLength: 35
|
|
3234
|
+
example: John Doe
|
|
3235
|
+
street:
|
|
3236
|
+
type: string
|
|
3237
|
+
description: First address line (usually street name and house number)
|
|
3238
|
+
maxLength: 35
|
|
3239
|
+
example: 100 West 33rd Street
|
|
3240
|
+
street2:
|
|
3241
|
+
type: string
|
|
3242
|
+
description: Second address line for further information
|
|
3243
|
+
maxLength: 35
|
|
3244
|
+
example: Apt 123
|
|
3245
|
+
zip:
|
|
3246
|
+
type: string
|
|
3247
|
+
description: Postal code of the address
|
|
3248
|
+
maxLength: 10
|
|
3249
|
+
example: '10001'
|
|
3250
|
+
city:
|
|
3251
|
+
type: string
|
|
3252
|
+
description: Name of the city
|
|
3253
|
+
maxLength: 30
|
|
3254
|
+
example: New York
|
|
3255
|
+
state:
|
|
3256
|
+
$ref: '#/definitions/State'
|
|
3257
|
+
country:
|
|
3258
|
+
$ref: '#/definitions/Country'
|
|
3259
|
+
phone:
|
|
3260
|
+
type: string
|
|
3261
|
+
description: Phone number
|
|
3262
|
+
maxLength: 35
|
|
3263
|
+
example: '1234567890'
|
|
3264
|
+
settings:
|
|
3265
|
+
type: array
|
|
3266
|
+
description: Custom address data
|
|
3267
|
+
items:
|
|
3268
|
+
type: object
|
|
3269
|
+
example: []
|
|
3270
|
+
ShipmentCheapestRateInput:
|
|
3271
|
+
type: object
|
|
3272
|
+
required:
|
|
3273
|
+
- deliveryDate
|
|
3274
|
+
- pickupDate
|
|
3275
|
+
- settings
|
|
3276
|
+
properties:
|
|
3277
|
+
filterData:
|
|
3278
|
+
type: object
|
|
3279
|
+
properties:
|
|
3280
|
+
deliveryTimeUntil:
|
|
3281
|
+
type: integer
|
|
3282
|
+
description: Latest delivery time
|
|
3283
|
+
example: 0
|
|
3284
|
+
options:
|
|
3285
|
+
type: array
|
|
3286
|
+
items:
|
|
3287
|
+
type: string
|
|
3288
|
+
description: options
|
|
3289
|
+
example: []
|
|
3290
|
+
packageTypes:
|
|
3291
|
+
type: integer
|
|
3292
|
+
description: Package type id
|
|
3293
|
+
example: 17
|
|
3294
|
+
priceMax:
|
|
3295
|
+
type: integer
|
|
3296
|
+
description: Max price
|
|
3297
|
+
example: 17
|
|
3298
|
+
shipperGroups:
|
|
3299
|
+
type: array
|
|
3300
|
+
items:
|
|
3301
|
+
type: string
|
|
3302
|
+
description: Shipper groups
|
|
3303
|
+
example: []
|
|
3304
|
+
shippingType:
|
|
3305
|
+
type: integer
|
|
3306
|
+
description: The shipping type indicates whether the shipment must be delivered in a shop or picked up by a driver.
|
|
3307
|
+
example: 2
|
|
3308
|
+
tariffTypes:
|
|
3309
|
+
type: array
|
|
3310
|
+
items:
|
|
3311
|
+
type: string
|
|
3312
|
+
description: Tariff types
|
|
3313
|
+
example: []
|
|
3314
|
+
timeMax:
|
|
3315
|
+
type: integer
|
|
3316
|
+
description: Max time
|
|
3317
|
+
example: 1440
|
|
3318
|
+
timeMin:
|
|
3319
|
+
type: integer
|
|
3320
|
+
description: Min time
|
|
3321
|
+
example: 0
|
|
3322
|
+
transitTimeMax:
|
|
3323
|
+
type: integer
|
|
3324
|
+
description: Max time of transit
|
|
3325
|
+
example: 125
|
|
3326
|
+
deliveryDate:
|
|
3327
|
+
type: string
|
|
3328
|
+
format: date-time
|
|
3329
|
+
description: Delivery date
|
|
3330
|
+
example: '2020-07-14T17:10:37Z'
|
|
3331
|
+
pickupDate:
|
|
3332
|
+
type: string
|
|
3333
|
+
format: date-time
|
|
3334
|
+
description: The date for which the collection was arranged.
|
|
3335
|
+
example: '2020-07-14T17:10:37Z'
|
|
3336
|
+
pickupDateMode:
|
|
3337
|
+
$ref: '#/definitions/ShipmentPickupDateMode'
|
|
3338
|
+
settings:
|
|
3339
|
+
type: object
|
|
3340
|
+
properties:
|
|
3341
|
+
mode:
|
|
3342
|
+
type: string
|
|
3343
|
+
description: Setting modes for shipment tariff
|
|
3344
|
+
example: m
|
|
3345
|
+
enum:
|
|
3346
|
+
- m
|
|
3347
|
+
- a
|
|
3348
|
+
- a2
|
|
3349
|
+
- all
|
|
3350
|
+
- single
|
|
3351
|
+
tariffId:
|
|
3352
|
+
type: string
|
|
3353
|
+
description: Tarriff id
|
|
3354
|
+
example: s-4
|
|
3355
|
+
getExternalTariffs:
|
|
3356
|
+
type: boolean
|
|
3357
|
+
description: allow to get external tariffs
|
|
3358
|
+
example: true
|
|
3359
|
+
ShipmentConnection:
|
|
3360
|
+
type: object
|
|
3361
|
+
properties:
|
|
3362
|
+
connection_uuid:
|
|
3363
|
+
type: string
|
|
3364
|
+
description: The ID of the connection used to create the shipment.
|
|
3365
|
+
example: c_891547f2fca547e798ba61dbf89acdde
|
|
3366
|
+
connection_item_uuid:
|
|
3367
|
+
type: string
|
|
3368
|
+
description: Your individual item ID of the shipment. Mostly corresponds to the order number in your shop.
|
|
3369
|
+
example: my-unique-item-id
|
|
3370
|
+
connection_custom_data:
|
|
3371
|
+
$ref: '#/definitions/ConnectionCustomData'
|
|
3372
|
+
ShipmentDetails:
|
|
3373
|
+
type: object
|
|
3374
|
+
properties:
|
|
3375
|
+
value_amount:
|
|
3376
|
+
type: integer
|
|
3377
|
+
format: int32
|
|
3378
|
+
description: Goods value of the consignment; needed for the customs
|
|
3379
|
+
minimum: 1
|
|
3380
|
+
maximum: 9999999
|
|
3381
|
+
example: 200
|
|
3382
|
+
value_currency:
|
|
3383
|
+
$ref: '#/definitions/CurrencyCode'
|
|
3384
|
+
content_description:
|
|
3385
|
+
type: string
|
|
3386
|
+
description: Description of the contents of the package(s); needed for the customs
|
|
3387
|
+
maxLength: 35
|
|
3388
|
+
example: sample
|
|
3389
|
+
reference_number:
|
|
3390
|
+
type: string
|
|
3391
|
+
description: A reference text that you can use to identify your shipment, e.g. an order number of your merchandise management system. Will be printed on the shipping label in most cases.
|
|
3392
|
+
maxLength: 35
|
|
3393
|
+
example: my-reference
|
|
3394
|
+
email:
|
|
3395
|
+
type: string
|
|
3396
|
+
description: Is always the email address of your customer account
|
|
3397
|
+
maxLength: 254
|
|
3398
|
+
example: email@example.org
|
|
3399
|
+
email_tracking:
|
|
3400
|
+
type: string
|
|
3401
|
+
description: If specified, after the order has been placed, an email will be sent to this email address with the tracking link
|
|
3402
|
+
maxLength: 254
|
|
3403
|
+
example: email@example.org
|
|
3404
|
+
email_label_copy:
|
|
3405
|
+
type: string
|
|
3406
|
+
description: If specified, after the order has been placed, an additional email with the shipping label will be sent to this email address
|
|
3407
|
+
maxLength: 254
|
|
3408
|
+
example: email@example.org
|
|
3409
|
+
insurance_amount:
|
|
3410
|
+
type: integer
|
|
3411
|
+
format: int32
|
|
3412
|
+
description: Amount of additional insurance value
|
|
3413
|
+
minimum: 0
|
|
3414
|
+
maximum: 20000
|
|
3415
|
+
example: 200
|
|
3416
|
+
insurance_currency:
|
|
3417
|
+
type: string
|
|
3418
|
+
example: EUR
|
|
3419
|
+
extra_insurance_price_netto:
|
|
3420
|
+
type: string
|
|
3421
|
+
description: Amount of extra insurance value netto
|
|
3422
|
+
example: 8.2
|
|
3423
|
+
extra_insurance_price_brutto:
|
|
3424
|
+
type: string
|
|
3425
|
+
description: Amount of extra insurance value brutto
|
|
3426
|
+
example: 10
|
|
3427
|
+
export_license:
|
|
3428
|
+
type: boolean
|
|
3429
|
+
description: Indicate if you need an export license and want to buy it along with the shipment
|
|
3430
|
+
extra_insurance_value:
|
|
3431
|
+
type: integer
|
|
3432
|
+
description: Amount of extra insurance value
|
|
3433
|
+
example: 300
|
|
3434
|
+
extra_insurance_type:
|
|
3435
|
+
type: string
|
|
3436
|
+
description: 'Type of insurance. Possible values: standard | premium'
|
|
3437
|
+
enum:
|
|
3438
|
+
- standard
|
|
3439
|
+
- premium
|
|
3440
|
+
default: standard
|
|
3441
|
+
export_license_price_brutto:
|
|
3442
|
+
type: string
|
|
3443
|
+
description: Amount of extra license price brutto
|
|
3444
|
+
example: 11
|
|
3445
|
+
shipment_order_number_short:
|
|
3446
|
+
type: string
|
|
3447
|
+
description: Shipment order number (only after the order has been placed)
|
|
3448
|
+
example: A-180709V1ML-1
|
|
3449
|
+
shipment_order_number:
|
|
3450
|
+
type: string
|
|
3451
|
+
description: Order number (only after the order has been placed)
|
|
3452
|
+
example: B-180709V1ML
|
|
3453
|
+
packaging_type:
|
|
3454
|
+
$ref: '#/definitions/PackagingType'
|
|
3455
|
+
hs_tariff_number:
|
|
3456
|
+
type: string
|
|
3457
|
+
description: Hs number for import/export goods defining the type of the good for customs.
|
|
3458
|
+
example: '61091000'
|
|
3459
|
+
extra_export_license_number:
|
|
3460
|
+
type: string
|
|
3461
|
+
description: Extra export license number
|
|
3462
|
+
example: '4200042'
|
|
3463
|
+
settings:
|
|
3464
|
+
type: object
|
|
3465
|
+
description: Custom settings
|
|
3466
|
+
example: []
|
|
3467
|
+
ShipmentFileDocument:
|
|
3468
|
+
type: object
|
|
3469
|
+
properties:
|
|
3470
|
+
name:
|
|
3471
|
+
type: string
|
|
3472
|
+
description: Document name
|
|
3473
|
+
example: my-custom-name.pdf
|
|
3474
|
+
type:
|
|
3475
|
+
type: string
|
|
3476
|
+
description: Type of document
|
|
3477
|
+
example: commercial-invoice
|
|
3478
|
+
reference:
|
|
3479
|
+
type: string
|
|
3480
|
+
description: Reference
|
|
3481
|
+
example: s_642bf5ab244c4380a379f0c8877f69b3
|
|
3482
|
+
ShipmentPackage:
|
|
3483
|
+
type: object
|
|
3484
|
+
required:
|
|
3485
|
+
- height
|
|
3486
|
+
- length
|
|
3487
|
+
- weight
|
|
3488
|
+
- width
|
|
3489
|
+
properties:
|
|
3490
|
+
weight:
|
|
3491
|
+
type: number
|
|
3492
|
+
format: float
|
|
3493
|
+
description: Weight of the package in kg
|
|
3494
|
+
minimum: 0.1
|
|
3495
|
+
maximum: 9999999
|
|
3496
|
+
example: 0.1
|
|
3497
|
+
length:
|
|
3498
|
+
type: integer
|
|
3499
|
+
format: int32
|
|
3500
|
+
description: Length of the package in cm
|
|
3501
|
+
minimum: 1
|
|
3502
|
+
maximum: 99999
|
|
3503
|
+
example: 18
|
|
3504
|
+
width:
|
|
3505
|
+
type: integer
|
|
3506
|
+
format: int32
|
|
3507
|
+
description: Width of the package in cm
|
|
3508
|
+
minimum: 1
|
|
3509
|
+
maximum: 99999
|
|
3510
|
+
example: 19
|
|
3511
|
+
height:
|
|
3512
|
+
type: integer
|
|
3513
|
+
format: int32
|
|
3514
|
+
description: Height of the package in cm
|
|
3515
|
+
minimum: 1
|
|
3516
|
+
maximum: 99999
|
|
3517
|
+
example: 20
|
|
3518
|
+
girth:
|
|
3519
|
+
type: integer
|
|
3520
|
+
format: int32
|
|
3521
|
+
description: Girth of the package in cm
|
|
3522
|
+
minimum: 1
|
|
3523
|
+
example: 96
|
|
3524
|
+
first_length:
|
|
3525
|
+
type: integer
|
|
3526
|
+
format: int32
|
|
3527
|
+
description: Longest side of the package in cm
|
|
3528
|
+
minimum: 1
|
|
3529
|
+
example: 20
|
|
3530
|
+
second_length:
|
|
3531
|
+
type: integer
|
|
3532
|
+
format: int32
|
|
3533
|
+
description: Second longest side of the package in cm
|
|
3534
|
+
minimum: 1
|
|
3535
|
+
example: 19
|
|
3536
|
+
ShipmentPickupDateMode:
|
|
3537
|
+
type: string
|
|
3538
|
+
description: Mode of pickup date. Default is 'flex'. Use 'exact' in combination with a pickupDate to filter only rates that can still be picked up on this day.
|
|
3539
|
+
example: flex
|
|
3540
|
+
enum:
|
|
3541
|
+
- flex
|
|
3542
|
+
- exact
|
|
3543
|
+
ShipmentRate:
|
|
3544
|
+
type: object
|
|
3545
|
+
properties:
|
|
3546
|
+
carrier:
|
|
3547
|
+
type: string
|
|
3548
|
+
description: Name of the carrier
|
|
3549
|
+
example: UPS
|
|
3550
|
+
service:
|
|
3551
|
+
type: string
|
|
3552
|
+
description: Name of the service
|
|
3553
|
+
example: UPS Ground ®
|
|
3554
|
+
shipping_type:
|
|
3555
|
+
type: string
|
|
3556
|
+
description: The shipping type indicates whether the shipment must be delivered in a shop or picked up by a driver.
|
|
3557
|
+
enum:
|
|
3558
|
+
- pickup
|
|
3559
|
+
- shop
|
|
3560
|
+
example: pickup
|
|
3561
|
+
transit_time_range_days:
|
|
3562
|
+
type: string
|
|
3563
|
+
description: Specifies the minimum and maximum delivery time in working days that the shipment is expected to be on its way.
|
|
3564
|
+
example: 1-6
|
|
3565
|
+
max_included_liability_amount:
|
|
3566
|
+
type: integer
|
|
3567
|
+
format: int32
|
|
3568
|
+
description: The maximum included liability amount of this rate
|
|
3569
|
+
example: 510
|
|
3570
|
+
max_included_liability_currency:
|
|
3571
|
+
$ref: '#/definitions/Currency'
|
|
3572
|
+
printer_required:
|
|
3573
|
+
type: boolean
|
|
3574
|
+
description: Indicates whether a printer is required to print the shipping label.
|
|
3575
|
+
example: true
|
|
3576
|
+
company_only:
|
|
3577
|
+
type: boolean
|
|
3578
|
+
description: A commercial pick-up address is required for this rate.
|
|
3579
|
+
example: true
|
|
3580
|
+
price_net:
|
|
3581
|
+
type: number
|
|
3582
|
+
format: float
|
|
3583
|
+
description: Net price
|
|
3584
|
+
example: 5.79
|
|
3585
|
+
price_net_currency:
|
|
3586
|
+
$ref: '#/definitions/Currency'
|
|
3587
|
+
price_total:
|
|
3588
|
+
type: number
|
|
3589
|
+
format: float
|
|
3590
|
+
description: Total
|
|
3591
|
+
example: 6.89
|
|
3592
|
+
price_total_currency:
|
|
3593
|
+
$ref: '#/definitions/Currency'
|
|
3594
|
+
tax_free:
|
|
3595
|
+
type: boolean
|
|
3596
|
+
description: Indicates whether the shipment is tax-free
|
|
3597
|
+
example: false
|
|
3598
|
+
tax_rate:
|
|
3599
|
+
type: number
|
|
3600
|
+
format: float
|
|
3601
|
+
description: Tax rate in percent
|
|
3602
|
+
example: 19
|
|
3603
|
+
tax_country:
|
|
3604
|
+
$ref: '#/definitions/Country'
|
|
3605
|
+
tax_name:
|
|
3606
|
+
type: string
|
|
3607
|
+
description: Name of the tax
|
|
3608
|
+
example: MwSt.
|
|
3609
|
+
pickup_date:
|
|
3610
|
+
type: string
|
|
3611
|
+
format: date
|
|
3612
|
+
description: The date for which the collection was arranged.
|
|
3613
|
+
example: '2018-07-09'
|
|
3614
|
+
pickup_min_time:
|
|
3615
|
+
type: string
|
|
3616
|
+
description: The earliest time at which the shipment is picked up.
|
|
3617
|
+
example: '10:00:00'
|
|
3618
|
+
pickup_max_time:
|
|
3619
|
+
type: string
|
|
3620
|
+
description: The latest time by which the shipment is picked up.
|
|
3621
|
+
example: '18:00:00'
|
|
3622
|
+
pickup_reference_number:
|
|
3623
|
+
type: string
|
|
3624
|
+
description: A reference number with which the collection can be checked.
|
|
3625
|
+
example: 2919802F9CY
|
|
3626
|
+
delivery_date_min:
|
|
3627
|
+
type: string
|
|
3628
|
+
format: date
|
|
3629
|
+
description: Earliest delivery date
|
|
3630
|
+
example: '2018-07-10'
|
|
3631
|
+
delivery_date_max:
|
|
3632
|
+
type: string
|
|
3633
|
+
format: date
|
|
3634
|
+
description: Latest delivery date
|
|
3635
|
+
example: '2018-07-13'
|
|
3636
|
+
delivery_time_until:
|
|
3637
|
+
type: string
|
|
3638
|
+
description: Latest delivery time
|
|
3639
|
+
example: '18:00:00'
|
|
3640
|
+
durationFormatted:
|
|
3641
|
+
type: string
|
|
3642
|
+
description: A formatted duration description with translation
|
|
3643
|
+
example: 4 hours
|
|
3644
|
+
description: The shipment rate object is only available if a tariff has been selected.
|
|
3645
|
+
ShipmentRateInput:
|
|
3646
|
+
type: object
|
|
3647
|
+
required:
|
|
3648
|
+
- shipmentId
|
|
3649
|
+
- deliveryDate
|
|
3650
|
+
- pickupDate
|
|
3651
|
+
- settings
|
|
3652
|
+
properties:
|
|
3653
|
+
shipmentId:
|
|
3654
|
+
type: string
|
|
3655
|
+
description: The unique ID of the shipment
|
|
3656
|
+
example: s_c6aa551badab4223a75da01316ce0752
|
|
3657
|
+
filterData:
|
|
3658
|
+
type: object
|
|
3659
|
+
properties:
|
|
3660
|
+
deliveryTimeUntil:
|
|
3661
|
+
type: integer
|
|
3662
|
+
description: Latest delivery time
|
|
3663
|
+
example: 0
|
|
3664
|
+
options:
|
|
3665
|
+
type: array
|
|
3666
|
+
items:
|
|
3667
|
+
type: string
|
|
3668
|
+
description: |
|
|
3669
|
+
Filter rates based on specific service options.
|
|
3670
|
+
Available options are:
|
|
3671
|
+
| ID | Description |
|
|
3672
|
+
| ---| --------------------------------------|
|
|
3673
|
+
| 1 | No printer |
|
|
3674
|
+
| 3 | Pickup still today |
|
|
3675
|
+
| 4 | Flexible pickup time |
|
|
3676
|
+
| 5 | Delivery to a private address possible|
|
|
3677
|
+
| 6 | Extra insurance possible |
|
|
3678
|
+
example: []
|
|
3679
|
+
packageTypes:
|
|
3680
|
+
type: integer
|
|
3681
|
+
description: |
|
|
3682
|
+
Filter rates by the supported packaging type.
|
|
3683
|
+
Available options are:
|
|
3684
|
+
| ID | Description |
|
|
3685
|
+
| ---| --------------------|
|
|
3686
|
+
| 1 | Document |
|
|
3687
|
+
| 7 | Parcel |
|
|
3688
|
+
| 9 | Bulky goods |
|
|
3689
|
+
| 10 | Pallet |
|
|
3690
|
+
| 11 | Tire |
|
|
3691
|
+
| 14 | Suitcase |
|
|
3692
|
+
| 15 | Non-stackable pallet|
|
|
3693
|
+
example: 7
|
|
3694
|
+
priceMax:
|
|
3695
|
+
type: integer
|
|
3696
|
+
description: Filter rates that are <= the specified maximum price
|
|
3697
|
+
example: 17
|
|
3698
|
+
shipperGroups:
|
|
3699
|
+
type: array
|
|
3700
|
+
items:
|
|
3701
|
+
type: string
|
|
3702
|
+
description: Only return tariffs of a specific carrier. Any shipment rates call returns the full list of carrier ids that are currently available at JUMiNGO.
|
|
3703
|
+
example: []
|
|
3704
|
+
shippingType:
|
|
3705
|
+
type: integer
|
|
3706
|
+
description: The shipping type indicates whether the shipment must be dropped-off in a parcel shop or if it is picked up by a driver. Select 1 to receive only pickup rates and 2 to only receive drop-off rates.
|
|
3707
|
+
example: 2
|
|
3708
|
+
enum:
|
|
3709
|
+
- 1
|
|
3710
|
+
- 2
|
|
3711
|
+
tariffTypes:
|
|
3712
|
+
type: array
|
|
3713
|
+
items:
|
|
3714
|
+
type: string
|
|
3715
|
+
description: |
|
|
3716
|
+
Only return specific services such as Standard (1), Express (2), Same Day (4) or Economy (5) rates.
|
|
3717
|
+
example: []
|
|
3718
|
+
timeMax:
|
|
3719
|
+
type: integer
|
|
3720
|
+
description: Max time
|
|
3721
|
+
example: 1440
|
|
3722
|
+
timeMin:
|
|
3723
|
+
type: integer
|
|
3724
|
+
description: Min time
|
|
3725
|
+
example: 0
|
|
3726
|
+
transitTimeMax:
|
|
3727
|
+
type: integer
|
|
3728
|
+
description: Max time of transit
|
|
3729
|
+
example: 125
|
|
3730
|
+
deliveryDate:
|
|
3731
|
+
type: string
|
|
3732
|
+
format: date-time
|
|
3733
|
+
description: The latest permitted delivery date.
|
|
3734
|
+
example: '2023-12-14T00:00:00Z'
|
|
3735
|
+
pickupDate:
|
|
3736
|
+
type: string
|
|
3737
|
+
format: date-time
|
|
3738
|
+
description: The date on which the shipment is to be sent.
|
|
3739
|
+
example: '2023-12-04T00:00:00Z'
|
|
3740
|
+
packagingTypeId:
|
|
3741
|
+
type: integer
|
|
3742
|
+
description: |
|
|
3743
|
+
Package type id
|
|
3744
|
+
| ID | Description |
|
|
3745
|
+
| ---| --------------------|
|
|
3746
|
+
| 1 | Document |
|
|
3747
|
+
| 7 | Parcel |
|
|
3748
|
+
| 9 | Bulky goods |
|
|
3749
|
+
| 10 | Pallet |
|
|
3750
|
+
| 11 | Tire |
|
|
3751
|
+
| 14 | Suitcase |
|
|
3752
|
+
| 15 | Non-stackable pallet|
|
|
3753
|
+
example: 7
|
|
3754
|
+
enum:
|
|
3755
|
+
- 1
|
|
3756
|
+
- 7
|
|
3757
|
+
- 9
|
|
3758
|
+
- 10
|
|
3759
|
+
- 11
|
|
3760
|
+
- 14
|
|
3761
|
+
- 15
|
|
3762
|
+
pickupDateMode:
|
|
3763
|
+
$ref: '#/definitions/ShipmentPickupDateMode'
|
|
3764
|
+
settings:
|
|
3765
|
+
type: object
|
|
3766
|
+
required:
|
|
3767
|
+
- mode
|
|
3768
|
+
properties:
|
|
3769
|
+
mode:
|
|
3770
|
+
type: string
|
|
3771
|
+
description: |
|
|
3772
|
+
Setting modes for shipment tariff.
|
|
3773
|
+
Use 'm' for a regular call to fetch rates. This will return the same results as the shipping cost calculation on the JUMiNGO homepage.
|
|
3774
|
+
Use 'a' to get available Same Day rates.
|
|
3775
|
+
Use 'single' to fetch data about a single tariff. If used, tariffID needs to be set in the request as well.
|
|
3776
|
+
example: m
|
|
3777
|
+
enum:
|
|
3778
|
+
- m
|
|
3779
|
+
- a
|
|
3780
|
+
- single
|
|
3781
|
+
tariffId:
|
|
3782
|
+
type: string
|
|
3783
|
+
description: Tarriff id
|
|
3784
|
+
example: s-4
|
|
3785
|
+
getExternalTariffs:
|
|
3786
|
+
type: boolean
|
|
3787
|
+
description: allow to get external tariffs
|
|
3788
|
+
example: true
|
|
3789
|
+
ShipmentRateOutput:
|
|
3790
|
+
type: object
|
|
3791
|
+
properties:
|
|
3792
|
+
uuid:
|
|
3793
|
+
type: string
|
|
3794
|
+
description: identifier of shipment rate
|
|
3795
|
+
example: 8a43a995-bade-4222-8dc3-5089774fc069
|
|
3796
|
+
shipperGroups:
|
|
3797
|
+
type: array
|
|
3798
|
+
items:
|
|
3799
|
+
type: object
|
|
3800
|
+
properties:
|
|
3801
|
+
id:
|
|
3802
|
+
type: integer
|
|
3803
|
+
description: Shipper group id
|
|
3804
|
+
example: 2
|
|
3805
|
+
name:
|
|
3806
|
+
type: string
|
|
3807
|
+
description: Shipper group name
|
|
3808
|
+
example: DHL Express
|
|
3809
|
+
logo:
|
|
3810
|
+
type: string
|
|
3811
|
+
description: Shipper group logo
|
|
3812
|
+
example: /img/versandrechner/versender/dhlexpress.png
|
|
3813
|
+
url_converted:
|
|
3814
|
+
type: string
|
|
3815
|
+
description: Shipper group url
|
|
3816
|
+
example: dhl-express
|
|
3817
|
+
countries:
|
|
3818
|
+
type: array
|
|
3819
|
+
items:
|
|
3820
|
+
type: object
|
|
3821
|
+
properties:
|
|
3822
|
+
id:
|
|
3823
|
+
type: integer
|
|
3824
|
+
description: Country id
|
|
3825
|
+
example: 54
|
|
3826
|
+
isocode:
|
|
3827
|
+
type: string
|
|
3828
|
+
description: Country iso code
|
|
3829
|
+
example: DE
|
|
3830
|
+
post_code_free:
|
|
3831
|
+
type: integer
|
|
3832
|
+
description: Post code
|
|
3833
|
+
example: 0
|
|
3834
|
+
tax_free:
|
|
3835
|
+
type: integer
|
|
3836
|
+
description: tax free
|
|
3837
|
+
example: 0
|
|
3838
|
+
status:
|
|
3839
|
+
type: string
|
|
3840
|
+
description: Status of response
|
|
3841
|
+
example: success
|
|
3842
|
+
fromCountryCode:
|
|
3843
|
+
type: string
|
|
3844
|
+
description: From country code
|
|
3845
|
+
example: DE
|
|
3846
|
+
toCountryCode:
|
|
3847
|
+
type: string
|
|
3848
|
+
description: From country code
|
|
3849
|
+
example: DE
|
|
3850
|
+
pickupCountryHolidays:
|
|
3851
|
+
type: object
|
|
3852
|
+
properties:
|
|
3853
|
+
'1608768000':
|
|
3854
|
+
type: integer
|
|
3855
|
+
description: List of counrty holidays
|
|
3856
|
+
example: 1
|
|
3857
|
+
insurance:
|
|
3858
|
+
type: object
|
|
3859
|
+
properties:
|
|
3860
|
+
national:
|
|
3861
|
+
$ref: '#/definitions/Insurance'
|
|
3862
|
+
international:
|
|
3863
|
+
$ref: '#/definitions/Insurance'
|
|
3864
|
+
exportDeclaration:
|
|
3865
|
+
type: object
|
|
3866
|
+
properties:
|
|
3867
|
+
export_declaration_price:
|
|
3868
|
+
type: number
|
|
3869
|
+
format: float
|
|
3870
|
+
example: 1.99
|
|
3871
|
+
export_declaration_price_old:
|
|
3872
|
+
type: number
|
|
3873
|
+
format: float
|
|
3874
|
+
example: 2.99
|
|
3875
|
+
export_declaration_price_diff:
|
|
3876
|
+
type: number
|
|
3877
|
+
format: float
|
|
3878
|
+
example: 1
|
|
3879
|
+
apiTariffMode:
|
|
3880
|
+
type: string
|
|
3881
|
+
description: Api tariff mode
|
|
3882
|
+
example: a
|
|
3883
|
+
isSearchRequest:
|
|
3884
|
+
type: boolean
|
|
3885
|
+
description: Is search request
|
|
3886
|
+
packagingTypeId:
|
|
3887
|
+
type: integer
|
|
3888
|
+
description: Package type id
|
|
3889
|
+
example: 17
|
|
3890
|
+
details:
|
|
3891
|
+
type: object
|
|
3892
|
+
properties:
|
|
3893
|
+
email:
|
|
3894
|
+
type: string
|
|
3895
|
+
packageTypes:
|
|
3896
|
+
type: array
|
|
3897
|
+
items:
|
|
3898
|
+
$ref: '#/definitions/PackageType'
|
|
3899
|
+
billing:
|
|
3900
|
+
$ref: '#/definitions/ShipmentAddress'
|
|
3901
|
+
from:
|
|
3902
|
+
$ref: '#/definitions/ShipmentAddress'
|
|
3903
|
+
to:
|
|
3904
|
+
$ref: '#/definitions/ShipmentAddress'
|
|
3905
|
+
packages:
|
|
3906
|
+
type: array
|
|
3907
|
+
items:
|
|
3908
|
+
$ref: '#/definitions/ShipmentPackage'
|
|
3909
|
+
tariffs:
|
|
3910
|
+
type: array
|
|
3911
|
+
items:
|
|
3912
|
+
$ref: '#/definitions/Tariff'
|
|
3913
|
+
summary:
|
|
3914
|
+
$ref: '#/definitions/ShipmentRateSummary'
|
|
3915
|
+
quickFilters:
|
|
3916
|
+
type: array
|
|
3917
|
+
items:
|
|
3918
|
+
type: object
|
|
3919
|
+
properties:
|
|
3920
|
+
property:
|
|
3921
|
+
type: string
|
|
3922
|
+
description: Property for the filterData object
|
|
3923
|
+
id:
|
|
3924
|
+
type: integer
|
|
3925
|
+
description: Id value of the property
|
|
3926
|
+
name:
|
|
3927
|
+
type: string
|
|
3928
|
+
description: Name of the quick filter
|
|
3929
|
+
icon:
|
|
3930
|
+
type: string
|
|
3931
|
+
description: Should be used insted of name if not empty
|
|
3932
|
+
order:
|
|
3933
|
+
type: integer
|
|
3934
|
+
description: Quick filters sort order ASC
|
|
3935
|
+
permanent:
|
|
3936
|
+
type: boolean
|
|
3937
|
+
description: Is filter permanent or not. Related to mobile view
|
|
3938
|
+
extended:
|
|
3939
|
+
type: boolean
|
|
3940
|
+
description: Is filter extended or not. Related to extended or short scc view
|
|
3941
|
+
seoData:
|
|
3942
|
+
type: boolean
|
|
3943
|
+
serviceOptions:
|
|
3944
|
+
type: array
|
|
3945
|
+
items:
|
|
3946
|
+
type: string
|
|
3947
|
+
ShipmentRateSummary:
|
|
3948
|
+
type: object
|
|
3949
|
+
required:
|
|
3950
|
+
- taxFree
|
|
3951
|
+
- tax
|
|
3952
|
+
- packageAll
|
|
3953
|
+
- package
|
|
3954
|
+
properties:
|
|
3955
|
+
taxFree:
|
|
3956
|
+
type: boolean
|
|
3957
|
+
description: If the tax applicable, this property will equal false.
|
|
3958
|
+
example: false
|
|
3959
|
+
tax:
|
|
3960
|
+
type: object
|
|
3961
|
+
description: The tax description. If taxFree equals true, this property will equal null.
|
|
3962
|
+
properties:
|
|
3963
|
+
rate:
|
|
3964
|
+
type: number
|
|
3965
|
+
format: float
|
|
3966
|
+
description: The tax rate value
|
|
3967
|
+
example: 19
|
|
3968
|
+
name:
|
|
3969
|
+
type: string
|
|
3970
|
+
description: The tax name
|
|
3971
|
+
example: MwSt.
|
|
3972
|
+
packageAll:
|
|
3973
|
+
type: boolean
|
|
3974
|
+
description: If provided more than one packages and should show the word "all", this property will equal true.
|
|
3975
|
+
example: false
|
|
3976
|
+
package:
|
|
3977
|
+
type: object
|
|
3978
|
+
description: The packages description. If it did not provide any package, this property would equal null.
|
|
3979
|
+
properties:
|
|
3980
|
+
weight:
|
|
3981
|
+
type: number
|
|
3982
|
+
format: float
|
|
3983
|
+
description: Weight of the package in kg
|
|
3984
|
+
minimum: 0.1
|
|
3985
|
+
maximum: 9999999
|
|
3986
|
+
example: 0.1
|
|
3987
|
+
length:
|
|
3988
|
+
type: integer
|
|
3989
|
+
format: int32
|
|
3990
|
+
description: Length of the package in cm
|
|
3991
|
+
minimum: 1
|
|
3992
|
+
maximum: 99999
|
|
3993
|
+
example: 18
|
|
3994
|
+
width:
|
|
3995
|
+
type: integer
|
|
3996
|
+
format: int32
|
|
3997
|
+
description: Width of the package in cm
|
|
3998
|
+
minimum: 1
|
|
3999
|
+
maximum: 99999
|
|
4000
|
+
example: 19
|
|
4001
|
+
height:
|
|
4002
|
+
type: integer
|
|
4003
|
+
format: int32
|
|
4004
|
+
description: Height of the package in cm
|
|
4005
|
+
minimum: 1
|
|
4006
|
+
maximum: 99999
|
|
4007
|
+
example: 20
|
|
4008
|
+
ShipmentTracking:
|
|
4009
|
+
type: object
|
|
4010
|
+
properties:
|
|
4011
|
+
data:
|
|
4012
|
+
type: object
|
|
4013
|
+
properties:
|
|
4014
|
+
version:
|
|
4015
|
+
type: string
|
|
4016
|
+
tracking_number:
|
|
4017
|
+
type: string
|
|
4018
|
+
status_text:
|
|
4019
|
+
type: string
|
|
4020
|
+
from:
|
|
4021
|
+
$ref: '#/definitions/TrackingAddress'
|
|
4022
|
+
to:
|
|
4023
|
+
$ref: '#/definitions/TrackingAddress'
|
|
4024
|
+
carrier:
|
|
4025
|
+
type: object
|
|
4026
|
+
properties:
|
|
4027
|
+
code:
|
|
4028
|
+
type: string
|
|
4029
|
+
name:
|
|
4030
|
+
type: string
|
|
4031
|
+
image:
|
|
4032
|
+
type: string
|
|
4033
|
+
phone:
|
|
4034
|
+
type: string
|
|
4035
|
+
id:
|
|
4036
|
+
type: integer
|
|
4037
|
+
steps:
|
|
4038
|
+
type: array
|
|
4039
|
+
description: Contains detailed tracking information
|
|
4040
|
+
items:
|
|
4041
|
+
$ref: '#/definitions/TrackingStep'
|
|
4042
|
+
status:
|
|
4043
|
+
type: string
|
|
4044
|
+
description: Tracking status of the shipment
|
|
4045
|
+
enum:
|
|
4046
|
+
- new
|
|
4047
|
+
- notfound
|
|
4048
|
+
- transit
|
|
4049
|
+
- expired
|
|
4050
|
+
- exception
|
|
4051
|
+
- pickup
|
|
4052
|
+
- undelivered
|
|
4053
|
+
- delivered
|
|
4054
|
+
example: transit
|
|
4055
|
+
stepDates:
|
|
4056
|
+
type: array
|
|
4057
|
+
items:
|
|
4058
|
+
type: object
|
|
4059
|
+
dates:
|
|
4060
|
+
$ref: '#/definitions/TrackingDates'
|
|
4061
|
+
infos:
|
|
4062
|
+
type: array
|
|
4063
|
+
items:
|
|
4064
|
+
type: object
|
|
4065
|
+
progress:
|
|
4066
|
+
type: array
|
|
4067
|
+
items:
|
|
4068
|
+
type: object
|
|
4069
|
+
carrierList:
|
|
4070
|
+
type: object
|
|
4071
|
+
active:
|
|
4072
|
+
type: integer
|
|
4073
|
+
status:
|
|
4074
|
+
type: string
|
|
4075
|
+
progress:
|
|
4076
|
+
type: object
|
|
4077
|
+
properties:
|
|
4078
|
+
class:
|
|
4079
|
+
type: string
|
|
4080
|
+
points:
|
|
4081
|
+
type: object
|
|
4082
|
+
properties:
|
|
4083
|
+
completed:
|
|
4084
|
+
type: boolean
|
|
4085
|
+
exception:
|
|
4086
|
+
type: boolean
|
|
4087
|
+
in_system:
|
|
4088
|
+
type: boolean
|
|
4089
|
+
in_transit:
|
|
4090
|
+
type: boolean
|
|
4091
|
+
in_delivery:
|
|
4092
|
+
type: boolean
|
|
4093
|
+
undelivered:
|
|
4094
|
+
type: boolean
|
|
4095
|
+
percent:
|
|
4096
|
+
type: integer
|
|
4097
|
+
carrierTrackingPage:
|
|
4098
|
+
type: string
|
|
4099
|
+
implementationType:
|
|
4100
|
+
type: string
|
|
4101
|
+
State:
|
|
4102
|
+
type: string
|
|
4103
|
+
description: Abbreviation of the state; the state is required only for US and Canada.
|
|
4104
|
+
example: NY
|
|
4105
|
+
enum:
|
|
4106
|
+
- AL
|
|
4107
|
+
- AK
|
|
4108
|
+
- AZ
|
|
4109
|
+
- AR
|
|
4110
|
+
- CA
|
|
4111
|
+
- CO
|
|
4112
|
+
- CT
|
|
4113
|
+
- DE
|
|
4114
|
+
- DC
|
|
4115
|
+
- FL
|
|
4116
|
+
- GA
|
|
4117
|
+
- HI
|
|
4118
|
+
- ID
|
|
4119
|
+
- IL
|
|
4120
|
+
- IN
|
|
4121
|
+
- IA
|
|
4122
|
+
- KS
|
|
4123
|
+
- KY
|
|
4124
|
+
- LA
|
|
4125
|
+
- ME
|
|
4126
|
+
- MD
|
|
4127
|
+
- MA
|
|
4128
|
+
- MI
|
|
4129
|
+
- MN
|
|
4130
|
+
- MS
|
|
4131
|
+
- MO
|
|
4132
|
+
- MT
|
|
4133
|
+
- NE
|
|
4134
|
+
- NV
|
|
4135
|
+
- NH
|
|
4136
|
+
- NJ
|
|
4137
|
+
- NM
|
|
4138
|
+
- NY
|
|
4139
|
+
- NC
|
|
4140
|
+
- ND
|
|
4141
|
+
- OH
|
|
4142
|
+
- OK
|
|
4143
|
+
- OR
|
|
4144
|
+
- PA
|
|
4145
|
+
- RI
|
|
4146
|
+
- SC
|
|
4147
|
+
- SD
|
|
4148
|
+
- TN
|
|
4149
|
+
- TX
|
|
4150
|
+
- UT
|
|
4151
|
+
- VT
|
|
4152
|
+
- VA
|
|
4153
|
+
- WA
|
|
4154
|
+
- WV
|
|
4155
|
+
- WI
|
|
4156
|
+
- WY
|
|
4157
|
+
- AB
|
|
4158
|
+
- BC
|
|
4159
|
+
- MB
|
|
4160
|
+
- NB
|
|
4161
|
+
- NL
|
|
4162
|
+
- NT
|
|
4163
|
+
- NS
|
|
4164
|
+
- NU
|
|
4165
|
+
- 'ON'
|
|
4166
|
+
- PE
|
|
4167
|
+
- QC
|
|
4168
|
+
- SK
|
|
4169
|
+
- YT
|
|
4170
|
+
StateCode:
|
|
4171
|
+
type: string
|
|
4172
|
+
description: Abbreviation of the state; the state is required only for US and Canada.
|
|
4173
|
+
example: NY
|
|
4174
|
+
enum:
|
|
4175
|
+
- AL
|
|
4176
|
+
- AK
|
|
4177
|
+
- AZ
|
|
4178
|
+
- AR
|
|
4179
|
+
- CA
|
|
4180
|
+
- CO
|
|
4181
|
+
- CT
|
|
4182
|
+
- DE
|
|
4183
|
+
- DC
|
|
4184
|
+
- FL
|
|
4185
|
+
- GA
|
|
4186
|
+
- HI
|
|
4187
|
+
- ID
|
|
4188
|
+
- IL
|
|
4189
|
+
- IN
|
|
4190
|
+
- IA
|
|
4191
|
+
- KS
|
|
4192
|
+
- KY
|
|
4193
|
+
- LA
|
|
4194
|
+
- ME
|
|
4195
|
+
- MD
|
|
4196
|
+
- MA
|
|
4197
|
+
- MI
|
|
4198
|
+
- MN
|
|
4199
|
+
- MS
|
|
4200
|
+
- MO
|
|
4201
|
+
- MT
|
|
4202
|
+
- NE
|
|
4203
|
+
- NV
|
|
4204
|
+
- NH
|
|
4205
|
+
- NJ
|
|
4206
|
+
- NM
|
|
4207
|
+
- NY
|
|
4208
|
+
- NC
|
|
4209
|
+
- ND
|
|
4210
|
+
- OH
|
|
4211
|
+
- OK
|
|
4212
|
+
- OR
|
|
4213
|
+
- PA
|
|
4214
|
+
- RI
|
|
4215
|
+
- SC
|
|
4216
|
+
- SD
|
|
4217
|
+
- TN
|
|
4218
|
+
- TX
|
|
4219
|
+
- UT
|
|
4220
|
+
- VT
|
|
4221
|
+
- VA
|
|
4222
|
+
- WA
|
|
4223
|
+
- WV
|
|
4224
|
+
- WI
|
|
4225
|
+
- WY
|
|
4226
|
+
- AB
|
|
4227
|
+
- BC
|
|
4228
|
+
- MB
|
|
4229
|
+
- NB
|
|
4230
|
+
- NL
|
|
4231
|
+
- NT
|
|
4232
|
+
- NS
|
|
4233
|
+
- NU
|
|
4234
|
+
- 'ON'
|
|
4235
|
+
- PE
|
|
4236
|
+
- QC
|
|
4237
|
+
- SK
|
|
4238
|
+
- YT
|
|
4239
|
+
Tariff:
|
|
4240
|
+
type: object
|
|
4241
|
+
properties:
|
|
4242
|
+
status:
|
|
4243
|
+
type: string
|
|
4244
|
+
example: success
|
|
4245
|
+
tariff:
|
|
4246
|
+
type: object
|
|
4247
|
+
properties:
|
|
4248
|
+
price_netto:
|
|
4249
|
+
type: number
|
|
4250
|
+
format: float
|
|
4251
|
+
example: 28.87
|
|
4252
|
+
price_brutto:
|
|
4253
|
+
type: number
|
|
4254
|
+
format: float
|
|
4255
|
+
example: 28.87
|
|
4256
|
+
packages:
|
|
4257
|
+
type: array
|
|
4258
|
+
items:
|
|
4259
|
+
type: object
|
|
4260
|
+
properties:
|
|
4261
|
+
packageId:
|
|
4262
|
+
type: integer
|
|
4263
|
+
example: 1
|
|
4264
|
+
volumeWeight:
|
|
4265
|
+
type: number
|
|
4266
|
+
format: float
|
|
4267
|
+
example: 0.26
|
|
4268
|
+
id:
|
|
4269
|
+
type: integer
|
|
4270
|
+
example: 1
|
|
4271
|
+
shipper_id:
|
|
4272
|
+
type: integer
|
|
4273
|
+
example: 1
|
|
4274
|
+
tariff_type_id:
|
|
4275
|
+
type: integer
|
|
4276
|
+
example: 1
|
|
4277
|
+
dispatch_id:
|
|
4278
|
+
type: integer
|
|
4279
|
+
example: 1
|
|
4280
|
+
package_type_ids:
|
|
4281
|
+
type: string
|
|
4282
|
+
example: 7,9,11,14
|
|
4283
|
+
country_id:
|
|
4284
|
+
type: integer
|
|
4285
|
+
example: 1
|
|
4286
|
+
transfer:
|
|
4287
|
+
type: string
|
|
4288
|
+
example: export
|
|
4289
|
+
printer_required:
|
|
4290
|
+
type: integer
|
|
4291
|
+
example: 1
|
|
4292
|
+
from_company_only:
|
|
4293
|
+
type: integer
|
|
4294
|
+
example: 1
|
|
4295
|
+
to_company_only:
|
|
4296
|
+
type: integer
|
|
4297
|
+
example: 1
|
|
4298
|
+
from_private_only:
|
|
4299
|
+
type: integer
|
|
4300
|
+
example: 1
|
|
4301
|
+
to_private_only:
|
|
4302
|
+
type: integer
|
|
4303
|
+
example: 1
|
|
4304
|
+
from_phone_number_required:
|
|
4305
|
+
type: integer
|
|
4306
|
+
example: 1
|
|
4307
|
+
to_phone_number_required:
|
|
4308
|
+
type: integer
|
|
4309
|
+
example: 1
|
|
4310
|
+
hs_tariff_number_required:
|
|
4311
|
+
type: integer
|
|
4312
|
+
example: 1
|
|
4313
|
+
calculate_volume_weight:
|
|
4314
|
+
type: integer
|
|
4315
|
+
example: 1
|
|
4316
|
+
volume_weight_factor:
|
|
4317
|
+
type: integer
|
|
4318
|
+
example: 5000
|
|
4319
|
+
marketing_discount:
|
|
4320
|
+
type: number
|
|
4321
|
+
format: float
|
|
4322
|
+
example: 2
|
|
4323
|
+
marketing_discount_valid_until:
|
|
4324
|
+
type: string
|
|
4325
|
+
format: date
|
|
4326
|
+
description: Last date for marketing discount
|
|
4327
|
+
example: '2020-02-07'
|
|
4328
|
+
delivery_on_saturday:
|
|
4329
|
+
type: integer
|
|
4330
|
+
example: 1
|
|
4331
|
+
guaranteed_delivery_date:
|
|
4332
|
+
type: integer
|
|
4333
|
+
example: 1
|
|
4334
|
+
loading_aid:
|
|
4335
|
+
type: integer
|
|
4336
|
+
example: 1
|
|
4337
|
+
best_offer_order:
|
|
4338
|
+
type: integer
|
|
4339
|
+
example: 30
|
|
4340
|
+
environmentally_friendly_order:
|
|
4341
|
+
type: integer
|
|
4342
|
+
example: 50
|
|
4343
|
+
marketing_discount_type:
|
|
4344
|
+
type: string
|
|
4345
|
+
example: normal
|
|
4346
|
+
marketing_discount_countdown_time_from:
|
|
4347
|
+
type: string
|
|
4348
|
+
description: Start marketing discount time
|
|
4349
|
+
example: '07:00:00'
|
|
4350
|
+
marketing_discount_countdown_time_until:
|
|
4351
|
+
type: string
|
|
4352
|
+
description: Latest marketing discount time
|
|
4353
|
+
example: '15:00:00'
|
|
4354
|
+
daily_auto_scheduled_pickup_required:
|
|
4355
|
+
type: integer
|
|
4356
|
+
example: 1
|
|
4357
|
+
is_plus_product:
|
|
4358
|
+
type: boolean
|
|
4359
|
+
example: false
|
|
4360
|
+
is_trackable_product:
|
|
4361
|
+
type: boolean
|
|
4362
|
+
example: false
|
|
4363
|
+
is_insurable_product:
|
|
4364
|
+
type: boolean
|
|
4365
|
+
example: false
|
|
4366
|
+
seller_customerNumber:
|
|
4367
|
+
type: string
|
|
4368
|
+
surcharge_per_kg:
|
|
4369
|
+
type: integer
|
|
4370
|
+
example: 1
|
|
4371
|
+
surcharge_per_kg_min:
|
|
4372
|
+
type: integer
|
|
4373
|
+
example: 1
|
|
4374
|
+
shipper_tariff_id:
|
|
4375
|
+
type: integer
|
|
4376
|
+
example: 2
|
|
4377
|
+
name:
|
|
4378
|
+
type: string
|
|
4379
|
+
example: UPS EXPRESS SAVER ®
|
|
4380
|
+
shipper_tariff_zone_id:
|
|
4381
|
+
type: integer
|
|
4382
|
+
example: 13
|
|
4383
|
+
transit_time_min:
|
|
4384
|
+
type: integer
|
|
4385
|
+
example: 2
|
|
4386
|
+
transit_time_max:
|
|
4387
|
+
type: integer
|
|
4388
|
+
example: 3
|
|
4389
|
+
delivery_time_until:
|
|
4390
|
+
type: string
|
|
4391
|
+
description: Latest delivery time
|
|
4392
|
+
example: '18:00:00'
|
|
4393
|
+
store_delivery:
|
|
4394
|
+
type: integer
|
|
4395
|
+
example: 1
|
|
4396
|
+
pickup_surcharge:
|
|
4397
|
+
type: integer
|
|
4398
|
+
example: 0
|
|
4399
|
+
shipper_tariff_zone_country_id:
|
|
4400
|
+
type: integer
|
|
4401
|
+
example: 222
|
|
4402
|
+
shippingType:
|
|
4403
|
+
type: integer
|
|
4404
|
+
example: 1
|
|
4405
|
+
currency:
|
|
4406
|
+
$ref: '#/definitions/CurrencyCode'
|
|
4407
|
+
individual_customer_tariff:
|
|
4408
|
+
type: boolean
|
|
4409
|
+
example: false
|
|
4410
|
+
external_tariff:
|
|
4411
|
+
type: boolean
|
|
4412
|
+
example: false
|
|
4413
|
+
total_weight:
|
|
4414
|
+
type: integer
|
|
4415
|
+
example: 5
|
|
4416
|
+
shipper_group_id:
|
|
4417
|
+
type: integer
|
|
4418
|
+
example: 1
|
|
4419
|
+
shipper:
|
|
4420
|
+
type: object
|
|
4421
|
+
properties:
|
|
4422
|
+
name:
|
|
4423
|
+
type: string
|
|
4424
|
+
example: UPS Express
|
|
4425
|
+
tracking_link:
|
|
4426
|
+
type: string
|
|
4427
|
+
example: http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=de_DE&InquiryNumber=
|
|
4428
|
+
agb_link:
|
|
4429
|
+
type: string
|
|
4430
|
+
example: https://www.ups.com/media/de/terms_carriage_ger.pdf
|
|
4431
|
+
transit_time_link:
|
|
4432
|
+
type: string
|
|
4433
|
+
example: https://wwwapps.ups.com/ctc/request?loc=de_DE
|
|
4434
|
+
limits:
|
|
4435
|
+
type: array
|
|
4436
|
+
items:
|
|
4437
|
+
type: object
|
|
4438
|
+
properties:
|
|
4439
|
+
operant:
|
|
4440
|
+
type: string
|
|
4441
|
+
example: girth
|
|
4442
|
+
operator:
|
|
4443
|
+
type: string
|
|
4444
|
+
example: <=
|
|
4445
|
+
value:
|
|
4446
|
+
type: integer
|
|
4447
|
+
example: 419
|
|
4448
|
+
ShipperGroupName:
|
|
4449
|
+
type: string
|
|
4450
|
+
example: UPS
|
|
4451
|
+
image:
|
|
4452
|
+
type: string
|
|
4453
|
+
example: /img/versandrechner/tarife/upsneu.png
|
|
4454
|
+
shopName:
|
|
4455
|
+
type: string
|
|
4456
|
+
example: UPS Access Point
|
|
4457
|
+
shopsName:
|
|
4458
|
+
type: string
|
|
4459
|
+
example: PaketShops
|
|
4460
|
+
hasShopFinder:
|
|
4461
|
+
type: boolean
|
|
4462
|
+
example: true
|
|
4463
|
+
dates:
|
|
4464
|
+
type: object
|
|
4465
|
+
properties:
|
|
4466
|
+
pickup:
|
|
4467
|
+
type: object
|
|
4468
|
+
properties:
|
|
4469
|
+
pickupTimeMinPeriodMinutes:
|
|
4470
|
+
type: integer
|
|
4471
|
+
example: 120
|
|
4472
|
+
date:
|
|
4473
|
+
type: string
|
|
4474
|
+
format: date
|
|
4475
|
+
example: '2020-06-05'
|
|
4476
|
+
dateFormat:
|
|
4477
|
+
type: string
|
|
4478
|
+
format: date
|
|
4479
|
+
example: 05.06.2020
|
|
4480
|
+
day:
|
|
4481
|
+
type: integer
|
|
4482
|
+
example: 5
|
|
4483
|
+
dayFormat:
|
|
4484
|
+
type: string
|
|
4485
|
+
example: Freitag
|
|
4486
|
+
dayFormatShort:
|
|
4487
|
+
type: string
|
|
4488
|
+
example: Fr.
|
|
4489
|
+
month:
|
|
4490
|
+
type: string
|
|
4491
|
+
example: Jun
|
|
4492
|
+
monthFormat:
|
|
4493
|
+
type: string
|
|
4494
|
+
example: Juni
|
|
4495
|
+
dateFormatShort:
|
|
4496
|
+
type: string
|
|
4497
|
+
example: Di., 2. Jun.
|
|
4498
|
+
timeFrom:
|
|
4499
|
+
type: string
|
|
4500
|
+
format: time
|
|
4501
|
+
example: '03:00'
|
|
4502
|
+
timeFromMinutes:
|
|
4503
|
+
type: integer
|
|
4504
|
+
example: 180
|
|
4505
|
+
timeFromFormat:
|
|
4506
|
+
type: string
|
|
4507
|
+
format: time
|
|
4508
|
+
example: 13:45 Uhr
|
|
4509
|
+
timeUntil:
|
|
4510
|
+
type: string
|
|
4511
|
+
format: time
|
|
4512
|
+
example: '01:00'
|
|
4513
|
+
timeUntilMinutes:
|
|
4514
|
+
type: integer
|
|
4515
|
+
example: 60
|
|
4516
|
+
timeUntilFormat:
|
|
4517
|
+
type: string
|
|
4518
|
+
format: time
|
|
4519
|
+
example: 15:45 Uhr
|
|
4520
|
+
min_pickup_date:
|
|
4521
|
+
type: string
|
|
4522
|
+
format: date
|
|
4523
|
+
example: '2020-06-02'
|
|
4524
|
+
transit_time_min:
|
|
4525
|
+
type: object
|
|
4526
|
+
properties:
|
|
4527
|
+
date:
|
|
4528
|
+
type: string
|
|
4529
|
+
format: date
|
|
4530
|
+
example: '2020-06-05'
|
|
4531
|
+
dateFormat:
|
|
4532
|
+
type: string
|
|
4533
|
+
format: date
|
|
4534
|
+
example: 05.06.2020
|
|
4535
|
+
day:
|
|
4536
|
+
type: integer
|
|
4537
|
+
example: 5
|
|
4538
|
+
dayFormat:
|
|
4539
|
+
type: string
|
|
4540
|
+
example: Freitag
|
|
4541
|
+
dayFormatShort:
|
|
4542
|
+
type: string
|
|
4543
|
+
example: Fr.
|
|
4544
|
+
month:
|
|
4545
|
+
type: string
|
|
4546
|
+
example: Jun
|
|
4547
|
+
transit_time_max:
|
|
4548
|
+
type: object
|
|
4549
|
+
properties:
|
|
4550
|
+
date:
|
|
4551
|
+
type: string
|
|
4552
|
+
format: date
|
|
4553
|
+
example: '2020-06-05'
|
|
4554
|
+
dateFormat:
|
|
4555
|
+
type: string
|
|
4556
|
+
format: date
|
|
4557
|
+
example: 05.06.2020
|
|
4558
|
+
day:
|
|
4559
|
+
type: integer
|
|
4560
|
+
example: 5
|
|
4561
|
+
dayFormat:
|
|
4562
|
+
type: string
|
|
4563
|
+
example: Freitag
|
|
4564
|
+
dayFormatShort:
|
|
4565
|
+
type: string
|
|
4566
|
+
example: Fr.
|
|
4567
|
+
month:
|
|
4568
|
+
type: string
|
|
4569
|
+
example: Jun
|
|
4570
|
+
monthFormat:
|
|
4571
|
+
type: string
|
|
4572
|
+
example: Juni
|
|
4573
|
+
delivery:
|
|
4574
|
+
type: object
|
|
4575
|
+
properties:
|
|
4576
|
+
timeUntilFormat:
|
|
4577
|
+
type: string
|
|
4578
|
+
example: 16 Uhr
|
|
4579
|
+
day:
|
|
4580
|
+
type: string
|
|
4581
|
+
example: 4 - 5
|
|
4582
|
+
dayFormat:
|
|
4583
|
+
type: string
|
|
4584
|
+
example: Do. / Fr.
|
|
4585
|
+
monthFormat:
|
|
4586
|
+
type: string
|
|
4587
|
+
example: Juni
|
|
4588
|
+
dateFormatShort:
|
|
4589
|
+
type: string
|
|
4590
|
+
example: Do., 4. Jun. - Fr., 5. Jun.
|
|
4591
|
+
transit_time_range:
|
|
4592
|
+
type: object
|
|
4593
|
+
properties:
|
|
4594
|
+
days:
|
|
4595
|
+
type: string
|
|
4596
|
+
description: Days range for delivery or hours
|
|
4597
|
+
example: 2-3
|
|
4598
|
+
daysString:
|
|
4599
|
+
type: string
|
|
4600
|
+
description: A full description of days units with translation
|
|
4601
|
+
example: working days
|
|
4602
|
+
daysStringShort:
|
|
4603
|
+
type: string
|
|
4604
|
+
description: A short description of days units with translation
|
|
4605
|
+
example: d
|
|
4606
|
+
pickupTimeMinPeriodMinutes:
|
|
4607
|
+
type: integer
|
|
4608
|
+
example: 120
|
|
4609
|
+
pickupSliderUsed:
|
|
4610
|
+
type: boolean
|
|
4611
|
+
example: false
|
|
4612
|
+
pickupSliderUsedMessageShown:
|
|
4613
|
+
type: boolean
|
|
4614
|
+
example: false
|
|
4615
|
+
sliderDraggableRange:
|
|
4616
|
+
type: boolean
|
|
4617
|
+
example: false
|
|
4618
|
+
sliderDraggableRangeInt:
|
|
4619
|
+
type: integer
|
|
4620
|
+
example: 1
|
|
4621
|
+
same_day_pickup:
|
|
4622
|
+
type: boolean
|
|
4623
|
+
example: true
|
|
4624
|
+
has_pickup_surcharge:
|
|
4625
|
+
type: boolean
|
|
4626
|
+
example: false
|
|
4627
|
+
deliveryMaxDaysFromNowOrder:
|
|
4628
|
+
type: number
|
|
4629
|
+
format: float
|
|
4630
|
+
example: 2.01
|
|
4631
|
+
deliveryTimeUntilInMinutes:
|
|
4632
|
+
type: integer
|
|
4633
|
+
example: 840
|
|
4634
|
+
printerIsRequired:
|
|
4635
|
+
type: integer
|
|
4636
|
+
example: 1
|
|
4637
|
+
tax_free:
|
|
4638
|
+
type: boolean
|
|
4639
|
+
example: false
|
|
4640
|
+
tax_free_reason:
|
|
4641
|
+
type: string
|
|
4642
|
+
example: third_country_transfer
|
|
4643
|
+
tax_rate:
|
|
4644
|
+
type: number
|
|
4645
|
+
format: float
|
|
4646
|
+
example: 19
|
|
4647
|
+
tax_name:
|
|
4648
|
+
type: string
|
|
4649
|
+
example: MwSt.
|
|
4650
|
+
tax_countryCode:
|
|
4651
|
+
$ref: '#/definitions/CountryCode'
|
|
4652
|
+
hasAreaSurcharge:
|
|
4653
|
+
type: boolean
|
|
4654
|
+
example: false
|
|
4655
|
+
extra_export_license_price_brutto:
|
|
4656
|
+
type: integer
|
|
4657
|
+
example: 0
|
|
4658
|
+
extra_insurance_value:
|
|
4659
|
+
type: integer
|
|
4660
|
+
example: 1000
|
|
4661
|
+
extra_insurance_price_netto:
|
|
4662
|
+
type: integer
|
|
4663
|
+
example: 20
|
|
4664
|
+
extra_insurance_price_brutto:
|
|
4665
|
+
type: integer
|
|
4666
|
+
example: 20
|
|
4667
|
+
insurance_value:
|
|
4668
|
+
type: integer
|
|
4669
|
+
example: 510
|
|
4670
|
+
price_netto_uvp:
|
|
4671
|
+
type: number
|
|
4672
|
+
format: float
|
|
4673
|
+
example: 8.87
|
|
4674
|
+
price_brutto_uvp:
|
|
4675
|
+
type: number
|
|
4676
|
+
format: float
|
|
4677
|
+
example: 28.87
|
|
4678
|
+
marketing_discount_title:
|
|
4679
|
+
type: string
|
|
4680
|
+
example: title
|
|
4681
|
+
marketing_discount_description:
|
|
4682
|
+
type: string
|
|
4683
|
+
example: description
|
|
4684
|
+
uvp_discount_value:
|
|
4685
|
+
type: integer
|
|
4686
|
+
example: 0
|
|
4687
|
+
uvp_discount_percent:
|
|
4688
|
+
type: integer
|
|
4689
|
+
example: 0
|
|
4690
|
+
uvp_discount_type:
|
|
4691
|
+
type: string
|
|
4692
|
+
example: customer
|
|
4693
|
+
requestType:
|
|
4694
|
+
type: string
|
|
4695
|
+
example: m
|
|
4696
|
+
best_offer_best_price_order:
|
|
4697
|
+
type: integer
|
|
4698
|
+
example: 3
|
|
4699
|
+
pickupTimeFromMinutesSelected:
|
|
4700
|
+
type: integer
|
|
4701
|
+
example: 705
|
|
4702
|
+
pickupTimeUntilMinutesSelected:
|
|
4703
|
+
type: integer
|
|
4704
|
+
example: 825
|
|
4705
|
+
pickupCountryHolidays:
|
|
4706
|
+
type: object
|
|
4707
|
+
properties:
|
|
4708
|
+
'2018-03-30':
|
|
4709
|
+
type: integer
|
|
4710
|
+
example: 1
|
|
4711
|
+
description: if data is a holiday
|
|
4712
|
+
TrackingAddress:
|
|
4713
|
+
type: object
|
|
4714
|
+
properties:
|
|
4715
|
+
country:
|
|
4716
|
+
$ref: '#/definitions/Country'
|
|
4717
|
+
TrackingDates:
|
|
4718
|
+
type: object
|
|
4719
|
+
properties:
|
|
4720
|
+
created:
|
|
4721
|
+
type: string
|
|
4722
|
+
format: date-time
|
|
4723
|
+
description: Creation date of the tracker
|
|
4724
|
+
example: '2017-12-21T17:41:24Z'
|
|
4725
|
+
modified:
|
|
4726
|
+
type: string
|
|
4727
|
+
format: date-time
|
|
4728
|
+
description: Date on which the tracker was last modified
|
|
4729
|
+
example: '2017-12-22T17:41:24Z'
|
|
4730
|
+
last_updated:
|
|
4731
|
+
type: string
|
|
4732
|
+
format: date-time
|
|
4733
|
+
description: Date on which the tracker information was last updated
|
|
4734
|
+
example: '2017-12-21T19:41:24Z'
|
|
4735
|
+
TrackingCarrier:
|
|
4736
|
+
type: string
|
|
4737
|
+
description: Tracking Carrier Code
|
|
4738
|
+
enum:
|
|
4739
|
+
- aramex
|
|
4740
|
+
- belgium-post
|
|
4741
|
+
- cargointl-de
|
|
4742
|
+
- chronopost
|
|
4743
|
+
- colissimo
|
|
4744
|
+
- derkurier
|
|
4745
|
+
- dhl
|
|
4746
|
+
- dhl-active
|
|
4747
|
+
- dhl-germany
|
|
4748
|
+
- dpd
|
|
4749
|
+
- dpd-uk
|
|
4750
|
+
- exapaq
|
|
4751
|
+
- fedex
|
|
4752
|
+
- gls
|
|
4753
|
+
- hermes-de
|
|
4754
|
+
- jumingo
|
|
4755
|
+
- jumingo-cargo
|
|
4756
|
+
- parcel-force
|
|
4757
|
+
- skynetworldwide
|
|
4758
|
+
- tnt
|
|
4759
|
+
- ups
|
|
4760
|
+
TrackingStep:
|
|
4761
|
+
type: object
|
|
4762
|
+
properties:
|
|
4763
|
+
date:
|
|
4764
|
+
type: string
|
|
4765
|
+
description: Date of tracking information
|
|
4766
|
+
example: '2017-12-16'
|
|
4767
|
+
time:
|
|
4768
|
+
type: string
|
|
4769
|
+
description: Time of tracking information
|
|
4770
|
+
example: '13:56'
|
|
4771
|
+
type:
|
|
4772
|
+
type: string
|
|
4773
|
+
description: The type of tracking information. The text comes directly from the respective carrier. This is usually a free text, which is very different depending on the carrier. As a rule, one cannot rely on the expressiveness of the texts; in addition, the texts could be changed by the carrier at any time. Please always read the actual tracking status from the ShipmentTracking's status field.
|
|
4774
|
+
example: The shipment has been dropped off and is now at a ups access point.
|
|
4775
|
+
location:
|
|
4776
|
+
type: string
|
|
4777
|
+
description: The location of the scan. The text comes directly from the respective carrier. The format and information density varies considerably depending on the carrier and region. Mostly the country code is included, sometimes also the city.
|
|
4778
|
+
example: STANFORD LE HOPE, GB
|