-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathUPSExportAssure.yaml
More file actions
2028 lines (1965 loc) · 84.1 KB
/
UPSExportAssure.yaml
File metadata and controls
2028 lines (1965 loc) · 84.1 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.1.0
info:
title: Export Assure API - Cross-Border Trade Guidance-v1
description: |
This API offers businesses a powerful tool to manage shipping compliance with Description Guidance, Power of Attorney (POA) Requirements, UPS Prohibited Goods, and Commodity Compliance Guidance in order to help prevent delays, avoid fines, and keep your customers happy with fast, hassle-free customs clearances.
For more information on the Export Assure API, please visit the <a href="https://developer.ups.com/api/reference/exportassure/product-info" target="_blank" rel="noopener">Product Info</a> page.
<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-eda5a2d6-ca6f-4a02-8e66-c43d9861ac2d?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-eda5a2d6-ca6f-4a02-8e66-c43d9861ac2d%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>
## Key Features
### 1. Basic Description Guidance (Free Feature)
This feature helps you avoid commonly used, invalid shipment descriptions to avoid hold-ups at customs. For comprehensive description guidance, please refer the Interactive Commodity Description API. Basic Description Guidance includes:
- Checking your commodity description against commonly used descriptions that typically result in a customs delay.
- Provide basic guidance for improving an invalid commodity description.
### 2. Power of Attorney (POA) Requirements
Understanding legal permissions is key for obeying international trade laws. This feature:
- Reviews commodity details for POA requirements.
- Determines when a POA is needed for customs clearance.
- Proactively notifies user of POA requirement to help avoid customs delays.
### 3. UPS Prohibited Goods Guidance (Free Feature)
Note that this must be turned on in order to use feature 4,
- Reviews commodity details for POA requirements.
- Note 1: evaluateImportExportRequirements is the name of the endpoint which performs the UPS Prohibited goods check. There is no charge to call this endpoint.
- Note 2: evaluateImportExportRequirements MUST be set to true in order to use Feature #4
### 4. Commodity Compliance Guidance (Premium Feature)
This premium feature checks for any restrictions or prohibitions for the specific commodity you are shipping (including any forms needed to clear customs) for the country you are shipping to. A chargeable event is when guidance is provided, including that no restrictions and prohibitions are found. Commodity Compliance Guidance requires a full, destination country specific tariff code to provide guidance. If you do not have this for each product in each country you ship to, you can use the Export Assure: Interactive Commodity Description API to determine this. Included in Commodity Compliance Guidance is:
- Details on what commodities can be shipped to and from specific locations, including restrictions based on the country of origin of the good.
- Information specific to the commodities and origins/destinations.
- Notification for international shipping forms needed for the commodity to clear customs.
- Note 1: evaluateImportExportRequirements - the free feature for UPS Prohibited Goods - MUST be set to true in order to use Commodity Compliance Guidance
- Note 2: advancedImportExportRequirements is the endpoint for Commodity Compliance Guidance, and will incur a charge each time guidance is provided
security:
- OAuth2: []
servers:
- url: https://wwwcie.ups.com/api/brokerage/{version}
description: Production CIE - External Interface
variables:
version:
default: v1
enum:
- v1
- url: https://onlinetools.ups.com/api/brokerage/{version}
description: Production - External Interface
variables:
version:
default: v1
enum:
- v1
paths:
/importexport/exportassure:
post:
operationId: submitExportAssure
tags:
- Export Assure
summary: Submit shipment details for compliance guidance
parameters:
- $ref: '#/components/parameters/AccountNumber'
- $ref: '#/components/parameters/TransactionSrc'
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/Accept'
- name: version
in: path
description: version
required: true
schema:
type: string
default: v1
enum:
- v1
description: |
Submit shipment details and receive guidance from UPS.
This endpoint includes four separate operations which may be requested individually or simultaneously:
- Basic Description Guidance (Free Feature)
- Power of Attorney (POA) Requirements (Free Feature)
- UPS Prohibited Goods Guidance (Free Feature)
- Commodity Compliance Guidance (Premium Feature)
- NOTE: requires UPS Prohibited Goods Guidance (evaluateImportExportRequirements) to be set to true.
To request a specific operation, set the respective value for that property to true:
- evaluateDescriptions to request basic description guidance for the shipment (free)
- evaluatePoaRequirements to request POA requirements for the shipment (free)
- evaluateImportExportRequirements to request UPS Prohibited Goods Guidance only (free)
- evaluateAdvancedImportExportRequirements to request regulatory requirements, shipping restrictions, and required international forms (premium)
Examples:
- To request only Description Guidance, set evaluateDescriptions: true and provide relevant description properties.
- To request all three free operations, set evaluateDescriptions: true, evaluatePoaRequirements: true, evaluateImportExportRequirements: true, and include all required properties for all operations.
- To request Commodity Compliance Guidance, set advancedImportExportRequirements: true, evaluateImportExportRequirements: true, and include all required properties for all operations.
- If you do not wish to be charged, set advancedImportExportRequirements: false
security:
- OAuth2: []
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ExportAssureRequest"
examples:
descriptionGuidanceRequestExample:
$ref: "#/components/examples/sample-description-guidance-request"
poaGuidanceRequestExample:
$ref: '#/components/examples/sample-poa-guidance-request'
importExportComplianceRequestExample:
$ref: "#/components/examples/sample-import-export-compliance-request"
allGuidanceRequestExample:
$ref: "#/components/examples/sample-all-guidance-request"
responses:
"200":
description: OK
headers:
application/json:
schema:
$ref: "#/components/schemas/SuccessResponseHeaders"
content:
application/json:
schema:
$ref: '#/components/schemas/ExportAssureResponse'
examples:
descriptionGuidanceResponseExample:
$ref: "#/components/examples/sample-description-guidance-response"
poaGuidanceResponseExample:
$ref: '#/components/examples/sample-poa-guidance-response'
importExportComplianceResponseExample:
$ref: "#/components/examples/sample-import-export-compliance-response"
allGuidanceResponseExample:
$ref: "#/components/examples/sample-all-guidance-response"
cieResponseExample:
$ref: "#/components/examples/cie-success-response"
"207":
description: Multi-Status. This is an example where inquiry was made for multiple compliance areas but not all succeeded.
headers:
application/json:
schema:
$ref: "#/components/schemas/BackendErrorResponseHeaders"
content:
application/json:
schema:
$ref: '#/components/schemas/ExportAssurePartialResponse'
examples:
samplePartialResponse:
$ref: "#/components/examples/sample-partial-response"
'400':
description: Bad Request
headers:
application/json:
schema:
$ref: "#/components/schemas/BackendErrorResponseHeaders"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
errors:
- code: "EA_POA_04"
message: Country code is not valid
field: evaluateImportExportRequirements
value: 'NB'
type: POA
perfStats:
absLayerTime: "575"
fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024
receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024
'401':
description: Unauthorized
headers:
application/json:
schema:
$ref: "#/components/schemas/GatewayErrorResponseHeaders"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
errors:
- code: "UJ0001"
message: Invalid token or token is not present
perfStats:
absLayerTime: "575"
fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024
receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024
'404':
description: Not Found
headers:
application/json:
schema:
$ref: "#/components/schemas/GatewayErrorResponseHeaders"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
errors:
- code: "404"
message: The requested resource was not found
perfStats:
absLayerTime: "575"
fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024
receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024
'405':
description: Method Not Allowed
headers:
application/json:
schema:
$ref: "#/components/schemas/GatewayErrorResponseHeaders"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
errors:
- code: "405"
message: The requested method is not allowed for this resource
perfStats:
absLayerTime: "575"
fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024
receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024
"415":
description: Not Acceptable
headers:
application/json:
schema:
$ref: "#/components/schemas/GatewayErrorResponseHeaders"
'500':
description: Internal Server Error
headers:
application/json:
schema:
$ref: "#/components/schemas/BackendErrorResponseHeaders"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
errors:
- code: "500"
message: Internal server error
perfStats:
absLayerTime: "575"
fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024
receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024
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 values for all parameters and properties
5. Select **Send** to send your API request
flows:
clientCredentials:
x-tokenEndpointAuthMethod: client_secret_basic
tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token
scopes: {}
schemas:
AccountNumber:
description: UPS account number
type:
- string
- "null"
maxLength: 10
pattern: '^[a-zA-Z0-9]*$'
examples:
- "985123"
- "766554"
- "446332"
CommodityId:
description: The commodity ID returned in the Import Export Compliance report.
type: string
maxLength: 50
pattern: ^[\s\S]*$
examples:
- "28b210b9-e686-4617-8cf4-9973e3ed4087"
- "8f971462-5e68-469a-809f-637a12af1305"
ComplianceDetails:
description: This object contains details of specific compliance requirements and controls that are applicable to the shipment, based on whether it is for import or export purposes.
type: object
properties:
categoryType:
description: Whether the compliance assessment regards imports or exports
type: string
minLength: 6
maxLength: 6
enum:
- Import
- Export
controlTypes:
type: array
minItems: 1
items:
$ref: "#/components/schemas/ControlTypes"
additionalProperties: false
required:
- categoryType
- controlTypes
ControlDetails:
description: This object contains an array of warning messages related to this control type.
type: object
properties:
controlDetailName:
type: string
description: |-
The formal name or title of the control measure. This property serves as the header for `ControlDetails`. Where no specific control name is applicable, this field may be left empty (and consequently, no header will be displayed in the response). This property is translated to the user's language as required.
**Note**: When the `controlTypeCode` is set to `DOC`, the `controlDetailName` is also the identifier for the corresponding DocuSign template.
maxLength: 150
pattern: ^[\s\S]*$
examples:
- Controlling Authority
- Free Trade Agreement
controlDetailDescription:
description: A detailed description of the control measure, translated for the user as required.
type: string
maxLength: 4000
pattern: '^[\s\S]*$'
examples:
- Trade Agreement between the United States and Canada (USMCA)
- Caribbean Basin Economic Recovery Act
additionalProperties: false
required:
- controlDetailName
- controlDetailDescription
ControlTypes:
description: This object includes specific type of customs controls applicable to a shipment.
type: object
properties:
controlType:
description: The category of customs control applicable to the shipment. This property is translated to the user's language as required.
type: string
minLength: 1
maxLength: 100
pattern: ^[\s\S]*$
examples:
- Prohibition
- Embargo/Sanction
- Sample Data
- Import License
controlTypeCode:
description: A unique code that distinctly identifies each control type. This code is not translated and is used for specific system-logic related to the control type.
type: string
maxLength: 50
pattern: ^[\s\S]*$
examples:
- DOC
- FTA
isRequired:
description: Whether shipment compliance with a specific control type is required
type: string
maxLength: 10
enum:
- "Yes"
- Maybe
- Applicable
controlTypeMessage:
description: Additional guidance or instructions based on the specific control type condition.
type: string
minLength: 1
maxLength: 4000
pattern: ^[\s\S]*$
examples:
- Import Certificate may be required
- Free Trade Agreement may be applicable
controlDetails:
description: An array that contains a list of control types and codes
type: array
minItems: 1
items:
$ref: "#/components/schemas/ControlDetails"
additionalProperties: false
required:
- controlType
- controlTypeCode
- controlTypeMessage
- controlDetails
CountryCodes:
description: The <a href="https://developer.ups.com/api/reference/shipping/appendix1" target="_blank" rel="noopener noreferrer">two-letter identification code</a> for countries.
type: string
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z0-9]{2}$
examples:
- AU
- US
- UK
- FR
- JP
CurrencyCodes:
description: |-
The three-letter code that represents the currency used to value the items in the shipment.
| Supported enum values |
| :--------------------------- |
| `ARS`<br>Argentine Peso |
| `AUD`<br>Australian Dollar |
| `BRL`<br>Brazilian Real |
| `CAD`<br>Canadian Dollar |
| `CHF`<br>Swiss Franc |
| `CLP`<br>Chilean Peso |
| `CNY`<br>Chinese Yuan |
| `CRC`<br>Costa Rican Colon |
| `DKK`<br>Danish Krone |
| `DOP`<br>Dominican Peso |
| `EUR`<br>Euro |
| `GBP`<br>Great Britain Pound |
| `HKD`<br>Hong Kong Dollar |
| `INR`<br>India Rupee |
| `JPY`<br>Japanese Yen |
| `KRW`<br>Korean Won |
| `MXN`<br>Mexican Peso |
| `MYR`<br>Malaysian Ringgit |
| `NOK`<br>Norwegian Kroner |
| `NZD`<br>New Zealand Dollar |
| `PEN`<br>Peruvian Nuevo Sol |
| `PHP`<br>Philippine Peso |
| `PLN`<br>Polish Zloty |
| `SEK`<br>Swedish Krona |
| `SGD`<br>Singapore Dollar |
| `THB`<br>Thai Baht |
| `TWD`<br>Taiwan Dollar |
| `USD`<br>US Dollar |
| `VEB`<br>Venezuelan Bolivar |
type: string
minLength: 3
maxLength: 3
pattern: ^[a-zA-Z0-9]{3}$
enum:
- ARS
- AUD
- BRL
- CAD
- CHF
- CLP
- CNY
- CRC
- DKK
- DOP
- EUR
- GBP
- HKD
- INR
- JPY
- KRW
- MXN
- MYR
- NOK
- NZD
- PEN
- PHP
- PLN
- SEK
- SGD
- THB
- TWD
- USD
- VEB
DescriptionGuidanceResponse:
description: This object contains the system's results to a request for Description Guidance
type: object
properties:
isMatched:
description: Whether the description guidance service has matched a keyword from the shipment description
type: boolean
default: false
examples:
- true
- false
message:
description: A message with guidance on how to improve the shipment description
type: string
pattern: ^[\s\S]*$
examples:
- DVD Player
- Stereo
sourceListName:
description: A list of terminology used to describe items from a particular regional source
type: string
maxLength: 250
pattern: ^[\s\S]*$
examples:
- USA
- France
- Germany
matchedKeyword:
description: The keyword(s) from the shipment description that matched the system criteria
type: string
maxLength: 250
pattern: ^[\s\S]*$
examples:
- goods
- clothing
- perishables
ErrorResponse:
description: This object is the primary container for error responses.
type: object
properties:
response:
$ref: "#/components/schemas/ErrorResponseWrapper"
perfStats:
$ref: "#/components/schemas/ALPerfStats"
required:
- response
- perfStats
ErrorResponseWrapper:
description: This object contains an array of error codes.
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/ErrorCode'
required:
- errors
ErrorCode:
description: This object contains error codes, error descriptions and other error properties.
type: object
properties:
code:
description: The error code.
type: string
pattern: '^[a-zA-Z0-9\-_\.]+$'
examples:
- 400
- 401
- 404
description:
description: Description of the error.
pattern: '^[a-zA-Z0-9\-_\s:]+$'
examples:
- Not Found
- Unauthorized
message:
description: Additional information for the user.
type: string
pattern: '^[a-zA-Z0-9\-_\s:]+$'
examples:
- Country Code is not valid
- Value is too large
field:
description: The path to the field causing the error as returned from the API backend services
type: string
pattern: '^[a-zA-Z0-9\-_\s:\.\[\]]+$'
examples:
- evaluateImportExportRequirements
- evaluatePoaRequirements
- evaluateImportExportRequirements
value:
description: The value that caused the error
type: string
pattern: ^[\s\S]*$
examples:
- US
- EU
- NB
type:
description: |-
Specific operation the error message is relevant to.
| Supported enum values |
| :------------------------------------- |
| `DG`<br>Description Guidance |
| `POA`<br>Power of Attorney Requirement |
| `IEC`<br>Import Export Compliance |
type: string
minLength: 2
maxLength: 3
enum:
- DG
- IEC
- POA
additionalProperties: false
EvaluationCriteria:
description: |-
Criteria for evaluating POA requirements for both importer and exporter. Supported values:
| Supported enum values |
| :-------------------------------------------------------------------------------------------------------------- |
| `NonConditional`<br>Standard evaluation without specific conditional criteria |
| `Description`<br>Evaluation based on the detailed description of the commodity |
| `FTA`<br>Free Trade Agreement. Evaluation considers Free Trade Agreement stipulations applicable to the shipment. |
| `Value`<br>Evaluation based on the monetary value of the commodities |
| `HTS`<br>Harmonized Tariff Schedule. Evaluation uses HTS codes for tariff classification and compliance |
| `Quantity`<br>Evaluation focuses on the quantity of the goods being shipped |
| `Weight`<br>Evaluation based on the weight of the shipment |
type: string
enum:
- NonConditional
- Description
- FTA
- Value
- HTS
- Quantity
- Weight
- HTS PGA
minLength: 3
maxLength: 14
pattern: ^[a-zA-Z0-9\-_\s:]+$
ExportAssureRequest:
description: This object is the primary request structure for the Export Assure API.
type: object
properties:
transID:
description: The unique, reference identifier that correlates an API request with its response
type: string
maxLength: 50
pattern: ^[\s\S]*$
examples:
- 10d622cc-a453-4054-bb62-ed71e6fc2239
- 798fe81e-2f28-430d-96fd-d45f0c7fe36a
evaluateDescriptions:
description: Whether the user has requested description guidance
type: boolean
default: true
examples:
- true
- false
evaluatePoaRequirements:
description: Whether the user has requested Power of Attorney (POA) requirements
type: boolean
default: true
examples:
- true
- false
evaluateAdvancedImportExportRequirements:
description: Whether the user has requested an Advanced Import/Export Compliance review
type: boolean
default: false
examples:
- true
- false
evaluateImportExportRequirements:
description: Whether the user has requested an Import/Export Compliance review
type: boolean
default: true
examples:
- true
- false
shipment:
$ref: "#/components/schemas/ShipmentRequest"
additionalProperties: false
required:
- transID
- shipment
ExportAssureResponse:
description: This object is the primary request container for the Export Assure API.
type: object
properties:
transID:
$ref: '#/components/schemas/TransactionID'
shipment:
$ref: "#/components/schemas/ShipmentResponse"
perfStats:
$ref: "#/components/schemas/ALPerfStats"
additionalProperties: false
required:
- transID
- shipment
- perfStats
ExportAssurePartialResponse:
description: This object is the primary response container for the Export Assure API.
type: object
properties:
transID:
$ref: '#/components/schemas/TransactionID'
shipment:
$ref: "#/components/schemas/ShipmentResponse"
response:
$ref: "#/components/schemas/ErrorResponseWrapper"
perfStats:
$ref: "#/components/schemas/ALPerfStats"
additionalProperties: false
required:
- transID
- shipment
- response
- perfStats
HsCode:
description: The [Harmonized System (HS) code](https://www.trade.gov/harmonized-system-hs-codes). Used commonly throughout the export process for goods, the Harmonized System is a standardized numerical method of classifying traded products. It is used by customs authorities to identify products when assessing duties and taxes.
type: string
maxLength: 13
pattern: ^[0-9.]{4,13}$
examples:
- "3605.00.00.00"
- "3605000000"
- "3925.90.00.00"
- "3925900000"
ImportExportShipmentLevelResponse:
description: This object contains properties which describe the shipment's compliance with laws and regulations.
type: object
properties:
shipmentValue:
type: number
description: The total monetary value of all items included in the shipment
format: double
maximum: 999999999999.99
examples:
- 1500.25
- 456.99
- 9977.00
shipmentCurrencyCode:
description: The three-letter code of the currency used to value the items in the shipment.
$ref: '#/components/schemas/CurrencyCodes'
translationLocale:
$ref: "#/components/schemas/TranslationLocale"
hasShipmentWarnings:
description: Whether there are shipment-level warning. Shipment-level warnings include issues related to documentation and shipment packaging.
type: boolean
examples:
- true
- false
hasCommodityWarnings:
description: Whether there are compliance-related warnings or issues at the commodity level within the shipment. A `true` value indicates potential compliance concerns that require the shipper's attention.
type: boolean
examples:
- true
- false
commodityWarningsMessage:
description: The warning message returned when the `hasCommodityWarnings` flag is set to true
type: string
pattern: ^[\s\S]*$
examples:
- Your shipment may have additional clearance considerations
- Some shipment items may be prohibited from import to the EU
isShipmentOverGiftValueThreshold:
type: boolean
description: Whether the total value of the shipment exceeds the allowable threshold for categorizing it as a gift
examples:
- true
- false
shipmentOverGiftValueThresholdMessage:
description: The message returned if the shipment's value surpasses the threshold for gift categorization
type: string
pattern: ^[\s\S]*$
examples:
- "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided"
- "Your shipment may incur additional charges due to shipment value."
isShipmentOverGiftWeightThreshold:
description: Whether the total weight of the shipment exceeds the weight limit for being classified as a gift
type: boolean
examples:
- true
- false
shipmentOverGiftWeightThresholdMessage:
description: A message explaining the implications if the shipment's weight goes beyond the threshold for gift categorization, guiding users in understanding customs considerations.
type: string
pattern: ^[\s\S]*$
examples:
- "Your shipment may not be considered as a gift by Customs authorities due to the shipment weight provided"
- "Your shipment may incur additional charges due to shipment weight."
additionalProperties: false
required:
- shipmentCurrencyCode
- hasShipmentWarnings
- hasCommodityWarnings
- isShipmentOverGiftValueThreshold
- isShipmentOverGiftWeightThreshold
ImportExportItemLevelResponse:
description: This object includes details of the Import Export Compliance assessment.
type: object
properties:
isUpsProhibited:
description: Whether UPS prohibits shipment of the item
type: boolean
examples:
- true
- false
upsProhibitedMessage:
description: A message explaining the reason for any prohibited shipment
oneOf:
- type: 'null'
- type: string
pattern: ^[\s\S]*$
examples:
- US federal law prohibits shipment of this item from the US.
- The EU prohibits import of this item.
isTranslatedIndicator:
description: Whether shipment details have been translated from the language of the origin country to the user's language
type: boolean
examples:
- true
- false
complianceOutput:
description: This array includes the output of the compliance review, including customs category and control codes.
type: array
minItems: 0
items:
$ref: "#/components/schemas/ComplianceDetails"
additionalProperties: false
required:
- isUpsProhibited
- isTranslatedIndicator
PowerOfAttorneyResponse:
description: This object includes details of the Power of Attorney (POA) requirements for the shipment.
type: object
properties:
importerPoaRequiredFlag:
description: Whether Power of Attorney (POA) is required for the importer
type: boolean
examples:
- true
- false
importerEvaluationCriteria:
$ref: "#/components/schemas/EvaluationCriteria"
importerPoaOnFileIndicator:
description: Whether the importer already has a POA on file
type:
- string
- "null"
maxLength: 3
enum:
- "Yes"
- "No"
- null
importerCommodityId:
description: The first commodity in the shipment that necessitates an importer POA
$ref: '#/components/schemas/CommodityId'
importerCommodityDescription:
description: A description of the commodity regarding what led to the POA requirement for the importer
type: string
pattern: ^[\s\S]*$
examples:
- EQUIPMENT
- COMPUTERS
- BICYCLES
exporterPoaRequiredFlag:
description: Whether the exporter is required to provide a POA for customs clearance.
type: boolean
examples:
- true
- false
exporterEvaluationCriteria:
description: This schema includes details of whether a POA is required for the exporter.
$ref: "#/components/schemas/EvaluationCriteria"
exporterPoaOnFileIndicator:
description: Whether the exporter has a POA already on file
type:
- string
- "null"
maxLength: 3
enum:
- "Yes"
- "No"
- null
exporterCommodityId:
description: The first commodity in the shipment that necessitated an exporter POA
$ref: '#/components/schemas/CommodityId'
exporterCommodityDescription:
description: The commodity that triggers the POA requirement for the exporter
type: string
pattern: ^[\s\S]*$
examples:
- Dynamite
exporterOnlineFormFlag:
description: Whether there is an online form available for the exporter to complete their POA documentation
type: boolean
examples:
- true
- false
exporterDocuSignTemplateId:
description: The ID of the DocuSign template, which the exporter can use for electronic completion of the POA.
type: string
maxLength: 100
pattern: ^[a-zA-Z0-9\-_\s:]+$
examples:
- f215a2b8-8fad-4610-b06e-76877ec3016c
- 8f971462-5e68-469a-809f-637a12af1305
required:
- importerPoaRequiredFlag
- exporterPoaRequiredFlag
- exporterOnlineFormFlag
ShipmentRequest:
description: This object contains all necessary details about a shipment for compliance evaluation.
type: object
properties:
importerName:
description: The name of the importer
type: string
pattern: ^[\s\S]*$
maxLength: 100
examples:
- Ford
- Acme
importerCity:
description: The city where the importer is located. Required if both importer's account number and importer's zip code are not provided and POA evaluation is requested.
type: string
maxLength: 100
pattern: ^[\s\S]*$
examples:
- Detroit
- Paris
- Amsterdam
- New York
importerZipcode:
description: The postal code of the importer's location. Required when the importer's account number and city are not specified and POA evaluation is requested.
type: string
pattern: ^[a-zA-Z0-9\-\s]+$
examples:
- "48204"
- "46664"
importerAccountNumber:
description: The UPS account number of the importer
type:
- string
- "null"
pattern: '^[a-zA-Z0-9]*$'
minLength: 6
maxLength: 10
examples:
- "985123"
- "766554"
- "446332"
exporterName:
description: The name of the exporter. Required when the exporter's UPS account number is not available and POA requirements are under review.
type: string
pattern: ^[\s\S]*$
maxLength: 100
examples:
- Lear
- Acme
exporterCity:
description: The city from which the exporter operates. Required if exporter's account number and zip code are not given and POA evaluation is requested.
type: string
maxLength: 100
pattern: ^[\s\S]*$
examples:
- Windsor
- Paris
- Amsterdam
exporterZipcode:
description: The postal code of the exporter's location. Required when exporter's account number and city are not provided and POA evaluation is requested.
type: string
pattern: ^[a-zA-Z0-9\-\s]+$
examples:
- "20836"
- "43322"
exporterAccountNumber:
description: The UPS account number of the exporter
type: string
pattern: '^[a-zA-Z0-9]*$'
maxLength: 20
examples:
- "998562"
- "767839"
- "332532"
id:
description: The Shipment ID included on the Import Export compliance report.
$ref: '#/components/schemas/ShipmentId'
importCountryCode: