-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathDangerousGoods.yaml
More file actions
1647 lines (1618 loc) · 62.5 KB
/
DangerousGoods.yaml
File metadata and controls
1647 lines (1618 loc) · 62.5 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
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: Dangerous Goods Utility
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |
The Dangerous Goods API provides the ability to determine if certain materials, such as dangerous goods or hazardous materials, can be shipped with UPS. The API's two endpoints - Chemical Reference Data and Acceptance Audit Precheck, help perform pre-checks before shipping any dangerous goods.
# Reference
- <a href="https://developer.ups.com/api/reference/dangerousgoods/business-rules" target="_blank" rel="noopener">Business Rules</a>
- <a href="https://developer.ups.com/api/reference/dangerousgoods/appendix" target="_blank" rel="noopener">Appendix</a>
- <a href="https://developer.ups.com/api/reference/dangerousgoods/errors" target="_blank" rel="noopener">Errors</a>
- <a href="https://developer.ups.com/api/reference/dangerousgoods/faq" target="_blank" rel="noopener">FAQ</a>
<br/><p>Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our <a href="https://developer.ups.com/api/reference/postman/guide"
target="_blank" rel="noopener">Postman Guide</a>. Explore API documentation and sample applications through GitHub.</p>
<a href="https://god.gw.postman.com/run-collection/29542085-bb17460a-ed1a-4267-8c58-a8cc50a48f7a?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-bb17460a-ed1a-4267-8c58-a8cc50a48f7a%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>
<a href="https://github.com/UPS-API" target="_blank" rel="noopener noreferrer">
<img src="https://www.ups.com/assets/resources/webcontent/images/gitHubButton.svg" alt="Open in GitHub " 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:
"/dangerousgoods/{version}/chemicalreferencedata":
post:
summary: Chemical Reference Data
tags:
- Dangerous Goods
security:
- OAuth2: []
description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good.
operationId: Chemical Reference Data
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: true
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: true
- in: path
name: version
schema:
type: string
minimum: 1
default: v2409
description: |
Version of the API.
Valid values:
- v2409
required: true
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/DANGEROUSGOODSUTILITYRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
value:
ChemicalReferenceDataRequest:
IDNumber: UN1088
ProperShippingName: Acetal
ShipperNumber: Your Shipper Number
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper"
'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"
"/dangerousgoods/{version}/acceptanceauditprecheck":
post:
description: Enables shippers perform pre-checks before shipping dangerous goods using the chemical record identifier and the commodity's regulated level code.
tags:
- Dangerous Goods
security:
- OAuth2: []
summary: Acceptance Audit Pre-check
operationId: Acceptance Audit Pre-Check
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: true
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: true
- in: path
name: version
schema:
type: string
default: v3
description: |
API version
Valid values:
- v2
required: true
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/DANGEROUSGOODSUTILITYAPCRequestWrapper"
examples:
json:
summary: A sample JSON request
value:
AcceptanceAuditPreCheckRequest:
Request:
RequestOption: Request
TransactionReference:
CustomerContext: ''
OriginRecordTransactionTimestamp: " "
Shipment:
ShipperNumber: " "
ShipFromAddress:
AddressLine: 226 ELMWOOD AVE
City: BOGOTA
StateProvinceCode: NJ
PostalCode: '7603'
CountryCode: US
ShipToAddress:
AddressLinde: MY STREET 11
City: DIEGEM
StateProvinceCode: " "
PostalCode: '1831'
CountryCode: BE
Service:
Code: '01'
Description: 'GROUND '
RegulationSet: IATA
Package:
PackageIdentifier: '12'
PackageWeight:
Weight: '12'
UnitOfMeasurement:
Code: KGS
Description: KILOS
QValue: '0'
OverPackedIndicator: I
TransportationMode: PAX
EmergencyContact: SELF
ChemicalRecord:
ChemicalRecordIdentifier: '12'
ReportableQuantity: RQ
ClassDivisionNumber: '3'
SubRiskClass: " "
IDNumber: UN2621
PackagingGroupType: III
Quantity: '10'
UOM: KGS
PackagingInstructionCode: Y344
ProperShippingName: ACETYL METHYL CARBINOL
TechnicalName: " "
AdditionalDescription: N
PackagingType: Fiberboard Box
HazardLabelRequired: LABEL IT
PackagingTypeQuantity: '22'
CommodityRegulatedLevelCode: LQ
TransportCategory: '3'
TunnelRestrictionCode: '1'
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper"
'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"
"/dangerousgoods/{deprecatedVersion}/chemicalreferencedata":
post:
deprecated: true
summary: Chemical Reference Data
tags:
- Dangerous Goods
security:
- OAuth2: []
description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good.
operationId: Deprecated Chemical Reference Data
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: true
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: true
- in: path
name: deprecatedVersion
schema:
type: string
minimum: 1
default: v1
description: |
Version of the API.
Valid values:
- v1
- v1801.
required: true
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/DANGEROUSGOODSUTILITYRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
value:
ChemicalReferenceDataRequest:
IDNumber: UN1088
ProperShippingName: Acetal
ShipperNumber: Your Shipper Number
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper"
'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"
"/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck":
post:
deprecated: true
tags:
- Dangerous Goods
security:
- OAuth2: []
description: Enables shippers perform pre-checks before shipping dangerous goods using the chemical record identifier and the commodity's regulated level code.
summary: Acceptance Audit Pre-check
operationId: Deprecated Acceptance Audit Pre-Check
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: true
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: true
- in: path
name: deprecatedVersion
schema:
type: string
default: v1
description: |
API version
Valid values:
- v1
required: true
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/DANGEROUSGOODSUTILITYAPCRequestWrapper"
examples:
json:
summary: A sample JSON request
value:
AcceptanceAuditPreCheckRequest:
Request:
RequestOption: Request
TransactionReference:
CustomerContext: ''
OriginRecordTransactionTimestamp: " "
Shipment:
ShipperNumber: " "
ShipFromAddress:
AddressLine: 226 ELMWOOD AVE
City: BOGOTA
StateProvinceCode: NJ
PostalCode: '7603'
CountryCode: US
ShipToAddress:
AddressLinde: MY STREET 11
City: DIEGEM
StateProvinceCode: " "
PostalCode: '1831'
CountryCode: BE
Service:
Code: '01'
Description: 'GROUND '
RegulationSet: IATA
Package:
PackageIdentifier: '12'
PackageWeight:
Weight: '12'
UnitOfMeasurement:
Code: KGS
Description: KILOS
QValue: '0'
OverPackedIndicator: I
TransportationMode: PAX
EmergencyContact: SELF
ChemicalRecord:
ChemicalRecordIdentifier: '12'
ReportableQuantity: RQ
ClassDivisionNumber: '3'
SubRiskClass: " "
IDNumber: UN2621
PackagingGroupType: III
Quantity: '10'
UOM: KGS
PackagingInstructionCode: Y344
ProperShippingName: ACETYL METHYL CARBINOL
TechnicalName: " "
AdditionalDescription: N
PackagingType: Fiberboard Box
HazardLabelRequired: LABEL IT
PackagingTypeQuantity: '22'
CommodityRegulatedLevelCode: LQ
TransportCategory: '3'
TunnelRestrictionCode: '1'
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper"
'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:
DANGEROUSGOODSUTILITYRequestWrapper:
xml:
name: ChemicalReferenceDataRequest
description: 'N/A '
maximum: 1
type: object
required:
- ChemicalReferenceDataRequest
properties:
ChemicalReferenceDataRequest:
"$ref": "#/components/schemas/ChemicalReferenceDataRequest"
DANGEROUSGOODSUTILITYResponseWrapper:
xml:
name: ChemicalReferenceDataResponse
description: 'N/A '
maximum: 1
type: object
required:
- ChemicalReferenceDataResponse
properties:
ChemicalReferenceDataResponse:
"$ref": "#/components/schemas/ChemicalReferenceDataResponse"
ChemicalReferenceDataRequest:
type: object
required:
- Request
- ShipperNumber
properties:
Request:
"$ref": "#/components/schemas/ChemicalReferenceDataRequest_Request"
IDNumber:
description: This is the ID number (UN/NA/ID) for the specified commodity.
UN/NA/ID Identification Number assigned to the specified regulated good.
(Include the UN/NA/ID as part of the entry). At least one of the information
- IDNumber or ProperShippingName should be provided to retrieve Chemical
Reference Data.
maximum: 1
type: string
minLength: 1
maxLength: 6
ProperShippingName:
description: The Proper Shipping Name assigned by ADR, CFR or IATA. At
least one of the information - IDNumber or ProperShippingName should be
provided to retrieve Chemical Reference Data.
maximum: 1
type: string
minLength: 1
maxLength: 250
ShipperNumber:
description: Shipper's six digit account number. Your UPS Account Number
must have correct Dangerous goods contract to successfully use this Webservice.
maximum: 1
type: string
minLength: 6
maxLength: 6
xml:
name: ChemicalReferenceDataRequest
maximum: 1
description: Dangerous Goods Utility Request container for Chemical Reference
Data.
ChemicalReferenceDataRequest_Request:
type: object
properties:
RequestOption:
type: array
items:
type: string
description: Enables the user to specify optional processing. Currently,
there is no optional process in Dangerous Goods Utiltiy WS.
minLength: 1
maxLength: 1
SubVersion:
description: |-
When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility.
To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description.
Format: YYMM = Year and month of the release.
Example: 1801 = 2018 January Supported values: 1801
type: string
maximum: 1
TransactionReference:
"$ref": "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
description: Contains Chemical Reference Data request criteria components.
Request_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext information which will be echoed during
response.
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: TransactionReference identifies transactions between client and
server.
ChemicalReferenceDataResponse:
type: object
required:
- Response
properties:
Response:
"$ref": "#/components/schemas/ChemicalReferenceDataResponse_Response"
ChemicalData:
description: |
Container to hold Chemical Data information.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/ChemicalReferenceDataResponse_ChemicalData"
xml:
name: ChemicalReferenceDataResponse
description: Dangerous Goods Utility Response container for Chemical Reference
Data.
maximum: 1
ChemicalReferenceDataResponse_Response:
type: object
required:
- ResponseStatus
properties:
ResponseStatus:
"$ref": "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/Response_Alert"
TransactionReference:
"$ref": "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Contains Dangerous Goods Utility Chemical Reference Data response
components.
maximum: 1
Response_ResponseStatus:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: 'Identifies the success or failure of the transaction. Valid
values: 0 = Failed and 1 = Successful.'
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Describes Response Status Code. Returns text of "Success" or
"Failure".
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ResponseStatus
description: Response status container.
Response_Alert:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: Warning code returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 10
Description:
description: Warning messages returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 150
xml:
name: Alert
description: Alert Container. There can be zero to many alert containers with
code and description.
Response_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext information which will be echoed during
response.
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: Transaction Reference Container.
ChemicalReferenceDataResponse_ChemicalData:
type: object
properties:
ChemicalDetail:
"$ref": "#/components/schemas/ChemicalData_ChemicalDetail"
ProperShippingNameDetail:
"$ref": "#/components/schemas/ChemicalData_ProperShippingNameDetail"
PackageQuantityLimitDetail:
description: |
Container to hold Package Quantity Limit Detail information. It will be returned if applies for a given chemical record.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/ChemicalData_PackageQuantityLimitDetail"
xml:
name: ChemicalData
ChemicalData_ChemicalDetail:
type: object
maximum: 1
properties:
RegulationSet:
description: "The Regulatory set associated with every regulated shipment.
\ Possible values are ADR, 49CFR, IATA. It will be returned if applies
for a given chemical record.\n\nADR = Europe to Europe Ground Movement\n49CFR
= HazMat regulated by US Dept. of Transportation within the U.S. or ground
shipments to Canada, \nIATA= Worldwide Air movement."
maximum: 1
type: string
minLength: 3
maxLength: 5
IDNumber:
description: This is the ID number (UN/NA/ID) for the specified commodity.
UN/NA/ID Identification Number assigned to the specified regulated good.
(Include the UN/NA/ID as part of the entry). It will be returned if applies
for a given chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 6
HazardousMaterialsDescription:
description: Free form text containing the full name that are used to describe
a regulated chemical record. It will be returned if applies for a given
chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 250
ClassDivisionNumber:
description: This is the hazard class associated to the specified commodity. It
will be returned if applies for a given chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 10
SubRiskClass:
description: Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma). It will be returned if applies for a given chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 100
PackagingGroupType:
description: This is the packing group category associated to the specified
commodity. This code represents the potential degree of danger represented
by a regulated commodity being transported. It will be returned if applies
for a given chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 10
SpecialPermit:
description: "Indicates whether or not related entity requires special permit
in order to transport the chemical. It will be returned if applies for
a given chemical record.\n\nValid values: \nAIR\nGND\nBOTH"
maximum: 1
type: string
minLength: 1
maxLength: 4
TechnicalNameRequiredIndicator:
description: |-
Indicates whether TechnicalName is required or not. It will be returned if applies for a given chemical record.
Y = TechnicalName is required.
N = TechnicalName is not required.
maximum: 1
type: string
minLength: 1
maxLength: 1
AdditionalShippingInformationRequiredIndicator:
description: "Indicates whether or not additional text is required for the
shipping papers for the related entity. It will be returned if applies
for a given chemical record.\n\nValid values: \nN = No, additional information
for the shipping papers are not required.\nY = Yes, additional information
for the shipping papers are required."
maximum: 1
type: string
minLength: 1
maxLength: 1
TunnelRestrictionCode:
description: |-
Defines what is restricted to pass through a tunnel. EXAMPLES OF VALUES:
(B),(D),(E),(B/D),(B/E),(C,D),(C/E),(D/E),Blank
maximum: 1
type: string
minLength: 1
maxLength: 10
TransportCategory:
description: |-
Code representing a category of transportation, assigned by a regulation set for each regulated commodity. Each value of this category is associated with a multiplier that is used to calculate a value.This value is then used to determine the placarding to be place on the vehicle or container that holds the related regulated commodity EXAMPLES OF VALUES:
0 = No multiplier - must use placarding
1 = Use a multiplier of 50
2 = Use a multiplier of 3
3 = Use a multiplier of 1
4 = Use a multiplier of 0 - do not apply a placard
maximum: 1
type: string
minLength: 1
maxLength: 1
TransportMultiplierQuantity:
description: |-
The quantity that represents a multiplication factor used to calculate a value to determine the placarding to be place on the vehicle or container that holds the related regulated commodity. This factor is associated with a code value represented by Regulated Commodity Transport Category Code. EXAMPLES OF VALUES:
0 = No multiplier - must use placarding
1 = Use a multiplier of 50
2 = Use a multiplier of 3
3 = Use a multiplier of 1
4 = Use a multiplier of 0 - do not apply a placard
maximum: 1
type: string
minLength: 1
maxLength: 1
ChannelTunnelAcceptedIndicator:
description: |-
ChannelTunnelAcceptedIndicator indicates if the chemical is accepted through channel tunnel or not Y= Accepted through channel tunnel
N=Not accepted through channel tunnel
maximum: 1
type: string
minLength: 1
maxLength: 1
ChemicalType:
description: |-
A set of chemical records in HMMS that correspond to a sub-set of chemicals for a regulation set, or the entire set of chemicals for a regulation set EXAMPLES OF VALUES:
FREIGHT
TDG
IATA US DOMESTIC AIR
49CFR
ADR
IATA INTERNATIONAL AIR
maximum: 1
type: string
minLength: 25
maxLength: 25
CAToUSShipmentAllowedIndicator:
description: |-
CAToUSShipmentAllowedIndicator indicates whether this checmical is allowed from CA to US
Applicable only for TDG shipments Y = Permitted from CA to US
N = Not Permitted from CA to US
maximum: 1
type: string
minLength: 1
maxLength: 1
xml:
name: ChemicalDetail
description: Container to hold Chemical details.
ChemicalData_ProperShippingNameDetail:
type: object
required:
- ProperShippingName
properties:
ProperShippingName:
description: The Proper Shipping Name assigned by ADR, CFR or IATA.
type: array
minLength: 1
maxLength: 250
xml:
name: ProperShippingNameDetail
description: Container to hold Proper Shipping Name Detail information. It
will be returned if applies for a given chemical record.
maximum: 1
ChemicalData_PackageQuantityLimitDetail:
type: object
maximum: 1
properties:
PackageQuantityLimitTypeCode:
description: |-
The type of package quantity limit. It will be returned if applies for a given chemical record.
Valid values:
CAO - Cargo Aircraft Only
LTD QTY - Limited Quantity
GND - Ground
PAX - Passenger Aircraft
COMAT CAO - Company Material CAO
COMAT LTD - Company Material LTD
COMAT PAX - Company Material PAX
maximum: 1
type: string
minLength: 1
maxLength: 10
Quantity:
description: The numerical value of the mass capacity of the regulated good. It
will be returned if applies for a given chemical record.
maximum: 1
type: string
minLength: 15
maxLength: 15
UOM:
description: |-
The unit of measure used for the mass capacity of the regulated good.
It will be returned if applies for a given chemical record. Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc.
maximum: 1
type: string
minLength: 1
maxLength: 10
PackagingInstructionCode:
description: The packing instructions related to the chemical record. It
will be returned if applies for a given chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 353
xml:
name: PackageQuantityLimitDetail
DANGEROUSGOODSUTILITYAPCRequestWrapper:
xml:
name: AcceptanceAuditPreCheckRequest
description: 'N/A '
maximum: 1
type: object
required:
- AcceptanceAuditPreCheckRequest
properties:
AcceptanceAuditPreCheckRequest:
"$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest"
DANGEROUSGOODSUTILITYAPCResponseWrapper:
xml:
name: AcceptanceAuditPreCheckResponse
description: 'N/A '
maximum: 1
type: object
required:
- AcceptanceAuditPreCheckResponse
properties:
AcceptanceAuditPreCheckResponse:
"$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse"
AcceptanceAuditPreCheckRequest:
type: object
required:
- Request
- Shipment
properties:
Request:
"$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest_Request"
OriginRecordTransactionTimestamp:
description: "The time that the request was made from the originating system.
UTC time down to milliseconds. \nExample: 2016-07-14T12:01:33.999"
type: string
maximum: 1
Shipment:
"$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest_Shipment"
xml:
name: AcceptanceAuditPreCheckRequest
maximum: 1
description: Dangerous Goods Utility Request container for Acceptance Audit
Pre-check.
AcceptanceAuditPreCheckRequest_Request:
type: object
properties:
RequestOption:
description: "Enables the user to specify optional processing. \n\nCurrently,
there is no optional process in Dangerous Goods Utility WS."
type: string
SubVersion:
description: Not Used.
type: string
TransactionReference:
"$ref": "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
description: Contains Dangerous Goods Utility Acceptance Audit Pre-check request
criteria elements.
AcceptanceAuditPreCheckRequest_Shipment:
type: object
maximum: 1
required:
- ShipToAddress
- ShipFromAddress
- Service
- ShipperNumber
- Package
properties:
ShipperNumber:
description: Shipper's six digit account number. Your UPS Account Number
must have correct Dangerous goods contract to successfully use this Webservice.
maximum: 1
type: string
minLength: 6
maxLength: 6
ShipFromAddress:
"$ref": "#/components/schemas/Shipment_ShipFromAddress"
ShipToAddress:
"$ref": "#/components/schemas/Shipment_ShipToAddress"
Service:
"$ref": "#/components/schemas/Shipment_Service"
RegulationSet:
description: "The Regulatory set associated with every regulated shipment.
It must be same across the shipment. Not required when the CommodityRegulatedLevelCode
is EQ. Valid values: ADR, 49CFR, IATA.\n\nADR = Europe to Europe Ground
Movement\n49CFR = HazMat regulated by US Dept. of Transportation within
the U.S. or ground shipments to Canada \nIATA= Worldwide Air movement."
maximum: 1