-
Notifications
You must be signed in to change notification settings - Fork 35
Expand file tree
/
Copy pathProtectedDeliveryToken.yaml
More file actions
934 lines (933 loc) · 32.8 KB
/
Copy pathProtectedDeliveryToken.yaml
File metadata and controls
934 lines (933 loc) · 32.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
openapi: 3.1.0
info:
title: PIN Management System API v1
description: |
The Protected Delivery Token or the PIN Management System API is a part of Verified Delivery that will offer shippers extra security to ensure the package is delivered to the intended recipient. A secure PIN will be required to release the package for delivery.
version: "1.0"
tags:
- name: tokens
description: "A Public API which handles operations related to creating a token"
- name: pins
description: "Operations related to retrieving a PIN by token and retrieving PINs for the list of tracking numbers"
- name: epra
description: "Operations related to retrieving the EPRA release code and related actions for a given tracking number"
servers:
- url: https://onlinetools.ups.com/api/pin-mgmt-sys/{version}
description: external url for PIN Management System
variables:
version:
description: API version
default: v1
enum:
- v1
paths:
/pins/token:
post:
tags:
- Protected Delivery Token
operationId: generateToken
summary: Generate Token
description: |
This endpoint is used to generate a token using Shipper generated PIN
parameters:
- $ref: '#/components/parameters/transID'
- $ref: '#/components/parameters/transactionSrc'
security:
- OAuth2: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTokenRequest'
example:
pin: "123456"
responses:
'200':
description: Token is generated successfully
headers:
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTokenResponse'
example:
token: "550e8400-e29b-41d4-a716-446655440000"
'400':
description: "Missing required values or incorrect values or validation fails"
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Missing pin:
value:
errors:
- code: "50001"
message: "Pin is required for request"
'401':
description: Unauthorized
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Invalid Token:
value:
errors:
- code: "250002"
message: "Invalid Authentication Information"
'403':
description: Forbidden
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Forbidden:
value:
errors:
- code: "40301"
message: "You do not have permission to access this resource."
'404':
description: Not Found
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
NotFound:
value:
errors:
- code: "40401"
message: "The specified resource was not found."
'415':
description: Unsupported Media Type
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
UnsupportedMediaType:
value:
errors:
- code: "41501"
message: "The server cannot process the request because the payload format is not supported."
'429':
description: Too Many Requests
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
TooManyRequests:
value:
errors:
- code: "42901"
message: "You have sent too many requests in a short period. Please try again later."
'500':
description: Internal Server Error
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
InternalServerError:
value:
errors:
- code: "10067"
message: "Internal Server Error"
get:
tags:
- Protected Delivery Token
operationId: getPinByToken
summary: Get Pin by Token
description: |
This endpoint is used to get Pin by Token.
parameters:
- name: X-UserToken
in: header
required: true
description: Token generated by Generate Token API
schema:
type: string
format: uuid
- $ref: '#/components/parameters/transID'
- $ref: '#/components/parameters/transactionSrc'
security:
- OAuth2: []
responses:
'200':
description: Pin is returned successfully
headers:
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/GetPinByTokenResponse'
example:
pin: "123456"
'400':
description: "Missing required values or incorrect values or validation fails"
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Missing Required Value:
value:
errors:
- code: "50001"
message: "Token is required for request"
'401':
description: Unauthorized
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Invalid Token:
value:
errors:
- code: "250002"
message: "Invalid Authentication Information"
'403':
description: Forbidden
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Forbidden:
value:
errors:
- code: "40301"
message: "You do not have permission to access this resource."
'404':
description: Not Found
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
NotFound:
value:
errors:
- code: "40401"
message: "The specified resource was not found."
'429':
description: Too Many Requests
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
TooManyRequests:
value:
errors:
- code: "42901"
message: "You have sent too many requests in a short period. Please try again later."
'500':
description: Internal Server Error
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
InternalServerError:
value:
errors:
- code: "10067"
message: "Internal Server Error"
/pins/retrieve:
post:
tags:
- Protected Delivery Token
operationId: getPinsForTrackingNumberList
summary: Get Pins for the list of Tracking Numbers
description: |
This endpoint is used to get Pins for the list of Tracking Numbers.
parameters:
- $ref: '#/components/parameters/transID'
- $ref: '#/components/parameters/transactionSrc'
security:
- OAuth2: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetPinsForTrackingNumberListRequest'
example:
trackingNumbers: ["1Z999AA10123456784","1Z999AA10123456785","1Z999AA10123456786"]
responses:
'200':
description: Pins are returned successfully
headers:
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/GetPinsForTrackingNumberListResponse'
example:
results:
- trackingNumber: "1Z999AA10123456784"
pin: "123456"
- trackingNumber: "1Z999AA10123456785"
pin: "005678"
'400':
description: "Missing required values or incorrect values or validation fails"
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Missing Required Value:
value:
errors:
- code: "50001"
message: "Tracking Numbers are required for request"
'401':
description: Unauthorized
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Invalid Token:
value:
errors:
- code: "250002"
message: "Invalid Authentication Information"
'403':
description: Forbidden
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Forbidden:
value:
errors:
- code: "40301"
message: "You do not have permission to access this resource."
'404':
description: Not Found
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
NotFound:
value:
errors:
- code: "40401"
message: "The specified resource was not found."
'415':
description: Unsupported Media Type
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
UnsupportedMediaType:
value:
errors:
- code: "41501"
message: "The server cannot process the request because the payload format is not supported."
'429':
description: Too Many Requests
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
TooManyRequests:
value:
errors:
- code: "42901"
message: "You have sent too many requests in a short period. Please try again later."
'500':
description: Internal Server Error
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
InternalServerError:
value:
errors:
- code: "10067"
message: "Internal Server Error"
/pins/epra:
get:
tags:
- Protected Delivery Token
operationId: getEPRACodeAndActions
summary: Get EPRA (Electronic Package Release Authentication) release code and related actions
description: |
This endpoint retrieves the EPRA release code and related actions for a given tracking number. The EPRA release code is used to determine the necessary steps for package release in the Verified Delivery process.
security:
- OAuth2: []
parameters:
- name: action
in: query
required: false
schema:
type: string
- name: trackingNumber
in: header
required: true
schema:
type: string
- name: epra
in: header
required: false
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
- $ref: '#/components/parameters/transID'
- $ref: '#/components/parameters/transactionSrc'
responses:
'200':
description: EPRA response.
headers:
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/EpraResponse'
example:
response:
epraCode: "EPRA123"
epraRequired: "Yes"
epraMatch: "No"
epraKiala: "N/A"
'400':
description: Invalid request.
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Missing required header(s) in request:
value:
errors:
- code: "10013"
message: "Missing required header(s) in request"
'401':
description: Unauthorized.
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Invalid Token:
value:
errors:
- code: "250002"
message: "Invalid Authentication Information"
'403':
description: Forbidden.
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Forbidden:
value:
errors:
- code: "40301"
message: "You do not have permission to access this resource."
'404':
description: EPRA or tracking record not found.
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
NotFound:
value:
errors:
- code: "40401"
message: "The specified resource was not found."
'429':
description: Too many requests.
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
TooManyRequests:
value:
errors:
- code: "42901"
message: "You have sent too many requests in a short period. Please try again later."
'500':
description: Internal error.
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
SQL exception experienced:
value:
errors:
- code: "90401"
message: "SQL exception experienced"
'501':
description: EPRA service not implemented.
headers:
APIErrorCode:
$ref: '#/components/headers/APIErrorCode'
APIErrorMsg:
$ref: '#/components/headers/APIErrorMsg'
BkndTransId:
$ref: '#/components/headers/BkndTransId'
transactionSrc:
$ref: '#/components/headers/transactionSrc'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Not Implemented:
value:
errors:
- code: "10068"
message: "The webservice is disabled"
components:
parameters:
transID:
name: transID
in: header
required: true
description: Transaction ID
schema:
type: string
transactionSrc:
name: transactionSrc
in: header
required: true
description: Transaction Source
schema:
type: string
headers:
BkndTransId:
description: The backend uuid transaction id.
schema:
type: string
transactionSrc:
description: Identifies the client/source application that is calling.
schema:
type: string
APIErrorCode:
description: The API error code.
schema:
type: string
APIErrorMsg:
description: The API error message
schema:
type: string
schemas:
GenerateTokenRequest:
type: object
properties:
pin:
type: string
pattern: '^[0-9]{4,6}$'
minLength: 4
maxLength: 6
description: The Pin for which the token is generated (4 to 6 digits, leading zeros allowed; e.g., 0007).
required:
- pin
description: 'This request is sent to generate a token for a given Pin.'
title: GenerateTokenRequest
GenerateTokenResponse:
type: object
properties:
token:
type: string
description: The generated token for the given Pin.
required:
- token
description: 'This response returns the generated token for the given Pin.'
title: GenerateTokenResponse
GetPinByTokenResponse:
type: object
properties:
pin:
type: string
pattern: '^[0-9]{4,6}$'
minLength: 4
maxLength: 6
description: The Pin associated with the given token (4 to 6 digits, leading zeros allowed; e.g., 0007).
required:
- pin
description: 'This response returns the Pin associated with the given token.'
title: GetPinByTokenResponse
GetPinsForTrackingNumberListRequest:
type: object
properties:
trackingNumbers:
type: array
maxItems: 100
minItems: 1
items:
type: string
pattern: '^1Z[A-Z0-9]{16}$'
description: Tracking number
description: A list of tracking numbers for which the Pins are requested.
required:
- trackingNumbers
description: 'This request is sent to retrieve Pins for a list of tracking numbers.'
title: GetPinsForTrackingNumberListRequest
GetPinsForTrackingNumberListResponse:
type: object
properties:
results:
type: array
minItems: 1
items:
type: object
properties:
trackingNumber:
type: string
pattern: '^1Z[A-Z0-9]{16}$'
description: The tracking number associated with the Pin.
pin:
type: string
pattern: '^[0-9]{4,6}$'
minLength: 4
maxLength: 6
description: The Pin associated with the given tracking number (4 to 6 digits, leading zeros allowed; e.g., 0007).
required:
- trackingNumber
- pin
required:
- results
description: 'This response returns a list of tracking numbers and their associated Pins.'
title: GetPinsForTrackingNumberListResponse
EpraResponse:
type: object
properties:
response:
$ref: '#/components/schemas/EpraElement'
required: [response]
description: 'This response returns the EPRA release code and related actions for a given tracking number.'
title: EpraResponse
EpraElement:
type: object
properties:
epraCode:
type: string
epraRequired:
type: string
epraMatch:
type: string
epraKiala:
type: string
ErrorResponse:
type: object
required:
- errors
properties:
errors:
type: array
minItems: 1
items:
$ref: '#/components/schemas/Error'
description: "Standardized error object for responses and callbacks."
description: 'This response is returned when an error occurs, containing a list of error objects with standardized error codes and messages.'
title: ErrorResponse
Error:
type: object
required:
- code
- message
properties:
code:
type: string
description: "Error code"
message:
type: string
description: "Human-readable error message providing additional context about the error."
description: 'This object represents an error, containing a standardized error code and a human-readable message.'
title: Error
WarningResponse:
type: object
properties:
response:
$ref: '#/components/schemas/Warning'
required: [response]
description: 'This response returns warnings related to the request.'
title: WarningResponse
Warning:
type: object
properties:
code:
type: string
description: "Warning code"
message:
type: string
description: "Human-readable warning message providing additional context about the warning."
description: 'This object represents a warning, containing a standardized warning code and a human-readable message.'
title: Warning
securitySchemes:
OAuth2:
type: oauth2
flows:
clientCredentials:
x-tokenEndpointAuthMethod: client_secret_basic
tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token
scopes: {}