-
Notifications
You must be signed in to change notification settings - Fork 19
/
PreNotification.yaml
896 lines (889 loc) · 31.7 KB
/
PreNotification.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
openapi: 3.0.3
info:
title: PreNotification
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |
The Pre-Notification API allows customer applications to inform UPS operations of Dangerous Goods shipments as they are processed and will enter the UPS transportation network prior to an upload of manifest information at the end of the day.
- <a href="https://developer.ups.com/api/reference/prenotification/business-rules" target="_blank" rel="noopener">Business Rules</a>
- <a href="https://developer.ups.com/api/reference/prenotification/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-cfd29893-3a81-425c-bc42-328766d9fb6b?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-cfd29893-3a81-425c-bc42-328766d9fb6b%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:
"/dangerousgoods/{version}/prenotification":
post:
summary: Pre-Notification
tags:
- Pre-Notification
security:
- OAuth2: []
description: The Pre-Notification API allows customer applications to inform
UPS operations of Dangerous Goods shipments as they are processed and will
enter the UPS transportation network prior to an upload of manifest information
at the end of the day.
operationId: PreNotification
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: false
- 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: false
- in: path
name: version
schema:
type: string
default: v2
description: |
Version of API.
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/PRENOTIFICATIONRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
value:
PreNotificationRequest:
Request:
RequestOption: RequestOption
SubVersion: '3'
TransactionReference:
CustomerContext: ''
Shipment:
ShipperNumber: ''
ShipmentIdentificationNumber: 1Z2398YY81288
ShipFromAddress:
AddressLine: MY STREET 12
City: BOGOTA
StateProvinceCode: NJ
PostalCode: K1A0B1
CountryCode: CA
ShipToAddress:
AddressLine: MY STREET 12
City: BOGOTA
StateProvinceCode: NJ
PostalCode: K1A0B1
CountryCode: CA
PickupDate: '20171101'
Service:
Code: GND
Description: Ground
RegulationSet: TDG
Package:
TrackingNumber: 1Z33445567001
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: Kilo
Weight: '12'
TransportationMode: GND
VoidIndicator: ''
PackagePoints: '12'
ChemicalRecord:
ReportableQuantity: '1'
ClassDivisionNumber: I
SubRiskClass: '1234'
IDNumber: UN2761
PackagingGroupType: '0'
Quantity: '1'
UOM: LBS
PackagingInstructionCode: TEST
EmergencyPhone: ''
EmergencyContact: ''
ProperShippingName: TEST SHIPPING
TechnicalName: ''
AdditionalDescription: ''
PackagingType: ''
HazardLabelRequired: LABEL
PackagingTypeQuantity: '1'
CommodityRegulatedLevelCode: LR
TransportCategory: '0'
TunnelRestrictionCode: '1'
QValue: '0.1'
OverPackedIndicator: ''
AllPackedInOneIndicator: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper"
'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}/prenotification":
post:
deprecated: true
summary: Pre-Notification
tags:
- Pre-Notification
security:
- OAuth2: []
description: The Pre-Notification API allows customer applications to inform
UPS operations of Dangerous Goods shipments as they are processed and will
enter the UPS transportation network prior to an upload of manifest information
at the end of the day.
operationId: Deprecated PreNotification
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: false
- 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: false
- in: path
name: deprecatedVersion
schema:
type: string
default: v1
description: |
Version of API.
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/PRENOTIFICATIONRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
value:
PreNotificationRequest:
Request:
RequestOption: RequestOption
SubVersion: '3'
TransactionReference:
CustomerContext: ''
Shipment:
ShipperNumber: ''
ShipmentIdentificationNumber: 1Z2398YY81288
ShipFromAddress:
AddressLine: MY STREET 12
City: BOGOTA
StateProvinceCode: NJ
PostalCode: K1A0B1
CountryCode: CA
ShipToAddress:
AddressLine: MY STREET 12
City: BOGOTA
StateProvinceCode: NJ
PostalCode: K1A0B1
CountryCode: CA
PickupDate: '20171101'
Service:
Code: GND
Description: Ground
RegulationSet: TDG
Package:
TrackingNumber: 1Z33445567001
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: Kilo
Weight: '12'
TransportationMode: GND
VoidIndicator: ''
PackagePoints: '12'
ChemicalRecord:
ReportableQuantity: '1'
ClassDivisionNumber: I
SubRiskClass: '1234'
IDNumber: UN2761
PackagingGroupType: '0'
Quantity: '1'
UOM: LBS
PackagingInstructionCode: TEST
EmergencyPhone: ''
EmergencyContact: ''
ProperShippingName: TEST SHIPPING
TechnicalName: ''
AdditionalDescription: ''
PackagingType: ''
HazardLabelRequired: LABEL
PackagingTypeQuantity: '1'
CommodityRegulatedLevelCode: LR
TransportCategory: '0'
TunnelRestrictionCode: '1'
QValue: '0.1'
OverPackedIndicator: ''
AllPackedInOneIndicator: ''
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper"
'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:
PRENOTIFICATIONRequestWrapper:
xml:
name: PreNotificationRequest
description: 'N/A '
maximum: 1
type: object
required:
- PreNotificationRequest
properties:
PreNotificationRequest:
"$ref": "#/components/schemas/PreNotificationRequest"
PRENOTIFICATIONResponseWrapper:
xml:
name: PreNotificationResponse
description: 'N/A '
maximum: 1
type: object
required:
- PreNotificationResponse
properties:
PreNotificationResponse:
"$ref": "#/components/schemas/PreNotificationResponse"
PreNotificationRequest:
type: object
required:
- Request
- Shipment
properties:
Request:
"$ref": "#/components/schemas/PreNotificationRequest_Request"
Shipment:
"$ref": "#/components/schemas/PreNotificationRequest_Shipment"
xml:
name: PreNotificationRequest
description: Pre-Notification Request.
maximum: 1
PreNotificationRequest_Request:
type: object
properties:
TransactionReference:
"$ref": "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Request Container
maximum: 1
Request_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext information which will be echoed during
response.
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: TransactionReference identifies transactions between client and
server.
PreNotificationRequest_Shipment:
type: object
maximum: 1
required:
- ShipToAddress
- ShipFromAddress
- Service
- ShipperNumber
- RegulationSet
- Package
- ShipmentIdentificationNumber
- PickupDate
properties:
ShipperNumber:
description: Shipper's six digit account number.
maximum: 1
type: string
minLength: 6
maxLength: 6
ShipmentIdentificationNumber:
description: 1Z Number of the first package in the shipment.
maximum: 1
type: string
minLength: 18
maxLength: 18
ShipToAddress:
"$ref": "#/components/schemas/Shipment_ShipToAddress"
ShipFromAddress:
"$ref": "#/components/schemas/Shipment_ShipFromAddress"
PickupDate:
description: Date of the On Call Air Pickup. Format is YYYYMMDD
maximum: 1
type: string
minLength: 8
maxLength: 8
Service:
"$ref": "#/components/schemas/Shipment_Service"
RegulationSet:
description: |
The Regulatory set associated with every regulated shipment. It must be same across the shipment. Valid values are:
- ADR – European Agreement concerning the International Carriage of Dangerous Goods by Road.
- 49CFR – Title 49 of the United States Code of Federal Regulations.
- IATA – International Air Transport Association (IATA) Dangerous Goods Regulations.
maximum: 1
type: string
minLength: 3
maxLength: 5
Package:
type: array
maximum: 1000
items:
"$ref": "#/components/schemas/Shipment_Package"
xml:
name: Shipment
description: Shipment Container
Shipment_ShipToAddress:
type: object
maximum: 1
required:
- AddressLine
- CountryCode
properties:
AddressLine:
description: The Ship To street address including name and number (when
applicable).
type: array
maximum: 4
minLength: 1
maxLength: 35
items:
type: string
City:
description: The Ship To city.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: The Ship To location's state or province code.
maximum: 1
type: string
minLength: 2
maxLength: 5
PostalCode:
description: The Ship To location's postal code. 9 characters are accepted.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: The Ship To location's country or territory code.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: ShipToAddress
description: Ship To address container.
Shipment_ShipFromAddress:
type: object
maximum: 1
required:
- AddressLine
- CountryCode
properties:
AddressLine:
description: The Ship From street address including name and number (when
applicable).
type: array
maximum: 4
minLength: 1
maxLength: 35
items:
type: string
City:
description: The Ship From city.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: The Ship From location's state or province code.
maximum: 1
type: string
minLength: 2
maxLength: 5
PostalCode:
description: The Ship From location's postal code. 9 characters are accepted.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: The Ship From location's country or territory code.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: ShipFromAddress
description: Ship From address container.
Shipment_Service:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: UPS service type code.
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the service code. Examples are Next Day Air,
Worldwide Express, and Ground.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Service
description: UPS service type.
Shipment_Package:
type: object
maximum: 1
required:
- ChemicalRecord
- TrackingNumber
- PackageWeight
properties:
TrackingNumber:
description: The packages tracking number.
maximum: 1
type: string
minLength: 18
maxLength: 18
PackageWeight:
"$ref": "#/components/schemas/Package_PackageWeight"
TransportationMode:
description: 'Declares that a package was prepared according to ground,
passenger aircraft, or cargo aircraft only. Only required when the CommodityRegulatedLevelCode
is FR or LQ. Valid entries include: GND, CAO, PAX.'
maximum: 1
type: string
minLength: 3
maxLength: 3
VoidIndicator:
description: Indicator to specify that a Dangerous Goods package is voided.
True if VoidIndicator tag exists; false otherwise.
maximum: 1
type: string
PackagePoints:
description: Regulated Commodity Transport Package Score Quantity
maximum: 1
type: string
minLength: 5
maxLength: 5
ChemicalRecord:
type: array
maximum: 3
items:
"$ref": "#/components/schemas/Package_ChemicalRecord"
xml:
name: Package
description: Package Information container.
Package_PackageWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement"
Weight:
description: Packages weight.
maximum: 1
type: string
minLength: 15
maxLength: 15
xml:
name: PackageWeight
maximum: 1
description: Container to hold package weight information.
PackageWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: "Package weight unit of measurement code. \nCodes are: \nLBS
= Pounds\nKGS = Kilograms"
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the unit of measurement for package weight.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: Container to hold UnitOfMeasurement information for package weight.
Package_ChemicalRecord:
type: object
maximum: 1
properties:
ReportableQuantity:
description: Indicates whether or not a material being transported meets the definition of a hazardous material and meets or exceeds a reportable quantity threshold. If reportable quantity is met, "RQ" should be entered. Any other value will be interpreted as "Non Reportable" quantity.
maximum: 1
type: string
minLength: 1
maxLength: 2
ClassDivisionNumber:
description: This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR'
maximum: 1
type: string
minLength: 1
maxLength: 7
SubRiskClass:
description: Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma.)
maximum: 1
type: string
minLength: 7
maxLength: 7
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).
maximum: 1
type: string
minLength: 1
maxLength: 6
PackagingGroupType:
description: |
This is the packing group category associated to the specified commodity. Must be shown in Roman Numerals. Valid values are:
- I
- II
- III
- blank
maximum: 1
type: string
minLength: 1
maxLength: 5
Quantity:
description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good.
maximum: 1
type: string
minLength: 1
maxLength: 5
UOM:
description: Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good.
maximum: 1
type: string
minLength: 1
maxLength: 10
PackagingInstructionCode:
description: The packing instructions related to the chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 4
EmergencyPhone:
description: |
24 Hour Emergency Phone Number of the shipper.
Valid values for this field are (0) through (9) with trailing blanks.
For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries the layout is country code, area code, number. The following are restricted in the phone number
period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT" The following are restricted in the phone number
period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT"
maximum: 1
type: string
minLength: 1
maxLength: 25
EmergencyContact:
description: The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhoneNumber.
maximum: 1
type: string
minLength: 1
maxLength: 35
ProperShippingName:
description: The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LQ or FR.
maximum: 1
type: string
minLength: 1
maxLength: 150
TechnicalName:
description: The technical name (when required) for the specified commodity.
maximum: 1
type: string
minLength: 200
maxLength: 200
AdditionalDescription:
description: Additional remarks or special provision information.
maximum: 1
type: string
minLength: 1
maxLength: 255
PackagingType:
description: "The type of package used to contain the regulated good. (Ex: Fiberboard Box)."
maximum: 1
type: string
minLength: 1
maxLength: 255
HazardLabelRequired:
description: Defines the type of label that is required on the package for the commodity.
maximum: 1
type: string
minLength: 50
maxLength: 50
PackagingTypeQuantity:
description: The number of pieces of the specific commodity. Required if CommodityRegulatedLevelCode = LQ or FR. Valid values are 1 to 999.
maximum: 1
type: string
minLength: 1
maxLength: 3
CommodityRegulatedLevelCode:
description: Indicates the type of commodity, Fully Regulated (FR), Limited Quantity (LQ), Lightly Regulated (LR) Valid values are LR, FR and LQ.
maximum: 1
type: string
minLength: 2
maxLength: 2
TransportCategory:
description: Transport Category. Valid values are 0 to 4.
maximum: 1
type: string
minLength: 1
maxLength: 1
TunnelRestrictionCode:
description: Defines what is restricted to pass through a tunnel.
maximum: 1
type: string
minLength: 1
maxLength: 10
QValue:
description: 'When a HazMat shipment specifies AllPackedInOneIndicator and
the regulation set for that shipment is IATA, Q-Value specifies exactly
one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9;
1.0 Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0'
maximum: 1
type: string
minLength: 3
maxLength: 3
OverPackedIndicator:
description: Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is overpack.
maximum: 1
type: string
AllPackedInOneIndicator:
description: Presence/Absence Indicator. Any value is ignored. Presence indicates if multiple, different hazmat/chemicals are contained within one box in a package
maximum: 1
type: string
xml:
name: ChemicalRecord
required:
- CommodityRegulatedLevelCode
description: Dangerous Goods Accessorial Commodity Container
PreNotificationResponse:
type: object
required:
- Response
properties:
Response:
"$ref": "#/components/schemas/PreNotificationResponse_Response"
xml:
name: PreNotificationResponse
description: Pre-Notification Response container.
maximum: 1
PreNotificationResponse_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 >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
items:
"$ref": "#/components/schemas/Response_Alert"
TransactionReference:
"$ref": "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Contains Pre-Notification 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 1 = Successful.
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Describes Response Status Code. Returns text of Success.
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.
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: Transaction Reference Container.
ErrorResponse:
type: object
properties:
response:
"$ref": "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
properties:
errors:
type: array
description: The error array containing any errors that occurred.
items:
"$ref": "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
code:
type: string
description: The error code.
message:
type: string
description: The error message.
description: The error response containing any errors that occurred.