-
Notifications
You must be signed in to change notification settings - Fork 20
/
Copy pathDeliveryIntercept.yaml
2410 lines (2385 loc) · 93.8 KB
/
DeliveryIntercept.yaml
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
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: Delivery Intercept® API
description: |
With the UPS Delivery Intercept® API, a shipper can manage the delivery details of their shipment, prior to delivery.
# Business Values
**Key Business Values:**
- elimination of manually processing customer requests
- acceptance of requests later in the delivery process
<a href="https://developer.ups.com/api/reference/deliveryintercept/product-info" target="_blank" rel="noopener">Product Info</a>
<a href="https://god.gw.postman.com/run-collection/29542085-f2409ef1-39c9-4f4a-a509-a3f860068ff4?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-f2409ef1-39c9-4f4a-a509-a3f860068ff4%26entityType%3Dcollection%26workspaceId%3D7e7595f0-4829-4f9a-aee1-75c126b9d417" target="_blank" rel="noopener noreferrer">
<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">
</a>
# CIE Behavior
The Delivery Intercept API will return a stubbed success response if the correct data is used for a given endpoint. The static data that is valid for each of the endpoints is in the table below:
| Endpoint | transId | trackingNumber |
|------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| /charges | SIICharges | 1Z4096YY0316914058
| /willcall | SIIWillcall | 1Z4096YY0316914058
| /return | SIIReturn | 1Z4096YY0316914058
| /reschedule | SIIReschedule | 1Z4096YY0316914058
| /redirect/address | SIIRedirect | 1Z4096YY0316914058
| /cancel | SIICancel | 1Z4096YY0316914058
version: "1.0"
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
servers:
- url: https://wwwcie.ups.com/api/deliveryintercept/{version}
description: Customer Integration Environment
variables:
version:
default: v2
enum:
- v2
- url: https://onlinetools.ups.com/api/deliveryintercept/{version}
description: Production
variables:
version:
default: v2
enum:
- v2
security:
- OAuth2: []
paths:
/charges/{trackingNumber}:
post:
summary: charges by inquiry type
description: Obtains intercept charges specified by the inquiry type.
operationId: getCharges
tags:
- Delivery Intercept
servers:
- url: https://wwwcie.ups.com/api/deliverychange/{version}
description: Customer Integration Environment
variables:
version:
default: v2
enum:
- v2
- url: https://onlinetools.ups.com/api/deliverychange/{version}
description: Production
variables:
version:
default: v2
enum:
- v2
parameters:
- $ref: "#/components/parameters/transId"
- $ref: "#/components/parameters/transactionSrc"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Content-Type"
- $ref: "#/components/parameters/TrackingNumber"
- $ref: "#/components/parameters/Loc"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceRedirectChargesRequest'
example:
clientId: XOLT
transactionId: tm241ea77
source: "72"
loc: en_US
addressToken: e951ee064b46a43f6a17bc930e046f2a
clientIP: 10.9.65.169
trackingNumber: 1Z1144YY0125887968
infoNoticeNumber: "952895106203"
requestType: UFD
requesterContactInfo:
name: John A
telephone: "+17899977222"
phoneExt: "+1"
emailAddress: aups@ups.com
altTelephone: "+19886432748"
altPhoneExt: "+12"
displayPhoneNumber: true
ratingRequest:
- trackingNumber: 1Z1144YY0125887968
cdwIndicator: false
upgradeToGroundCharges: false
responses:
'200':
description: Successful response
headers:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceCommonResponse'
example:
transactionId: ASR1212
statusCode: "000"
statusMsg: Success
success: true
chargeInfo: [chargeCurrency: USD]
mycagreementUptoDate: false
'400':
description: Validation error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "710"
message: Failure due to input validation error
'401':
description: Authentication required
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "605"
message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/willcall/{trackingNumber}:
post:
summary: redirect a package to a Customer center for pickup.
description: Request your package to be held at or returned to a UPS facility where the receiver may claim the same-day.
operationId: submitWillCall
tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
- $ref: "#/components/parameters/transactionSrc"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Content-Type"
- $ref: "#/components/parameters/TrackingNumber"
- $ref: "#/components/parameters/Loc"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceWillCallRequest'
example:
clientId: XOLT
transactionId: tm241ea77
source: "72"
loc: en_US
addressToken: e951ee064b46a43f6a17bc930e046f2a
clientIP: 10.9.65.169
trackingNumber: 1Z1144YY0125887968
infoNoticeNumber: "952895106203"
requestType: UFD
requesterContactInfo:
name: John A
telephone: "+17899977222"
phoneExt: "+1"
emailAddress: aups@ups.com
altTelephone: "+19886432748"
altPhoneExt: "+12"
displayPhoneNumber: true
specialInstructions: Watch for dog
trackingNumberInitiated: false
originalPublicLocationId: U12345678
chargeInfo: [chargeCurrency: USD]
udiContactInfo:
name: John A
telephone: "+17899977222"
iobb: 77c1468763cb4fd58df5525d8741d174521202012563181
leadTrackingNumber: 1Z1144YY0125887968
multiTrackingNumbers: [trackingNumber: 1ZAT57900109232651]
deliveryDate: "20220128"
responses:
'200':
description: Successful response
headers:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceWillCallResponse'
example:
transactionId: ASR1212
statusCode: "000"
statusMsg: Success
success: true
chargeInfo: [chargeCurrency: USD]
mycagreementUptoDate: false
myChoiceCountry: "1"
addrToken: "12345"
upsLocation:
storeContactInfo:
name: The UPS Store
telephone: "+14107495070"
storeAddress:
addressLine1: 1147 S Salisbury Blvd
addressLine2: "Ste 8"
city: SALISBURY
state: MD
postalCode: "21801"
countryCode: US
firstName: UPS
lastName: Store
fullName: UPS Store
phoneNumber: "+19886222564"
streetAddressParsedIndicator: false
distance: "$"
distanceUOM: "MI"
longitude: "38.34523789390884"
latitude: "-75.6013502509887"
locationId: "1"
locationType: "002"
name: The UPS Store
daysOfOperation:
- hoursOfOperation:
startTime: "0900"
endTime: "2355"
closed: true
dayOfWeek: "0"
open24Hours: false
upsStoreAcctNum: "ZZ0012"
acceptsPayment: false
earlyPickUpAvailable: false
pickUpDropOffInd: false
unavailable: false
unavailableReasonCode: "01"
unavailableReasonDescription: "02"
serviceOfferingCode: "012"
serviceOfferingCodeDesc: Pay-At-Store
businessType: [{code: "001", description: bakery}]
customerCenter: false
nonStandardHours:
- hoursOfOperation: [{startTime: "0900", endTime: "2255"}]
closed: false
startDate: "06/22/2022"
endDate: "06/25/2022"
serviceOfferingCodeList: ["01", "02"]
upslocker: false
'400':
description: Validation error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "710"
message: Failure due to input validation error
'401':
description: Authentication required
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "605"
message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/return/{trackingNumber}:
post:
summary: redirect the package back to the sender
description: Return the package to the original shipper prior to delivery.
operationId: submitReturnToSender
tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
- $ref: "#/components/parameters/transactionSrc"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Content-Type"
- $ref: "#/components/parameters/TrackingNumber"
- $ref: "#/components/parameters/Loc"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceReturnToSenderRequest'
example:
clientId: XOLT
transactionId: tm241ea77
source: "72"
loc: en_US
addressToken: e951ee064b46a43f6a17bc930e046f2a
clientIP: 10.9.65.169
trackingNumber: 1Z1144YY0125887968
infoNoticeNumber: "952895106203"
requestType: UFD
requesterContactInfo:
name: John A
telephone: "+17899977222"
phoneExt: "+1"
emailAddress: aups@ups.com
altTelephone: "+19886432748"
altPhoneExt: "+12"
displayPhoneNumber: true
specialInstructions: Watch for dog
trackingNumberInitiated: false
originalPublicLocationId: U12345678
chargeInfo: [chargeCurrency: USD]
udiContactInfo:
name: John A
telephone: "+17899977222"
iobb: 77c1468763cb4fd58df5525d8741d174521202012563181
leadTrackingNumber: 1Z1144YY0125887968
multiTrackingNumbers: [trackingNumber: 1ZAT57900109232651]
reasonForReturn: AM
responses:
'200':
description: Successful response
headers:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceReturnToSenderResponse'
example:
transactionId: ASR1212
statusCode: "000"
statusMsg: Success
success: true
chargeInfo: [chargeCurrency: USD]
mycagreementUptoDate: false
addrToken: "12345"
'400':
description: Validation error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "710"
message: Failure due to input validation error
'401':
description: Authentication required
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "605"
message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/reschedule/{trackingNumber}:
post:
summary: change to a new delivery date in the future.
description: Have the package delivered to the original address but on a different day in the future.
operationId: submitRescheduleDelivery
tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
- $ref: "#/components/parameters/transactionSrc"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Content-Type"
- $ref: "#/components/parameters/TrackingNumber"
- $ref: "#/components/parameters/Loc"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceRescheduleDeliveryRequest'
example:
clientId: XOLT
transactionId: tm241ea77
source: "72"
loc: en_US
addressToken: e951ee064b46a43f6a17bc930e046f2a
clientIP: 10.9.65.169
trackingNumber: 1Z1144YY0125887968
infoNoticeNumber: "952895106203"
requestType: UFD
requesterContactInfo:
name: John A
telephone: "+17899977222"
phoneExt: "+1"
emailAddress: aups@ups.com
altTelephone: "+19886432748"
altPhoneExt: "+12"
displayPhoneNumber: true
specialInstructions: Watch for dog
trackingNumberInitiated: false
originalPublicLocationId: U12345678
chargeInfo: [chargeCurrency: USD]
udiContactInfo:
name: John A
telephone: "+17899977222"
iobb: 77c1468763cb4fd58df5525d8741d174521202012563181
leadTrackingNumber: 1Z1144YY0125887968
multiTrackingNumbers: [trackingNumber: 1ZAT57900109232651]
deliveryDate: "20190223"
responses:
'200':
description: Successful response
headers:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceRescheduleDeliveryResponse'
example:
transactionId: ASR1212
statusCode: "000"
statusMsg: Success
success: true
chargeInfo: [chargeCurrency: USD]
mycagreementUptoDate: false
myChoiceCountry: "1"
addrToken: "12345"
'400':
description: Validation error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "710"
message: Failure due to input validation error
'401':
description: Authentication required
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "605"
message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/redirect/address/{trackingNumber}:
post:
summary: Submission to request a new delivery address.
description: Deliver to a different address than on the label originally created for the shipment.
operationId: submitDeliverToAnotherAddressRequest
tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
- $ref: "#/components/parameters/transactionSrc"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Content-Type"
- $ref: "#/components/parameters/TrackingNumber"
- $ref: "#/components/parameters/Loc"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceDeliverToAnotherAddressRequest'
example:
clientId: XOLT
transactionId: tm241ea77
source: "72"
loc: en_US
addressToken: e951ee064b46a43f6a17bc930e046f2a
clientIP: 10.9.65.169
trackingNumber: 1Z1144YY0125887968
infoNoticeNumber: "952895106203"
requestType: UFD
requesterContactInfo:
name: John A
telephone: "+17899977222"
phoneExt: "+1"
emailAddress: aups@ups.com
altTelephone: "+19886432748"
altPhoneExt: "+12"
displayPhoneNumber: true
ratingRequest:
trackingNumber: 1Z1144YY0125887968
cdwIndicator: false
upgradeToGroundCharges: false
responses:
'200':
description: Successful response
headers:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceDeliverToAnotherAddressResponse'
example:
transactionId: ASR1212
statusCode: "000"
statusMsg: Success
success: true
chargeInfo: [chargeCurrency: USD]
mycagreementUptoDate: false
myChoiceCountry: "1"
'400':
description: Validation error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "710"
message: Failure due to input validation error
'401':
description: Authentication required
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "605"
message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/cancel/{trackingNumber}:
post:
summary: cancel an existing Delivery Intercept request
description: Cancel a previously applied intercept on the package.
operationId: cancelExistingRequest
tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
- $ref: "#/components/parameters/transactionSrc"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Content-Type"
- $ref: "#/components/parameters/TrackingNumber"
- $ref: "#/components/parameters/Loc"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceCancelExistingRequest'
example:
clientId: XOLT
transactionId: tm241ea77
source: "72"
loc: en_US
addressToken: e951ee064b46a43f6a17bc930e046f2a
clientIP: 10.9.65.169
trackingNumber: 1Z1144YY0125887968
infoNoticeNumber: "952895106203"
requestType: UFD
requesterContactInfo:
name: John A
telephone: "+17899977222"
phoneExt: "+1"
emailAddress: aups@ups.com
altTelephone: "+19886432748"
altPhoneExt: "+12"
displayPhoneNumber: true
responses:
'200':
description: Successful response
headers:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/MyChoiceCommonResponse'
example:
transactionId: ASR1212
statusCode: "000"
statusMsg: Success
success: true
chargeInfo: [chargeCurrency: USD]
mycagreementUptoDate: false
'400':
description: Validation error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "710"
message: Failure due to input validation error
'401':
description: Authentication required
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
response:
transactionId: ASR1212
statusCode: "0006"
errors:
- code: "605"
message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
securitySchemes:
OAuth2:
type: oauth2
description: |
Find your Client ID and Secret on your app info page.
1. Select "Try It"
2. In the Security section enter your Client ID and Secret
3. Select "Request Token"
4. Enter any additional information in the Body and Parameters sections
5. Select "Send" to execute your API request"
flows:
clientCredentials:
x-tokenEndpointAuthMethod: client_secret_basic
tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token
scopes: {}
parameters:
transactionSrc:
name: transactionSrc
description: >-
Identifies the client/source application that is calling the API.
in: header
required: true
style: simple
explode: false
schema:
type: string
maxLength: 512
minLength: 1
example: XOLT
transId:
name: transId
description: >-
A unique value that will be used to identify the transaction for
logging and troubleshooting purposes.
in: header
required: true
style: simple
explode: false
schema:
type: string
minLength: 1
maxLength: 14
example: ASR1212
Accept:
name: Accept
in: header
description: The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand.
required: true
style: simple
explode: false
schema:
type: string
example: application/json
Content-Type:
name: Content-Type
description: describes the content type to expect
in: header
required: true
schema:
type: string
example: application/json
TrackingNumber:
name: trackingNumber
description: The number being tracked. Each method defines if required.
in: path
required: true
style: simple
explode: false
schema:
type: string
minLength: 18
maxLength: 18
pattern: '^(1Z)[A-Z0-9]{16}$'
example: 1ZA2F8810719086435
Loc:
name: loc
in: query
required: false
description: >-
The locale of the client application to ensure that translations on
the response are in the proper language.
style: form
explode: true
schema:
type: string
maxLength: 5
pattern: '^[a-z]+[_]+[A-Z]+$'
example: en_US
schemas:
AddressBookEntry:
type: object
properties:
imsAddrIdentifier:
description: The IMS Entry Number of the address, required when retrieving or updating an IMS address book entry. Required when specifying an existing address book entry to be used when processing a request.
type: string
addressNickName:
description: The nickname string assigned to the address entry. Required when creating or updating an IMS address book entry.
type: string
addressInfo:
description: Address object, include line1, line2, line 3 state, postal code and country code. Required when processing a request if imsAddressIdentifier is not present.
$ref: '#/components/schemas/AddressInformation'
nameOrCompanyName:
description: The name of the company or person customer address.(Required When calling submitAddress() API Empty String can be passed)
type: string
contactName:
description: The contact name at the customer address.
type: string
phoneNumber:
description: The contact phone number at the customer address.(Required When calling submitAddress() API Empty String can be passed)
maxLength: 14
type: string
pattern: '^(\+)[0-9]{1,13}$'
example: "+19886222523"
phoneExt:
description: The phone extension number at the customer address.(Required When calling submitAddress() API Empty String can be passed)
type: string
pattern: '^(\+)[0-9]{1,3}$'
example: "+244"
emailAddress:
description: Email Address at the customer address.
type: string
pattern: '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$'
example: aups@ups.com
AddressInformation:
type: object
required: [city,countryCode]
properties:
addressLine1:
description: Line 1 of the street address. Required if streetAddressParsedIndicator is FALSE; Required when setting Billing Address.
maxLength: 50
example: 1147 S Salisbury Blvd
type: string
addressLine2:
description: Line 2 of the street address
maxLength: 35
type: string
example: Ste 8
addressLine3:
description: Line 3 of the street
maxLength: 35
type: string
city:
description: The city name of the address
maxLength: 30
minLength: 1
example: SALISBURY
type: string
state:
description: The state code of the address
maxLength: 5
example: MD
type: string
postalCode:
description: The postal code of the address (should be provided for postal countries)
maxLength: 16
example: D21804
type: string
countryCode:
description: The ISO country code of the address
maxLength: 2
minLength: 2
example: US
type: string
buildingFloor:
type: string
publicLocationId:
type: string
example: "U88498244"
firstName:
description: Required when the user choses to enter a new card providing the Billing address in CreditCardInformation .
example: HUNTLY
type: string
lastName:
description: Required when the user choses to enter a new card providing the Billing address in CreditCardInformation object.
example: OAK
type: string
fullName:
description: Full person name
example: HUNTLY OAK
type: string
phoneNumber:
type: string
maxLength: 17
pattern: '^(\+)[0-9]{1,16}$'
example: "+19886222564"
activitySLICNumber:
description: |
When provided, the Will Call center lookup will be done using this identifier. The lookup will only be done using the postalCode
when this field is blank.
type: string
example: "4836"
streetAddressParsedIndicator:
description: Set it to true when clients send in parsed street address for redirects.
example: TRUE
type: boolean
default: false
parsedStreetAddress:
description: |
Parsed street address object, includes streetName, steetSuffix, streetPrefix, streetType and streetNumber.
Required when streetAddressParsedIndicator is TRUE.
type: object
properties:
streetName:
description: |
street level validation of an Address At least one of the street fields is required when streetAddressParsedIndicator
is set to TRUE in AddressInformation.
maxLength: 50
type: string
example: "OAK"
streetSuffix:
maxLength: 2
type: string
example: "N"
streetPrefix:
maxLength: 2
type: string
streetType:
maxLength: 4
type: string
example: "DR"
streetNumber:
maxLength: 11
type: string
example: "512"
ChargesInfo:
type: object
required: [chargeCurrency]
properties:
accessorialCharge:
description: |
Includes sum of all accessorial charges (i.e. including addition handling, intercept).
type: string
maxLength: 20
example: "5.00"
interceptCharge:
description: The flat rate charge specific for the intercept.
type: string
maxLength: 20
example: "5.00"
transportationCharge:
description: Transportation Charge only for AlternateAddress(Redirect,deliver to another address).
type: string
maxLength: 20