-
Notifications
You must be signed in to change notification settings - Fork 20
/
Copy pathLocator.yaml
2622 lines (2573 loc) · 96.8 KB
/
Locator.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.0.3
info:
title: Locator
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |
The Locator API allows you to find UPS locations - such as drop-off points, retail locations, and UPS access points (third-party retail locations that offer UPS package drop-off, or delivery services). The API provides capabilities to search by location, services offered, program types, and related criteria. You can also retrieve hours of operation, location details, and additional UPS services offered at specific locations.
- <a href="https://developer.ups.com/api/reference/locator/business-rules" target="_blank" rel="noopener">Business Rules</a>
- <a href="https://developer.ups.com/api/reference/locator/appendix" target="_blank" rel="noopener">Appendix</a>
- <a href="https://developer.ups.com/api/reference/locator/errors" target="_blank" rel="noopener">Errors</a>
- <a href="https://github.com/UPS-API" target="_blank" rel="noopener noreferrer">GitHub - view sample integration code</a>
<a href="https://god.gw.postman.com/run-collection/29542085-8637d9f1-5e40-4a1e-aa95-82376e268638?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-8637d9f1-5e40-4a1e-aa95-82376e268638%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>
servers:
- url: https://wwwcie.ups.com/api
description: Customer Integration Environment
- url: https://onlinetools.ups.com/api
description: Production
paths:
"/locations/{version}/search/availabilities/{reqOption}":
post:
summary: Locator
tags:
- Locator
security:
- OAuth2: []
description: The Locator API allows you to find UPS locations - such as drop-off points, retail locations, and UPS access points (third-party retail locations that offer UPS package drop-off, or delivery services). The API provides capabilities to search by location, services offered, program types, and related criteria. You can also retrieve hours of operation, location details, and additional UPS services offered at specific locations.
operationId: Locator
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
- in: path
name: version
schema:
type: string
default: v2
description: |
Version of API
Valid values:
- v2
required: true
- in: path
name: reqOption
schema:
type: string
minLength: 1
maxLength: 4
description: "Indicates the type of request.\nValid values:\n1-Locations (Drop
Locations and Will call locations)\n8-All available Additional Services\n16-All
available Program Types\n24-All available Additional Services and Program
types\n32-All available Retail Locations\n40-All available Retail Locations
and Additional Services \n48-All available Retail Locations and Program
Types \n56-All available Retail Locations, Additional Services and Program
Types \n64-Search for UPS Access Point Locations. "
required: true
- in: query
name: Locale
schema:
type: string
default: en_US
description: Locale of request
requestBody:
description: Generate sample code for popular API requests by selecting an
example below. To view a full sample request and response, first click "Authorize"
and enter your application credentials, then populate the required parameters
above and click "Try it out".
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/LOCATORRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
value:
LocatorRequest:
Request:
TransactionReference:
CustomerContext: ''
RequestAction: Locator
OriginAddress:
AddressKeyFormat:
AddressLine: 123 Fork rd
PoliticalDivision2: Atlanta
PoliticalDivision1: PE
PostcodePrimaryLow: '30005'
PostcodeExtendedLow: '30005'
CountryCode: US
MaximumListSize: '10'
Translate:
LanguageCode: ENG
Locale: en_US
UnitOfMeasurement:
Code: MI
LocationSearchCriteria:
SearchOption:
- OptionType:
Code: '01'
OptionCode:
Code: '001'
Relation:
Code: '01'
- OptionType:
Code: '01'
OptionCode:
- Code: '001'
- Code: '001'
Relation:
Code: '01'
MaximumListSize: '10'
SearchRadius: '75'
ServiceSearch:
Time: '1030'
ServiceCode:
Code: '01'
SortCriteria:
SortType: '01'
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/LOCATORResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"/locations/{deprecatedVersion}/search/availabilities/{reqOption}":
post:
deprecated: true
summary: Locator
tags:
- Locator
security:
- OAuth2: []
description: The Locator API allows you to find UPS locations - such as drop-off points, retail locations, and UPS access points (third-party retail locations that offer UPS package drop-off, or delivery services). The API provides capabilities to search by location, services offered, program types, and related criteria. You can also retrieve hours of operation, location details, and additional UPS services offered at specific locations.
operationId: Deprecated Locator
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
- in: path
name: deprecatedVersion
schema:
type: string
default: v1
description: |
Version of API
Valid values:
- v1
required: true
- in: path
name: reqOption
schema:
type: string
minLength: 1
maxLength: 4
description: "Indicates the type of request.\nValid values:\n1-Locations (Drop
Locations and Will call locations)\n8-All available Additional Services\n16-All
available Program Types\n24-All available Additional Services and Program
types\n32-All available Retail Locations\n40-All available Retail Locations
and Additional Services \n48-All available Retail Locations and Program
Types \n56-All available Retail Locations, Additional Services and Program
Types \n64-Search for UPS Access Point Locations. "
required: true
- in: query
name: Locale
schema:
type: string
default: en_US
description: Locale of request
requestBody:
description: Generate sample code for popular API requests by selecting an
example below. To view a full sample request and response, first click "Authorize"
and enter your application credentials, then populate the required parameters
above and click "Try it out".
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/LOCATORRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
value:
LocatorRequest:
Request:
TransactionReference:
CustomerContext: ''
RequestAction: Locator
OriginAddress:
AddressKeyFormat:
AddressLine: 123 Fork rd
PoliticalDivision2: Atlanta
PoliticalDivision1: PE
PostcodePrimaryLow: '30005'
PostcodeExtendedLow: '30005'
CountryCode: US
MaximumListSize: '10'
Translate:
LanguageCode: ENG
Locale: en_US
UnitOfMeasurement:
Code: MI
LocationSearchCriteria:
SearchOption:
- OptionType:
Code: '01'
OptionCode:
Code: '001'
Relation:
Code: '01'
- OptionType:
Code: '01'
OptionCode:
- Code: '001'
- Code: '001'
Relation:
Code: '01'
MaximumListSize: '10'
SearchRadius: '75'
ServiceSearch:
Time: '1030'
ServiceCode:
Code: '01'
SortCriteria:
SortType: '01'
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/LOCATORResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
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: {}
schemas:
LOCATORRequestWrapper:
xml:
name: LocatorRequest
description: 'N/A '
maximum: 1
type: object
required:
- LocatorRequest
properties:
LocatorRequest:
"$ref": "#/components/schemas/LocatorRequest"
LOCATORResponseWrapper:
xml:
name: LocatorResponse
description: 'N/A '
maximum: 1
type: object
required:
- LocatorResponse
properties:
LocatorResponse:
"$ref": "#/components/schemas/LocatorResponse"
LocatorRequest:
type: object
required:
- Request
- OriginAddress
- Translate
properties:
Request:
"$ref": "#/components/schemas/LocatorRequest_Request"
OriginAddress:
"$ref": "#/components/schemas/LocatorRequest_OriginAddress"
Translate:
"$ref": "#/components/schemas/LocatorRequest_Translate"
UnitOfMeasurement:
"$ref": "#/components/schemas/LocatorRequest_UnitOfMeasurement"
LocationID:
description: Location ID is the identification number of the UPS affiliated
location.
type: array
items:
type: string
minLength: 1
maxLength: 10
LocationSearchCriteria:
"$ref": "#/components/schemas/LocatorRequest_LocationSearchCriteria"
SortCriteria:
"$ref": "#/components/schemas/LocatorRequest_SortCriteria"
AllowAllConfidenceLevels:
description: Indicator to allow confidence level in search.
type: string
maximum: 1
SearchOptionCode:
description: "Valid values: \n01-Proximity Search Details\n02-Address Search
Details\n03-Proximity Search Summary\n04-Address Search Summary\n05-Freight
Will Call Search. \nEither OptionType 03 or 04 is required."
maximum: 1
type: string
minLength: 2
maxLength: 2
ServiceGeoUnit:
"$ref": "#/components/schemas/LocatorRequest_ServiceGeoUnit"
FreightIndicator:
description: FreightIndicator. Required for Freight Location Search.
type: string
maximum: 1
xml:
name: LocatorRequest
maximum: 1
description: N/A
LocatorRequest_Request:
type: object
properties:
TransactionReference:
"$ref": "#/components/schemas/Request_TransactionReference"
RequestAction:
description: "Indicates the action to be taken by the XML service. \nThe
only valid value is 'Locator'."
maximum: 1
type: string
minLength: 13
maxLength: 13
xml:
name: Request
maximum: 1
required:
- RequestAction
description: N/A
Request_TransactionReference:
type: object
maximum: 1
minLength: 1
maxLength: 512
properties:
CustomerContext:
description: The client uses CustomerContext to synchronize request/response
pairs. The client establishes CustomerContext, which can contain any information
client want, as long as it is valid XML; it is echoed back by the server
type: string
xml:
name: TransactionReference
description: TransactionReference identifies transactions between client and
server.
LocatorRequest_OriginAddress:
type: object
properties:
Geocode:
"$ref": "#/components/schemas/OriginAddress_Geocode"
AddressKeyFormat:
"$ref": "#/components/schemas/OriginAddress_AddressKeyFormat"
MaximumListSize:
description: "If present, indicates the maximum number of locations the
client wishes to receive in an address candidate response where the provided
origin information is insufficient to accurately establish location. \n\nValid
values: 1-50, default 10"
maximum: 1
type: string
minLength: 1
maxLength: 2
xml:
name: OriginAddress
required:
- AddressKeyFormat
maximum: 1
description: Container for origin address information.
OriginAddress_Geocode:
type: object
maximum: 1
required:
- Latitude
- Longitude
properties:
Latitude:
description: The latitude of the origin address or the center point of the area code.
maximum: 1
type: string
minLength: 15
maxLength: 15
Longitude:
description: The longitude of the origin address or the center point of the area code.
maximum: 1
type: string
minLength: 15
maxLength: 15
xml:
name: Geocode
description: Geocode is the latitude and longitude of the origin address.
OriginAddress_AddressKeyFormat:
type: object
maximum: 1
properties:
ConsigneeName:
description: Name. Not relevant for this tool
type: string
minLength: 1
maxLength: 40
maximum: 1
AddressLine:
description: Address Line Information. The user may submit street level address information or provide Intersection information.
maximum: 1
type: string
minLength: 1
maxLength: 100
AddressLine2:
description: Additional Address Line Information.
maximum: 1
type: string
minLength: 1
maxLength: 64
AddressLine3:
description: Additional Address Line Information.
maximum: 1
type: string
minLength: 1
maxLength: 64
PoliticalDivision3:
description: Barrio or other sub-division of City
maximum: 1
type: string
minLength: 1
maxLength: 35
PoliticalDivision2:
description: City or Town.
maximum: 1
type: string
minLength: 1
maxLength: 50
PoliticalDivision1:
description: State or province
maximum: 1
type: string
minLength: 1
maxLength: 50
PostcodePrimaryLow:
description: Main postal code. Required if the user does not submit the City, State/Province address combination.
maximum: 1
type: string
minLength: 1
maxLength: 10
PostcodeExtendedLow:
description: 4 Digit postal code extension. Valid for US only.
maximum: 1
type: string
minLength: 1
maxLength: 10
CountryCode:
description: Two-character country or territory abbreviation
maximum: 1
type: string
minLength: 1
maxLength: 2
SingleLineAddress:
description: |
Single line search information. Can contain values of origin address in a single line. Will override other origin address information.
Conditionally Required for Non-Postal Code Countries. Applicable Country Ireland (IE)
SingleLineAddress used for the lookup
SingleLineAddress (Format - CSV) (\"Values:\" + postalCode + city + state + address + landmark + phoneNumber)
type: string
maximum: 1
xml:
name: AddressKeyFormat
required:
- PoliticalDivision1
- AddressLine
- PostcodePrimaryLow
- PoliticalDivision2
- CountryCode
description: "Contains all of the basic information about the origin such as:
Address Lines, City, State/Province, Postal Code and Country or Territory
Code. \nThe element CountryCode is required."
LocatorRequest_Translate:
type: object
maximum: 1
properties:
Locale:
description: "Locale is the 5 digit combination of 2 character language
code and 2 character country or territory code separated by an underscore
('_') character. Will be used to determine what language the response
will be sent in. \nDefault value is: en_US. \nExamples are: fr_CA, es_MX."
maximum: 1
type: string
minLength: 5
maxLength: 5
xml:
name: Translate
description: Contains the locale information for the request.
LocatorRequest_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Valid values are:
- MI-Miles
- KM-Kilometers
type: string
xml:
name: UnitOfMeasurement
description: Distance unit of measurement. This is required for location requests
(request option 1).
LocatorRequest_LocationSearchCriteria:
type: object
properties:
SearchOption:
type: array
items:
"$ref": "#/components/schemas/LocationSearchCriteria_SearchOption"
MaximumListSize:
description: If present, indicates the maximum number of locations the client
wishes to receive in response; ranges from 1 to 50 with a default value
of 5.
maximum: 1
type: string
minLength: 1
maxLength: 2
SearchRadius:
description: "Defines the maximum radius the user wishes to search for a
UPS location. If the user does not specify, the default value is 100 miles.
Whole numbers only. \n\nValid values are:\n5-100 for UnitOfMeasure MI\n5-150
for UnitOfMesaure KM"
maximum: 1
type: string
minLength: 1
maxLength: 3
ServiceSearch:
"$ref": "#/components/schemas/LocationSearchCriteria_ServiceSearch"
FreightWillCallSearch:
"$ref": "#/components/schemas/LocationSearchCriteria_FreightWillCallSearch"
AccessPointSearch:
"$ref": "#/components/schemas/LocationSearchCriteria_AccessPointSearch"
OpenTimeCriteria:
"$ref": "#/components/schemas/LocationSearchCriteria_OpenTimeCriteria"
BrexitFilter:
description: Brexit Filter. Applicable for country code GB; Pass the PostalCode
for the address in the location search if Brexit functionality is desired.
UAPs with postal code starts with BT returned when brexit filter starts
with BT, else UAPs returned with non BT postal code. Applicable for UAP
and Proximal building search.
maximum: 1
type: string
minLength: 1
maxLength: 10
xml:
name: LocationSearchCriteria
maximum: 1
description: "The Location search criteria container allows the user to further
define the basis to which they wish to receive the UPS locations. \nOnly relevant
when the user requests a Location search (request option 1)."
LocationSearchCriteria_SearchOption:
type: object
required:
- OptionCode
- OptionType
properties:
OptionType:
"$ref": "#/components/schemas/SearchOption_OptionType"
OptionCode:
type: array
items:
"$ref": "#/components/schemas/SearchOption_OptionCode"
Relation:
"$ref": "#/components/schemas/SearchOption_Relation"
xml:
name: SearchOption
description: |
SearchOption contains the information that forms the basis of the location search, It contains the criteria for search by Locations, Retail Locations, Additional Services, or Program Types.
There should be one container for each type of search the user may wish to do. The user can specify either search by Locations or Retail Locations, but not both.
If this container is missing, the default search would be for The UPS Store, UPS Center, UPS Drop Box, and Authorized Shipping Outlet location types.
SearchOption_OptionType:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code for Option type valid values are:
- 01-Location
- 02-Retail Location
- 03-Additional Services
- 04-Program Type
- 05-Service Level Option.
- 06-End Point Service Offering
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: OptionType
description: "OptionType is a container that indicates the type of search for
locations. There are 5 types of search. They are search by: Location, Retail
Location, Additional Services, Program Type, and a Service Level Option. \nIf
search criteria by Location or Retail Location is not provided the default
search of The UPS Store, UPS Center, UPS Drop Box, and Authorized Shipping
Outlet location types will be performed."
SearchOption_OptionCode:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
These codes vary by country. It is strongly recommended that clients contact UPS to retrieve the primary search indicator and the valid Location Types and Service Level Options for each country or territory.
Refer to Location Search Option Codes in the Appendix for additional information.
maximum: 1
type: string
minLength: 1
maxLength: 10
xml:
name: OptionCode
description: "Option code contains the information of a particular Location,
Retail Location, Additional Service, Program Type or End Point Service Offering
depending on the option type. \nThe SearchOptions can contain one or more
OptionCodes which forms the criteria for the location search."
SearchOption_Relation:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Applicable for Additional Services and Program Types.
Valid values:
- 01 - And (Default)
- 02 - Or
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Relation
description: "The relation container will contain the relation parameter (And/Or)
that has to be used among multiple option codes in the location search. \n\nThis
is only applicable to option type Additional Services and Program Types. If
this container is not present for Additional Services and Program Types, the
default relation of And is used."
LocationSearchCriteria_ServiceSearch:
type: object
maximum: 1
properties:
Time:
description: 'Scheduled Local Drop-off Time. Format: HHMM'
maximum: 1
type: string
minLength: 4
maxLength: 6
ServiceCode:
type: array
items:
"$ref": "#/components/schemas/ServiceSearch_ServiceCode"
ServiceOptionCode:
type: array
items:
"$ref": "#/components/schemas/ServiceSearch_ServiceOptionCode"
xml:
name: ServiceSearch
description: Allows for users to further define the search criteria. Refer to
the rules specified in Service Search section.
ServiceSearch_ServiceCode:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |-
Code indicating the different services. Valid values are:
01-Ground.
02-Air.
03-Express
04-Standard
05-International (Only avialable July 17)
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: ServiceCode
description: |-
Container that contains the service information such as Ground/Air.
Required if the customer provides ServiceSearch Time.
ServiceSearch_ServiceOptionCode:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code that defines the optional service.
Valid values:
- 01 - Saturday pickup.
Only valid for air service.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: ServiceOptionCode
description: Container for the optional service information such as Saturday
Pick up.
LocationSearchCriteria_FreightWillCallSearch:
type: object
maximum: 1
required:
- FreightWillCallRequestType
- OriginOrDestination
- FormatPostalCode
- FacilityAddress
properties:
FreightWillCallRequestType:
description: "Valid values are: \n1 - Postal Code\n2 - Delivery SLIC\n3
- Delivery City/State.\n1: Freight Will Call Search based on Postal Code,
this search is valid for Postal code countries. 2: Freight Will Call Search
based on SLIC. 3: Freight Will Call Search based on City and/or State.
This Search is valid for non-postal code Countries"
maximum: 1
type: string
minLength: 1
maxLength: 1
FacilityAddress:
type: array
items:
"$ref": "#/components/schemas/FreightWillCallSearch_FacilityAddress"
OriginOrDestination:
description: |-
OriginOrDestination is required for FreightWillCallRequestType 1 and type 3 . Valid values:
01-Origin facilities
02-Destination facilities.
maximum: 1
type: string
minLength: 2
maxLength: 2
FormatPostalCode:
description: |-
FormatPostalCode would be required in the request when FreightWillCallRequestType is 1. Valid values are:
NFR-No format requested
FR-format requested
FS-format and search
NVR-No validation requested.
maximum: 1
type: string
minLength: 2
maxLength: 3
DayOfWeekCode:
description: "Day Of week Code. Valid Values are 1 to 7. \n1-Sunday\n2-Monday
\n3-Tuesday \n4-Wednesday\n5-Thursday\n6-Friday\n7-Saturday."
maximum: 1
type: string
minLength: 1
maxLength: 1
xml:
name: FreightWillCallSearch
description: Freight Will Call Search Container. Required if SearchOption is
'05-Freight Will Call Search'
FreightWillCallSearch_FacilityAddress:
type: object
maximum: 1
properties:
SLIC:
description: Facility SLIC. Required for Freight Will call search if FreightWillCallRequestType
is 2.
maximum: 1
type: string
minLength: 5
maxLength: 5
AddressLine:
description: Address line
type: array
items:
type: string
maxItems: 2
minLength: 1
maxLength: 64
City:
description: City. Required for Freight Will call search if FreightWillCallRequestType
is 3.
maximum: 1
type: string
minLength: 1
maxLength: 50
PostalCodePrimaryLow:
description: Postal code. Required for Freight Will call search if FreightWillCallRequestType
is 1.
maximum: 1
type: string
minLength: 1
maxLength: 8
PostalCodeExtendedLow:
description: 4 Digit postal code extension. Valid for US only.
maximum: 1
type: string
minLength: 1
maxLength: 8
State:
description: State. Required if FrieghtWillCallRequestType is 3 if State
is available.
maximum: 1
type: string
minLength: 1
maxLength: 50
CountryCode:
description: Country or territory code.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: FacilityAddress
required:
- CountryCode
description: Facility Address Container
LocationSearchCriteria_AccessPointSearch:
type: object
maximum: 1
properties:
PublicAccessPointID:
description: The Public Access Point ID to use for UPS Access Point Search.
Once this parameter is present , address or geocode search is ignored.
It cannot be combined with AccountNumber search parameter.
maximum: 1
type: string
minLength: 1
maxLength: 15
AccessPointStatus:
description: "Status of UPS Access Point. Valid values are: \n01-Active-available\n07-Active-unavailable."
maximum: 1
type: string
minLength: 2
maxLength: 2
AccountNumber:
description: The account number to use for UPS Access Point Search in the
country or territory. Used to locate a private network for the account.
Once this parameter is present any access point address or geocode search
is ignored. It cannot be combined with PublicAccessPointID search parameter.
maximum: 1
type: string
minLength: 6
maxLength: 10
IncludeCriteria:
"$ref": "#/components/schemas/AccessPointSearch_IncludeCriteria"
ExcludeFromResult:
"$ref": "#/components/schemas/AccessPointSearch_ExcludeFromResult"
ExactMatchIndicator:
description: Presence of this tag represents that "AccessPointSearchByAddress"
service is requested. The value of this tag is ignored.
type: string
maximum: 1
ExistIndicator:
description: Presence of this tag represents that "AccessPointAvailability"
service is requested. The value of this tag is ignored.
type: string
maximum: 1
xml:
name: AccessPointSearch
description: Applicable for request option 64 only. This contains inclusion
and exclusion criteria for address search. It also contains Account Number
and Access Point Public ID search elements.
AccessPointSearch_IncludeCriteria:
type: object
properties:
MerchantAccountNumberList:
"$ref": "#/components/schemas/IncludeCriteria_MerchantAccountNumberList"
SearchFilter:
"$ref": "#/components/schemas/IncludeCriteria_SearchFilter"
ServiceOfferingList:
"$ref": "#/components/schemas/IncludeCriteria_ServiceOfferingList"
xml:
name: IncludeCriteria
description: This contains elements to refine (include) UPS Access point address
or geocode Search.
maximum: 1
IncludeCriteria_MerchantAccountNumberList:
type: object
required:
- MerchantAccountNumber
properties:
MerchantAccountNumber:
description: Account number to be used for a private network access point
search where a UPS access point candidate list is obtained in search by
address or geocode search.
type: array
items:
type: string
minLength: 6
maxLength: 10
xml:
name: MerchantAccountNumberList
description: This contains the list of Merchant Account numbers to be used for
finding private network access points.
maximum: 1
IncludeCriteria_SearchFilter:
type: object
maximum: 1
properties:
DCRIndicator:
description: DCR/DCO Availability indicator for UPS Access Point. Either
this indicator is present or not present. Presence indicates a search
for access points with DCR. Any data in the element is ignored.
type: string
maximum: 1
ShippingAvailabilityIndicator:
description: Shipping Availability indicator for UPS Access Point. Either