@flowio/api-mock-generator 6.17.110 → 6.17.112
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.json +2051 -474
- package/package.json +2 -2
- package/src/api.json +2051 -474
package/dist/api.json
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
"key": "api"
|
|
8
8
|
},
|
|
9
9
|
"namespace": "io.flow.v0",
|
|
10
|
-
"version": "0.20
|
|
10
|
+
"version": "0.21.20",
|
|
11
11
|
"info": {
|
|
12
12
|
"license": {
|
|
13
13
|
"name": "MIT",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"application": {
|
|
29
29
|
"key": "channel-internal"
|
|
30
30
|
},
|
|
31
|
-
"version": "0.
|
|
31
|
+
"version": "0.28.34",
|
|
32
32
|
"enums": ["channel_order_acceptance_error_action", "channel_order_acceptance_failure_reason_code", "channel_order_acceptance_next_action_from", "channel_order_acceptance_rejection_reason", "channel_order_acceptance_status", "channel_service", "order_payment_source_type"],
|
|
33
33
|
"interfaces": [],
|
|
34
34
|
"unions": [],
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"application": {
|
|
44
44
|
"key": "apple-pay"
|
|
45
45
|
},
|
|
46
|
-
"version": "0.4.
|
|
46
|
+
"version": "0.4.63",
|
|
47
47
|
"enums": ["apple_pay_contact_field", "apple_pay_line_item_type", "apple_pay_merchant_capability", "apple_pay_shipping_type", "apple_pay_supported_networks"],
|
|
48
48
|
"interfaces": [],
|
|
49
49
|
"unions": [],
|
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
"application": {
|
|
59
59
|
"key": "google-pay"
|
|
60
60
|
},
|
|
61
|
-
"version": "0.4.
|
|
61
|
+
"version": "0.4.63",
|
|
62
62
|
"enums": ["auth_method", "billing_address_format", "card_gateway", "card_network", "payment_method_type", "tokenization_type", "total_price_status"],
|
|
63
63
|
"interfaces": [],
|
|
64
64
|
"unions": ["payment_method_token"],
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"application": {
|
|
74
74
|
"key": "shopify-external"
|
|
75
75
|
},
|
|
76
|
-
"version": "0.4.
|
|
76
|
+
"version": "0.4.63",
|
|
77
77
|
"enums": ["cancel_reason", "discount_status", "discount_type", "discrepancy_reason", "event", "financial_status_type", "format", "fulfillment_service", "fulfillment_status_type", "graphql_weight_unit", "inventory_behaviour", "inventory_management", "inventory_policy", "kind_type", "localized_price", "order_status_type", "price_rule_allocation_method", "price_rule_customer_selection", "price_rule_target_selection", "price_rule_target_type", "price_rule_value_type", "published_scope", "restock_type", "shopify_customer_state", "shopify_discount_pagination_direction", "shopify_gift_card_status", "shopify_plan_name", "shopify_processing_method_type", "shopify_transaction_error_code", "shopify_transaction_status", "topic", "value_type", "weight_unit"],
|
|
78
78
|
"interfaces": [],
|
|
79
79
|
"unions": [],
|
|
@@ -88,27 +88,12 @@
|
|
|
88
88
|
"application": {
|
|
89
89
|
"key": "ben-test-internal"
|
|
90
90
|
},
|
|
91
|
-
"version": "0.
|
|
91
|
+
"version": "0.28.33",
|
|
92
92
|
"enums": [],
|
|
93
93
|
"interfaces": ["generate_load"],
|
|
94
94
|
"unions": ["generate_load"],
|
|
95
95
|
"models": ["generate_load_multiple_orgs", "generate_load_single_org", "test", "test_form"],
|
|
96
96
|
"annotations": []
|
|
97
|
-
}, {
|
|
98
|
-
"uri": "https://app.apibuilder.io/flow/tech-onboarding-playground/latest/service.json",
|
|
99
|
-
"namespace": "io.flow.tech.onboarding.playground.v0",
|
|
100
|
-
"organization": {
|
|
101
|
-
"key": "flow"
|
|
102
|
-
},
|
|
103
|
-
"application": {
|
|
104
|
-
"key": "tech-onboarding-playground"
|
|
105
|
-
},
|
|
106
|
-
"version": "0.27.33",
|
|
107
|
-
"enums": ["aldo_item_type", "anirban_item_type", "ansh_item_type", "hosein_item_type", "niall_item_type", "prateek_item_type", "rohan_item_type", "sarvesh_item_type"],
|
|
108
|
-
"interfaces": [],
|
|
109
|
-
"unions": [],
|
|
110
|
-
"models": ["aldo_item", "aldo_item_form", "anirban_item", "anirban_item_form", "ansh_item", "ansh_item_form", "hosein_item", "hosein_item_form", "jean_demo_item", "niall_item", "niall_item_form", "prateek_item", "prateek_item_form", "rohan_item", "rohan_item_form", "sarvesh_item", "sarvesh_item_form", "tech_onboarding_description"],
|
|
111
|
-
"annotations": []
|
|
112
97
|
}],
|
|
113
98
|
"enums": [{
|
|
114
99
|
"name": "abandoned_order_promotion_status",
|
|
@@ -774,6 +759,19 @@
|
|
|
774
759
|
"attributes": []
|
|
775
760
|
}],
|
|
776
761
|
"attributes": []
|
|
762
|
+
}, {
|
|
763
|
+
"name": "commercial_invoice_mode",
|
|
764
|
+
"plural": "commercial_invoice_modes",
|
|
765
|
+
"values": [{
|
|
766
|
+
"name": "direct",
|
|
767
|
+
"attributes": [],
|
|
768
|
+
"description": "Commercial Invoice mode to use when taxes are paid directly by GE"
|
|
769
|
+
}, {
|
|
770
|
+
"name": "indirect",
|
|
771
|
+
"attributes": [],
|
|
772
|
+
"description": "Commercial Invoice mode to use when taxes are paid by Carrier or Indirectly by GE"
|
|
773
|
+
}],
|
|
774
|
+
"attributes": []
|
|
777
775
|
}, {
|
|
778
776
|
"name": "consumer_invoice_customer_type",
|
|
779
777
|
"plural": "consumer_invoice_customer_types",
|
|
@@ -1256,48 +1254,6 @@
|
|
|
1256
1254
|
}, {
|
|
1257
1255
|
"name": "generate_load",
|
|
1258
1256
|
"attributes": []
|
|
1259
|
-
}, {
|
|
1260
|
-
"name": "sarvesh_item_upserted",
|
|
1261
|
-
"attributes": []
|
|
1262
|
-
}, {
|
|
1263
|
-
"name": "sarvesh_item_deleted",
|
|
1264
|
-
"attributes": []
|
|
1265
|
-
}, {
|
|
1266
|
-
"name": "hosein_item_upserted",
|
|
1267
|
-
"attributes": []
|
|
1268
|
-
}, {
|
|
1269
|
-
"name": "hosein_item_deleted",
|
|
1270
|
-
"attributes": []
|
|
1271
|
-
}, {
|
|
1272
|
-
"name": "niall_item_upserted",
|
|
1273
|
-
"attributes": []
|
|
1274
|
-
}, {
|
|
1275
|
-
"name": "niall_item_deleted",
|
|
1276
|
-
"attributes": []
|
|
1277
|
-
}, {
|
|
1278
|
-
"name": "rohan_item_upserted",
|
|
1279
|
-
"attributes": []
|
|
1280
|
-
}, {
|
|
1281
|
-
"name": "rohan_item_deleted",
|
|
1282
|
-
"attributes": []
|
|
1283
|
-
}, {
|
|
1284
|
-
"name": "aldo_item_upserted",
|
|
1285
|
-
"attributes": []
|
|
1286
|
-
}, {
|
|
1287
|
-
"name": "aldo_item_deleted",
|
|
1288
|
-
"attributes": []
|
|
1289
|
-
}, {
|
|
1290
|
-
"name": "ansh_item_upserted",
|
|
1291
|
-
"attributes": []
|
|
1292
|
-
}, {
|
|
1293
|
-
"name": "ansh_item_deleted",
|
|
1294
|
-
"attributes": []
|
|
1295
|
-
}, {
|
|
1296
|
-
"name": "anirban_item_upserted",
|
|
1297
|
-
"attributes": []
|
|
1298
|
-
}, {
|
|
1299
|
-
"name": "anirban_item_deleted",
|
|
1300
|
-
"attributes": []
|
|
1301
1257
|
}, {
|
|
1302
1258
|
"name": "transaction_upserted",
|
|
1303
1259
|
"attributes": []
|
|
@@ -1616,6 +1572,12 @@
|
|
|
1616
1572
|
}, {
|
|
1617
1573
|
"name": "ecommerce_platform_deleted",
|
|
1618
1574
|
"attributes": []
|
|
1575
|
+
}, {
|
|
1576
|
+
"name": "tax_registration_upserted",
|
|
1577
|
+
"attributes": []
|
|
1578
|
+
}, {
|
|
1579
|
+
"name": "tax_registration_deleted",
|
|
1580
|
+
"attributes": []
|
|
1619
1581
|
}, {
|
|
1620
1582
|
"name": "organization_onboarding_state_upserted",
|
|
1621
1583
|
"attributes": []
|
|
@@ -1757,6 +1719,12 @@
|
|
|
1757
1719
|
}, {
|
|
1758
1720
|
"name": "product_restriction_result_deleted",
|
|
1759
1721
|
"attributes": []
|
|
1722
|
+
}, {
|
|
1723
|
+
"name": "product_sellability_result_upserted",
|
|
1724
|
+
"attributes": []
|
|
1725
|
+
}, {
|
|
1726
|
+
"name": "product_sellability_result_deleted",
|
|
1727
|
+
"attributes": []
|
|
1760
1728
|
}, {
|
|
1761
1729
|
"name": "shopify_localization_setting_upserted",
|
|
1762
1730
|
"attributes": []
|
|
@@ -1766,6 +1734,9 @@
|
|
|
1766
1734
|
}, {
|
|
1767
1735
|
"name": "tracking_label_event_upserted",
|
|
1768
1736
|
"attributes": []
|
|
1737
|
+
}, {
|
|
1738
|
+
"name": "tracking_label_event_upserted_v2",
|
|
1739
|
+
"attributes": []
|
|
1769
1740
|
}],
|
|
1770
1741
|
"attributes": [{
|
|
1771
1742
|
"name": "docs",
|
|
@@ -3504,6 +3475,9 @@
|
|
|
3504
3475
|
}, {
|
|
3505
3476
|
"name": "sp",
|
|
3506
3477
|
"attributes": []
|
|
3478
|
+
}, {
|
|
3479
|
+
"name": "mor_tax",
|
|
3480
|
+
"attributes": []
|
|
3507
3481
|
}],
|
|
3508
3482
|
"attributes": [],
|
|
3509
3483
|
"description": "The type of fee that is applied to a payment."
|
|
@@ -3776,7 +3750,7 @@
|
|
|
3776
3750
|
"attributes": []
|
|
3777
3751
|
}],
|
|
3778
3752
|
"attributes": [],
|
|
3779
|
-
"description": "
|
|
3753
|
+
"description": "Payout status failure code"
|
|
3780
3754
|
}, {
|
|
3781
3755
|
"name": "pending_payout_transaction_reason_code",
|
|
3782
3756
|
"plural": "pending_payout_transaction_reason_codes",
|
|
@@ -4063,6 +4037,15 @@
|
|
|
4063
4037
|
"attributes": []
|
|
4064
4038
|
}],
|
|
4065
4039
|
"attributes": []
|
|
4040
|
+
}, {
|
|
4041
|
+
"name": "pricing_type",
|
|
4042
|
+
"plural": "pricing_types",
|
|
4043
|
+
"values": [{
|
|
4044
|
+
"name": "inclusive_pricing",
|
|
4045
|
+
"attributes": []
|
|
4046
|
+
}],
|
|
4047
|
+
"attributes": [],
|
|
4048
|
+
"description": "Describes the order pricing type classifications, if any."
|
|
4066
4049
|
}, {
|
|
4067
4050
|
"name": "promotion_trigger_type",
|
|
4068
4051
|
"plural": "promotion_trigger_types",
|
|
@@ -4288,6 +4271,24 @@
|
|
|
4288
4271
|
}],
|
|
4289
4272
|
"attributes": [],
|
|
4290
4273
|
"description": "review status of a restricted product."
|
|
4274
|
+
}, {
|
|
4275
|
+
"name": "restriction_environment",
|
|
4276
|
+
"plural": "restriction_environments",
|
|
4277
|
+
"values": [{
|
|
4278
|
+
"name": "sandbox",
|
|
4279
|
+
"attributes": [],
|
|
4280
|
+
"description": "In sandbox, no external services (e.g. orders, payments, logistics) will generate real transactions"
|
|
4281
|
+
}, {
|
|
4282
|
+
"name": "production",
|
|
4283
|
+
"attributes": [],
|
|
4284
|
+
"description": "In production, all external services are live and will generate real transactions"
|
|
4285
|
+
}, {
|
|
4286
|
+
"name": "qa",
|
|
4287
|
+
"attributes": [],
|
|
4288
|
+
"description": "The enterprise QA environment"
|
|
4289
|
+
}],
|
|
4290
|
+
"attributes": [],
|
|
4291
|
+
"description": "Environment values for restrictions. Replicates io.flow.common.v0.enums.environment with an additional QA value for enterprise."
|
|
4291
4292
|
}, {
|
|
4292
4293
|
"name": "return_item_status",
|
|
4293
4294
|
"plural": "return_item_statuses",
|
|
@@ -4572,6 +4573,56 @@
|
|
|
4572
4573
|
"description": "commit this request to be associated to the corresponding product_id."
|
|
4573
4574
|
}],
|
|
4574
4575
|
"attributes": []
|
|
4576
|
+
}, {
|
|
4577
|
+
"name": "sellability_result_error_code",
|
|
4578
|
+
"plural": "sellability_result_error_codes",
|
|
4579
|
+
"values": [{
|
|
4580
|
+
"name": "insufficient_details",
|
|
4581
|
+
"attributes": [],
|
|
4582
|
+
"description": "The request failed for insufficient details"
|
|
4583
|
+
}, {
|
|
4584
|
+
"name": "generic_error",
|
|
4585
|
+
"attributes": [],
|
|
4586
|
+
"description": "The request failed for a generic error"
|
|
4587
|
+
}],
|
|
4588
|
+
"attributes": [],
|
|
4589
|
+
"description": "The error code for a failed sellability screening result."
|
|
4590
|
+
}, {
|
|
4591
|
+
"name": "sellability_result_status",
|
|
4592
|
+
"plural": "sellability_result_statuses",
|
|
4593
|
+
"values": [{
|
|
4594
|
+
"name": "in_review",
|
|
4595
|
+
"attributes": [],
|
|
4596
|
+
"description": "The request is in review"
|
|
4597
|
+
}, {
|
|
4598
|
+
"name": "succeeded",
|
|
4599
|
+
"attributes": [],
|
|
4600
|
+
"description": "The request has succeeded"
|
|
4601
|
+
}, {
|
|
4602
|
+
"name": "failed",
|
|
4603
|
+
"attributes": [],
|
|
4604
|
+
"description": "The request has failed"
|
|
4605
|
+
}],
|
|
4606
|
+
"attributes": [],
|
|
4607
|
+
"description": "The status of a sellability screening result."
|
|
4608
|
+
}, {
|
|
4609
|
+
"name": "sellability_screening_mode",
|
|
4610
|
+
"plural": "sellability_screening_modes",
|
|
4611
|
+
"values": [{
|
|
4612
|
+
"name": "pre_onboarding",
|
|
4613
|
+
"attributes": [],
|
|
4614
|
+
"description": "Pre-onboarding sellability screening."
|
|
4615
|
+
}, {
|
|
4616
|
+
"name": "default_on",
|
|
4617
|
+
"attributes": [],
|
|
4618
|
+
"description": "Default-on sellability screening."
|
|
4619
|
+
}, {
|
|
4620
|
+
"name": "active",
|
|
4621
|
+
"attributes": [],
|
|
4622
|
+
"description": "Active sellability screening."
|
|
4623
|
+
}],
|
|
4624
|
+
"attributes": [],
|
|
4625
|
+
"description": "Determines the type of sellability screening to perform."
|
|
4575
4626
|
}, {
|
|
4576
4627
|
"name": "shipment_integration_type",
|
|
4577
4628
|
"plural": "shipment_integration_types",
|
|
@@ -4727,6 +4778,23 @@
|
|
|
4727
4778
|
"values": [{
|
|
4728
4779
|
"name": "csv",
|
|
4729
4780
|
"attributes": []
|
|
4781
|
+
}, {
|
|
4782
|
+
"name": "pdf",
|
|
4783
|
+
"attributes": []
|
|
4784
|
+
}],
|
|
4785
|
+
"attributes": []
|
|
4786
|
+
}, {
|
|
4787
|
+
"name": "statement_status_code",
|
|
4788
|
+
"plural": "statement_status_codes",
|
|
4789
|
+
"values": [{
|
|
4790
|
+
"name": "scheduled",
|
|
4791
|
+
"attributes": []
|
|
4792
|
+
}, {
|
|
4793
|
+
"name": "sent",
|
|
4794
|
+
"attributes": []
|
|
4795
|
+
}, {
|
|
4796
|
+
"name": "failed",
|
|
4797
|
+
"attributes": []
|
|
4730
4798
|
}],
|
|
4731
4799
|
"attributes": []
|
|
4732
4800
|
}, {
|
|
@@ -5041,6 +5109,9 @@
|
|
|
5041
5109
|
}, {
|
|
5042
5110
|
"name": "lvg_refund",
|
|
5043
5111
|
"attributes": []
|
|
5112
|
+
}, {
|
|
5113
|
+
"name": "us_inbound_tax_refund",
|
|
5114
|
+
"attributes": []
|
|
5044
5115
|
}, {
|
|
5045
5116
|
"name": "order_cancellation_above_de_min",
|
|
5046
5117
|
"attributes": []
|
|
@@ -5423,6 +5494,12 @@
|
|
|
5423
5494
|
}, {
|
|
5424
5495
|
"name": "merchant_fee",
|
|
5425
5496
|
"attributes": []
|
|
5497
|
+
}, {
|
|
5498
|
+
"name": "b2b_tax",
|
|
5499
|
+
"attributes": []
|
|
5500
|
+
}, {
|
|
5501
|
+
"name": "b2b_tax_refund",
|
|
5502
|
+
"attributes": []
|
|
5426
5503
|
}],
|
|
5427
5504
|
"attributes": []
|
|
5428
5505
|
}, {
|
|
@@ -5485,6 +5562,9 @@
|
|
|
5485
5562
|
}, {
|
|
5486
5563
|
"name": "ups",
|
|
5487
5564
|
"attributes": []
|
|
5565
|
+
}, {
|
|
5566
|
+
"name": "fedex",
|
|
5567
|
+
"attributes": []
|
|
5488
5568
|
}],
|
|
5489
5569
|
"attributes": []
|
|
5490
5570
|
}, {
|
|
@@ -6423,7 +6503,7 @@
|
|
|
6423
6503
|
"annotations": []
|
|
6424
6504
|
}, {
|
|
6425
6505
|
"name": "environment",
|
|
6426
|
-
"type": "
|
|
6506
|
+
"type": "restriction_environment",
|
|
6427
6507
|
"required": true,
|
|
6428
6508
|
"attributes": [],
|
|
6429
6509
|
"annotations": []
|
|
@@ -6893,7 +6973,7 @@
|
|
|
6893
6973
|
"description": "The low-fi HS6 code for the product to be used pending full classification and a higher fidelity (HS10) code."
|
|
6894
6974
|
}, {
|
|
6895
6975
|
"name": "restricted_regions",
|
|
6896
|
-
"type": "[
|
|
6976
|
+
"type": "[sellability_region_result]",
|
|
6897
6977
|
"required": true,
|
|
6898
6978
|
"attributes": [],
|
|
6899
6979
|
"annotations": [],
|
|
@@ -7391,6 +7471,11 @@
|
|
|
7391
7471
|
"attributes": [],
|
|
7392
7472
|
"default": false,
|
|
7393
7473
|
"discriminator_value": "ita"
|
|
7474
|
+
}, {
|
|
7475
|
+
"type": "bank_account_info_kor",
|
|
7476
|
+
"attributes": [],
|
|
7477
|
+
"default": false,
|
|
7478
|
+
"discriminator_value": "kor"
|
|
7394
7479
|
}],
|
|
7395
7480
|
"attributes": [],
|
|
7396
7481
|
"interfaces": [],
|
|
@@ -7653,62 +7738,6 @@
|
|
|
7653
7738
|
"type": "generate_load",
|
|
7654
7739
|
"attributes": [],
|
|
7655
7740
|
"discriminator_value": "generate_load"
|
|
7656
|
-
}, {
|
|
7657
|
-
"type": "sarvesh_item_upserted",
|
|
7658
|
-
"attributes": [],
|
|
7659
|
-
"discriminator_value": "sarvesh_item_upserted"
|
|
7660
|
-
}, {
|
|
7661
|
-
"type": "sarvesh_item_deleted",
|
|
7662
|
-
"attributes": [],
|
|
7663
|
-
"discriminator_value": "sarvesh_item_deleted"
|
|
7664
|
-
}, {
|
|
7665
|
-
"type": "hosein_item_upserted",
|
|
7666
|
-
"attributes": [],
|
|
7667
|
-
"discriminator_value": "hosein_item_upserted"
|
|
7668
|
-
}, {
|
|
7669
|
-
"type": "hosein_item_deleted",
|
|
7670
|
-
"attributes": [],
|
|
7671
|
-
"discriminator_value": "hosein_item_deleted"
|
|
7672
|
-
}, {
|
|
7673
|
-
"type": "niall_item_upserted",
|
|
7674
|
-
"attributes": [],
|
|
7675
|
-
"discriminator_value": "niall_item_upserted"
|
|
7676
|
-
}, {
|
|
7677
|
-
"type": "niall_item_deleted",
|
|
7678
|
-
"attributes": [],
|
|
7679
|
-
"discriminator_value": "niall_item_deleted"
|
|
7680
|
-
}, {
|
|
7681
|
-
"type": "rohan_item_upserted",
|
|
7682
|
-
"attributes": [],
|
|
7683
|
-
"discriminator_value": "rohan_item_upserted"
|
|
7684
|
-
}, {
|
|
7685
|
-
"type": "rohan_item_deleted",
|
|
7686
|
-
"attributes": [],
|
|
7687
|
-
"discriminator_value": "rohan_item_deleted"
|
|
7688
|
-
}, {
|
|
7689
|
-
"type": "aldo_item_upserted",
|
|
7690
|
-
"attributes": [],
|
|
7691
|
-
"discriminator_value": "aldo_item_upserted"
|
|
7692
|
-
}, {
|
|
7693
|
-
"type": "aldo_item_deleted",
|
|
7694
|
-
"attributes": [],
|
|
7695
|
-
"discriminator_value": "aldo_item_deleted"
|
|
7696
|
-
}, {
|
|
7697
|
-
"type": "ansh_item_upserted",
|
|
7698
|
-
"attributes": [],
|
|
7699
|
-
"discriminator_value": "ansh_item_upserted"
|
|
7700
|
-
}, {
|
|
7701
|
-
"type": "ansh_item_deleted",
|
|
7702
|
-
"attributes": [],
|
|
7703
|
-
"discriminator_value": "ansh_item_deleted"
|
|
7704
|
-
}, {
|
|
7705
|
-
"type": "anirban_item_upserted",
|
|
7706
|
-
"attributes": [],
|
|
7707
|
-
"discriminator_value": "anirban_item_upserted"
|
|
7708
|
-
}, {
|
|
7709
|
-
"type": "anirban_item_deleted",
|
|
7710
|
-
"attributes": [],
|
|
7711
|
-
"discriminator_value": "anirban_item_deleted"
|
|
7712
7741
|
}, {
|
|
7713
7742
|
"type": "transaction_upserted",
|
|
7714
7743
|
"attributes": [],
|
|
@@ -8133,6 +8162,14 @@
|
|
|
8133
8162
|
"type": "ecommerce_platform_deleted",
|
|
8134
8163
|
"attributes": [],
|
|
8135
8164
|
"discriminator_value": "ecommerce_platform_deleted"
|
|
8165
|
+
}, {
|
|
8166
|
+
"type": "tax_registration_upserted",
|
|
8167
|
+
"attributes": [],
|
|
8168
|
+
"discriminator_value": "tax_registration_upserted"
|
|
8169
|
+
}, {
|
|
8170
|
+
"type": "tax_registration_deleted",
|
|
8171
|
+
"attributes": [],
|
|
8172
|
+
"discriminator_value": "tax_registration_deleted"
|
|
8136
8173
|
}, {
|
|
8137
8174
|
"type": "organization_onboarding_state_upserted",
|
|
8138
8175
|
"attributes": [],
|
|
@@ -8322,6 +8359,14 @@
|
|
|
8322
8359
|
"type": "product_restriction_result_deleted",
|
|
8323
8360
|
"attributes": [],
|
|
8324
8361
|
"discriminator_value": "product_restriction_result_deleted"
|
|
8362
|
+
}, {
|
|
8363
|
+
"type": "product_sellability_result_upserted",
|
|
8364
|
+
"attributes": [],
|
|
8365
|
+
"discriminator_value": "product_sellability_result_upserted"
|
|
8366
|
+
}, {
|
|
8367
|
+
"type": "product_sellability_result_deleted",
|
|
8368
|
+
"attributes": [],
|
|
8369
|
+
"discriminator_value": "product_sellability_result_deleted"
|
|
8325
8370
|
}, {
|
|
8326
8371
|
"type": "shopify_localization_setting_upserted",
|
|
8327
8372
|
"attributes": [],
|
|
@@ -8334,6 +8379,10 @@
|
|
|
8334
8379
|
"type": "tracking_label_event_upserted",
|
|
8335
8380
|
"attributes": [],
|
|
8336
8381
|
"discriminator_value": "tracking_label_event_upserted"
|
|
8382
|
+
}, {
|
|
8383
|
+
"type": "tracking_label_event_upserted_v2",
|
|
8384
|
+
"attributes": [],
|
|
8385
|
+
"discriminator_value": "tracking_label_event_upserted_v2"
|
|
8337
8386
|
}],
|
|
8338
8387
|
"attributes": [{
|
|
8339
8388
|
"name": "docs",
|
|
@@ -8773,6 +8822,10 @@
|
|
|
8773
8822
|
"type": "shopify_merchant_application",
|
|
8774
8823
|
"attributes": [],
|
|
8775
8824
|
"discriminator_value": "shopify_merchant_application"
|
|
8825
|
+
}, {
|
|
8826
|
+
"type": "common_merchant_application",
|
|
8827
|
+
"attributes": [],
|
|
8828
|
+
"discriminator_value": "common_merchant_application"
|
|
8776
8829
|
}],
|
|
8777
8830
|
"attributes": [],
|
|
8778
8831
|
"interfaces": [],
|
|
@@ -8784,6 +8837,10 @@
|
|
|
8784
8837
|
"type": "shopify_merchant_application_form",
|
|
8785
8838
|
"attributes": [],
|
|
8786
8839
|
"discriminator_value": "shopify_merchant_application_form"
|
|
8840
|
+
}, {
|
|
8841
|
+
"type": "common_merchant_application_form",
|
|
8842
|
+
"attributes": [],
|
|
8843
|
+
"discriminator_value": "common_merchant_application_form"
|
|
8787
8844
|
}],
|
|
8788
8845
|
"attributes": [],
|
|
8789
8846
|
"interfaces": [],
|
|
@@ -8795,6 +8852,10 @@
|
|
|
8795
8852
|
"type": "shopify_merchant_application_put_form",
|
|
8796
8853
|
"attributes": [],
|
|
8797
8854
|
"discriminator_value": "shopify_merchant_application_put_form"
|
|
8855
|
+
}, {
|
|
8856
|
+
"type": "common_merchant_application_put_form",
|
|
8857
|
+
"attributes": [],
|
|
8858
|
+
"discriminator_value": "common_merchant_application_put_form"
|
|
8798
8859
|
}],
|
|
8799
8860
|
"attributes": [],
|
|
8800
8861
|
"interfaces": [],
|
|
@@ -8806,6 +8867,10 @@
|
|
|
8806
8867
|
"type": "shopify_merchant_applications_summary",
|
|
8807
8868
|
"attributes": [],
|
|
8808
8869
|
"discriminator_value": "shopify_merchant_applications_summary"
|
|
8870
|
+
}, {
|
|
8871
|
+
"type": "common_merchant_applications_summary",
|
|
8872
|
+
"attributes": [],
|
|
8873
|
+
"discriminator_value": "common_merchant_applications_summary"
|
|
8809
8874
|
}],
|
|
8810
8875
|
"attributes": [],
|
|
8811
8876
|
"interfaces": [],
|
|
@@ -9562,6 +9627,22 @@
|
|
|
9562
9627
|
"attributes": [],
|
|
9563
9628
|
"interfaces": [],
|
|
9564
9629
|
"discriminator": "type"
|
|
9630
|
+
}, {
|
|
9631
|
+
"name": "sellability_request",
|
|
9632
|
+
"plural": "sellability_requests",
|
|
9633
|
+
"types": [{
|
|
9634
|
+
"type": "product_sellability_form",
|
|
9635
|
+
"attributes": [],
|
|
9636
|
+
"default": true,
|
|
9637
|
+
"discriminator_value": "product_sellability_form"
|
|
9638
|
+
}, {
|
|
9639
|
+
"type": "sellability_screening_form",
|
|
9640
|
+
"attributes": [],
|
|
9641
|
+
"discriminator_value": "sellability_screening_form"
|
|
9642
|
+
}],
|
|
9643
|
+
"attributes": [],
|
|
9644
|
+
"interfaces": [],
|
|
9645
|
+
"discriminator": "discriminator"
|
|
9565
9646
|
}, {
|
|
9566
9647
|
"name": "sellability_response",
|
|
9567
9648
|
"plural": "sellability_responses",
|
|
@@ -9573,6 +9654,10 @@
|
|
|
9573
9654
|
"type": "sellability_error",
|
|
9574
9655
|
"attributes": [],
|
|
9575
9656
|
"discriminator_value": "sellability_error"
|
|
9657
|
+
}, {
|
|
9658
|
+
"type": "sellability_screening",
|
|
9659
|
+
"attributes": [],
|
|
9660
|
+
"discriminator_value": "sellability_screening"
|
|
9576
9661
|
}],
|
|
9577
9662
|
"attributes": [],
|
|
9578
9663
|
"interfaces": [],
|
|
@@ -11352,55 +11437,6 @@
|
|
|
11352
11437
|
"attributes": [],
|
|
11353
11438
|
"interfaces": [],
|
|
11354
11439
|
"description": "This will load a hidden script from the card issuer that gathers browser metrics to inform the authorization decision. Used to initiate Checkout.create using the `threeDS2DeviceFingerprint` operation."
|
|
11355
|
-
}, {
|
|
11356
|
-
"name": "aldo_item_deleted",
|
|
11357
|
-
"plural": "aldo_item_deleteds",
|
|
11358
|
-
"fields": [{
|
|
11359
|
-
"name": "event_id",
|
|
11360
|
-
"type": "string",
|
|
11361
|
-
"required": true,
|
|
11362
|
-
"attributes": [],
|
|
11363
|
-
"annotations": []
|
|
11364
|
-
}, {
|
|
11365
|
-
"name": "timestamp",
|
|
11366
|
-
"type": "date-time-iso8601",
|
|
11367
|
-
"required": true,
|
|
11368
|
-
"attributes": [],
|
|
11369
|
-
"annotations": []
|
|
11370
|
-
}, {
|
|
11371
|
-
"name": "id",
|
|
11372
|
-
"type": "string",
|
|
11373
|
-
"required": true,
|
|
11374
|
-
"attributes": [],
|
|
11375
|
-
"annotations": [],
|
|
11376
|
-
"description": "Globally unique identifier"
|
|
11377
|
-
}],
|
|
11378
|
-
"attributes": [],
|
|
11379
|
-
"interfaces": []
|
|
11380
|
-
}, {
|
|
11381
|
-
"name": "aldo_item_upserted",
|
|
11382
|
-
"plural": "aldo_item_upserteds",
|
|
11383
|
-
"fields": [{
|
|
11384
|
-
"name": "event_id",
|
|
11385
|
-
"type": "string",
|
|
11386
|
-
"required": true,
|
|
11387
|
-
"attributes": [],
|
|
11388
|
-
"annotations": []
|
|
11389
|
-
}, {
|
|
11390
|
-
"name": "timestamp",
|
|
11391
|
-
"type": "date-time-iso8601",
|
|
11392
|
-
"required": true,
|
|
11393
|
-
"attributes": [],
|
|
11394
|
-
"annotations": []
|
|
11395
|
-
}, {
|
|
11396
|
-
"name": "item",
|
|
11397
|
-
"type": "io.flow.tech.onboarding.playground.v0.models.aldo_item",
|
|
11398
|
-
"required": true,
|
|
11399
|
-
"attributes": [],
|
|
11400
|
-
"annotations": []
|
|
11401
|
-
}],
|
|
11402
|
-
"attributes": [],
|
|
11403
|
-
"interfaces": []
|
|
11404
11440
|
}, {
|
|
11405
11441
|
"name": "allocation",
|
|
11406
11442
|
"plural": "allocations",
|
|
@@ -11963,104 +11999,6 @@
|
|
|
11963
11999
|
}],
|
|
11964
12000
|
"attributes": [],
|
|
11965
12001
|
"interfaces": []
|
|
11966
|
-
}, {
|
|
11967
|
-
"name": "anirban_item_deleted",
|
|
11968
|
-
"plural": "anirban_item_deleteds",
|
|
11969
|
-
"fields": [{
|
|
11970
|
-
"name": "event_id",
|
|
11971
|
-
"type": "string",
|
|
11972
|
-
"required": true,
|
|
11973
|
-
"attributes": [],
|
|
11974
|
-
"annotations": []
|
|
11975
|
-
}, {
|
|
11976
|
-
"name": "timestamp",
|
|
11977
|
-
"type": "date-time-iso8601",
|
|
11978
|
-
"required": true,
|
|
11979
|
-
"attributes": [],
|
|
11980
|
-
"annotations": []
|
|
11981
|
-
}, {
|
|
11982
|
-
"name": "id",
|
|
11983
|
-
"type": "string",
|
|
11984
|
-
"required": true,
|
|
11985
|
-
"attributes": [],
|
|
11986
|
-
"annotations": [],
|
|
11987
|
-
"description": "Globally unique identifier"
|
|
11988
|
-
}],
|
|
11989
|
-
"attributes": [],
|
|
11990
|
-
"interfaces": []
|
|
11991
|
-
}, {
|
|
11992
|
-
"name": "anirban_item_upserted",
|
|
11993
|
-
"plural": "anirban_item_upserteds",
|
|
11994
|
-
"fields": [{
|
|
11995
|
-
"name": "event_id",
|
|
11996
|
-
"type": "string",
|
|
11997
|
-
"required": true,
|
|
11998
|
-
"attributes": [],
|
|
11999
|
-
"annotations": []
|
|
12000
|
-
}, {
|
|
12001
|
-
"name": "timestamp",
|
|
12002
|
-
"type": "date-time-iso8601",
|
|
12003
|
-
"required": true,
|
|
12004
|
-
"attributes": [],
|
|
12005
|
-
"annotations": []
|
|
12006
|
-
}, {
|
|
12007
|
-
"name": "item",
|
|
12008
|
-
"type": "io.flow.tech.onboarding.playground.v0.models.anirban_item",
|
|
12009
|
-
"required": true,
|
|
12010
|
-
"attributes": [],
|
|
12011
|
-
"annotations": []
|
|
12012
|
-
}],
|
|
12013
|
-
"attributes": [],
|
|
12014
|
-
"interfaces": []
|
|
12015
|
-
}, {
|
|
12016
|
-
"name": "ansh_item_deleted",
|
|
12017
|
-
"plural": "ansh_item_deleteds",
|
|
12018
|
-
"fields": [{
|
|
12019
|
-
"name": "event_id",
|
|
12020
|
-
"type": "string",
|
|
12021
|
-
"required": true,
|
|
12022
|
-
"attributes": [],
|
|
12023
|
-
"annotations": []
|
|
12024
|
-
}, {
|
|
12025
|
-
"name": "timestamp",
|
|
12026
|
-
"type": "date-time-iso8601",
|
|
12027
|
-
"required": true,
|
|
12028
|
-
"attributes": [],
|
|
12029
|
-
"annotations": []
|
|
12030
|
-
}, {
|
|
12031
|
-
"name": "id",
|
|
12032
|
-
"type": "string",
|
|
12033
|
-
"required": true,
|
|
12034
|
-
"attributes": [],
|
|
12035
|
-
"annotations": [],
|
|
12036
|
-
"description": "Globally unique identifier"
|
|
12037
|
-
}],
|
|
12038
|
-
"attributes": [],
|
|
12039
|
-
"interfaces": []
|
|
12040
|
-
}, {
|
|
12041
|
-
"name": "ansh_item_upserted",
|
|
12042
|
-
"plural": "ansh_item_upserteds",
|
|
12043
|
-
"fields": [{
|
|
12044
|
-
"name": "event_id",
|
|
12045
|
-
"type": "string",
|
|
12046
|
-
"required": true,
|
|
12047
|
-
"attributes": [],
|
|
12048
|
-
"annotations": []
|
|
12049
|
-
}, {
|
|
12050
|
-
"name": "timestamp",
|
|
12051
|
-
"type": "date-time-iso8601",
|
|
12052
|
-
"required": true,
|
|
12053
|
-
"attributes": [],
|
|
12054
|
-
"annotations": []
|
|
12055
|
-
}, {
|
|
12056
|
-
"name": "item",
|
|
12057
|
-
"type": "io.flow.tech.onboarding.playground.v0.models.ansh_item",
|
|
12058
|
-
"required": true,
|
|
12059
|
-
"attributes": [],
|
|
12060
|
-
"annotations": []
|
|
12061
|
-
}],
|
|
12062
|
-
"attributes": [],
|
|
12063
|
-
"interfaces": []
|
|
12064
12002
|
}, {
|
|
12065
12003
|
"name": "apple_pay_merchant_validation_payload",
|
|
12066
12004
|
"plural": "apple_pay_merchant_validation_payloads",
|
|
@@ -13264,6 +13202,13 @@
|
|
|
13264
13202
|
"attributes": [],
|
|
13265
13203
|
"annotations": [],
|
|
13266
13204
|
"description": "detailed tax breakdown for items & shipping line"
|
|
13205
|
+
}, {
|
|
13206
|
+
"name": "tax",
|
|
13207
|
+
"type": "money",
|
|
13208
|
+
"required": false,
|
|
13209
|
+
"attributes": [],
|
|
13210
|
+
"annotations": [],
|
|
13211
|
+
"description": "The total amount of tax for this invoice"
|
|
13267
13212
|
}, {
|
|
13268
13213
|
"name": "documents",
|
|
13269
13214
|
"type": "[consumer_invoice_document]",
|
|
@@ -13283,6 +13228,19 @@
|
|
|
13283
13228
|
"attributes": [],
|
|
13284
13229
|
"annotations": [],
|
|
13285
13230
|
"default": "self_bill_invoice"
|
|
13231
|
+
}, {
|
|
13232
|
+
"name": "center",
|
|
13233
|
+
"type": "consumer_invoice_center_reference",
|
|
13234
|
+
"required": false,
|
|
13235
|
+
"attributes": [],
|
|
13236
|
+
"annotations": [],
|
|
13237
|
+
"description": "The originating fulfillment center. Will be empty for digital goods."
|
|
13238
|
+
}, {
|
|
13239
|
+
"name": "order",
|
|
13240
|
+
"type": "consumer_invoice_order_summary",
|
|
13241
|
+
"required": false,
|
|
13242
|
+
"attributes": [],
|
|
13243
|
+
"annotations": []
|
|
13286
13244
|
}],
|
|
13287
13245
|
"attributes": [],
|
|
13288
13246
|
"interfaces": [],
|
|
@@ -13668,6 +13626,61 @@
|
|
|
13668
13626
|
}],
|
|
13669
13627
|
"attributes": [],
|
|
13670
13628
|
"interfaces": ["bank_account_iban"]
|
|
13629
|
+
}, {
|
|
13630
|
+
"name": "bank_account_info_kor",
|
|
13631
|
+
"plural": "bank_account_info_kors",
|
|
13632
|
+
"fields": [{
|
|
13633
|
+
"name": "name",
|
|
13634
|
+
"type": "string",
|
|
13635
|
+
"required": false,
|
|
13636
|
+
"attributes": [],
|
|
13637
|
+
"annotations": ["personal_data"]
|
|
13638
|
+
}, {
|
|
13639
|
+
"name": "address",
|
|
13640
|
+
"type": "address",
|
|
13641
|
+
"required": false,
|
|
13642
|
+
"attributes": [],
|
|
13643
|
+
"annotations": ["personal_data"]
|
|
13644
|
+
}, {
|
|
13645
|
+
"name": "phone",
|
|
13646
|
+
"type": "string",
|
|
13647
|
+
"required": false,
|
|
13648
|
+
"attributes": [],
|
|
13649
|
+
"annotations": ["personal_data"]
|
|
13650
|
+
}, {
|
|
13651
|
+
"name": "email",
|
|
13652
|
+
"type": "string",
|
|
13653
|
+
"required": false,
|
|
13654
|
+
"attributes": [],
|
|
13655
|
+
"annotations": ["personal_data"]
|
|
13656
|
+
}, {
|
|
13657
|
+
"name": "bank_account_number",
|
|
13658
|
+
"type": "string",
|
|
13659
|
+
"required": true,
|
|
13660
|
+
"attributes": [],
|
|
13661
|
+
"annotations": ["personal_data"]
|
|
13662
|
+
}, {
|
|
13663
|
+
"name": "bank_routing_number",
|
|
13664
|
+
"type": "string",
|
|
13665
|
+
"required": false,
|
|
13666
|
+
"attributes": [],
|
|
13667
|
+
"annotations": [],
|
|
13668
|
+
"description": "SWIFT code or bank code"
|
|
13669
|
+
}, {
|
|
13670
|
+
"name": "bank_name",
|
|
13671
|
+
"type": "string",
|
|
13672
|
+
"required": false,
|
|
13673
|
+
"attributes": [],
|
|
13674
|
+
"annotations": []
|
|
13675
|
+
}, {
|
|
13676
|
+
"name": "bank_address",
|
|
13677
|
+
"type": "address",
|
|
13678
|
+
"required": false,
|
|
13679
|
+
"attributes": [],
|
|
13680
|
+
"annotations": []
|
|
13681
|
+
}],
|
|
13682
|
+
"attributes": [],
|
|
13683
|
+
"interfaces": []
|
|
13671
13684
|
}, {
|
|
13672
13685
|
"name": "bank_account_info_usa",
|
|
13673
13686
|
"plural": "bank_account_info_usas",
|
|
@@ -16900,6 +16913,12 @@
|
|
|
16900
16913
|
"required": false,
|
|
16901
16914
|
"attributes": [],
|
|
16902
16915
|
"annotations": []
|
|
16916
|
+
}, {
|
|
16917
|
+
"name": "external_order_summary",
|
|
16918
|
+
"type": "external_order_summary",
|
|
16919
|
+
"required": false,
|
|
16920
|
+
"attributes": [],
|
|
16921
|
+
"annotations": []
|
|
16903
16922
|
}],
|
|
16904
16923
|
"attributes": [],
|
|
16905
16924
|
"interfaces": []
|
|
@@ -17904,6 +17923,383 @@
|
|
|
17904
17923
|
}],
|
|
17905
17924
|
"attributes": [],
|
|
17906
17925
|
"interfaces": []
|
|
17926
|
+
}, {
|
|
17927
|
+
"name": "common_merchant_application",
|
|
17928
|
+
"plural": "common_merchant_applications",
|
|
17929
|
+
"fields": [{
|
|
17930
|
+
"name": "id",
|
|
17931
|
+
"type": "string",
|
|
17932
|
+
"required": true,
|
|
17933
|
+
"attributes": [],
|
|
17934
|
+
"annotations": [],
|
|
17935
|
+
"description": "Globally unique identifier"
|
|
17936
|
+
}, {
|
|
17937
|
+
"name": "organization_id",
|
|
17938
|
+
"type": "string",
|
|
17939
|
+
"required": true,
|
|
17940
|
+
"attributes": [],
|
|
17941
|
+
"annotations": []
|
|
17942
|
+
}, {
|
|
17943
|
+
"name": "organization_reference",
|
|
17944
|
+
"type": "onboarding_organization_reference",
|
|
17945
|
+
"required": true,
|
|
17946
|
+
"attributes": [],
|
|
17947
|
+
"annotations": []
|
|
17948
|
+
}, {
|
|
17949
|
+
"name": "status",
|
|
17950
|
+
"type": "onboarding_application_status",
|
|
17951
|
+
"required": true,
|
|
17952
|
+
"attributes": [],
|
|
17953
|
+
"annotations": []
|
|
17954
|
+
}, {
|
|
17955
|
+
"name": "company",
|
|
17956
|
+
"type": "merchant_info",
|
|
17957
|
+
"required": false,
|
|
17958
|
+
"attributes": [],
|
|
17959
|
+
"annotations": [],
|
|
17960
|
+
"description": "Legal Company Name (DBA), Incorporation Country, and State/Province/Jurisdiction"
|
|
17961
|
+
}, {
|
|
17962
|
+
"name": "indirect_tax",
|
|
17963
|
+
"type": "indirect_tax",
|
|
17964
|
+
"required": false,
|
|
17965
|
+
"attributes": [],
|
|
17966
|
+
"annotations": [],
|
|
17967
|
+
"description": "Indirect Tax Information"
|
|
17968
|
+
}, {
|
|
17969
|
+
"name": "ultimate_beneficiary_owner",
|
|
17970
|
+
"type": "ultimate_beneficiary_owner",
|
|
17971
|
+
"required": false,
|
|
17972
|
+
"attributes": [],
|
|
17973
|
+
"annotations": [],
|
|
17974
|
+
"description": "Ultimate Beneficiary Owner (UBO) info, or CEO's info if no UBO exists"
|
|
17975
|
+
}, {
|
|
17976
|
+
"name": "business_url",
|
|
17977
|
+
"type": "string",
|
|
17978
|
+
"required": false,
|
|
17979
|
+
"attributes": [],
|
|
17980
|
+
"annotations": []
|
|
17981
|
+
}, {
|
|
17982
|
+
"name": "business_description",
|
|
17983
|
+
"type": "string",
|
|
17984
|
+
"required": false,
|
|
17985
|
+
"attributes": [],
|
|
17986
|
+
"annotations": []
|
|
17987
|
+
}, {
|
|
17988
|
+
"name": "business_address",
|
|
17989
|
+
"type": "address",
|
|
17990
|
+
"required": false,
|
|
17991
|
+
"attributes": [],
|
|
17992
|
+
"annotations": []
|
|
17993
|
+
}, {
|
|
17994
|
+
"name": "refund_percentage",
|
|
17995
|
+
"type": "decimal",
|
|
17996
|
+
"required": false,
|
|
17997
|
+
"attributes": [],
|
|
17998
|
+
"annotations": []
|
|
17999
|
+
}, {
|
|
18000
|
+
"name": "chargeback_percentage",
|
|
18001
|
+
"type": "decimal",
|
|
18002
|
+
"required": false,
|
|
18003
|
+
"attributes": [],
|
|
18004
|
+
"annotations": []
|
|
18005
|
+
}, {
|
|
18006
|
+
"name": "beneficiary_details",
|
|
18007
|
+
"type": "merchant_onboarding_beneficiary_details",
|
|
18008
|
+
"required": false,
|
|
18009
|
+
"attributes": [],
|
|
18010
|
+
"annotations": []
|
|
18011
|
+
}, {
|
|
18012
|
+
"name": "other_trade_sector",
|
|
18013
|
+
"type": "string",
|
|
18014
|
+
"required": false,
|
|
18015
|
+
"attributes": [],
|
|
18016
|
+
"annotations": []
|
|
18017
|
+
}, {
|
|
18018
|
+
"name": "center_contact",
|
|
18019
|
+
"type": "operations_contact",
|
|
18020
|
+
"required": false,
|
|
18021
|
+
"attributes": [],
|
|
18022
|
+
"annotations": []
|
|
18023
|
+
}, {
|
|
18024
|
+
"name": "center_address",
|
|
18025
|
+
"type": "address",
|
|
18026
|
+
"required": false,
|
|
18027
|
+
"attributes": [],
|
|
18028
|
+
"annotations": []
|
|
18029
|
+
}, {
|
|
18030
|
+
"name": "average_order_weight",
|
|
18031
|
+
"type": "decimal",
|
|
18032
|
+
"required": false,
|
|
18033
|
+
"attributes": [],
|
|
18034
|
+
"annotations": []
|
|
18035
|
+
}, {
|
|
18036
|
+
"name": "average_order_weight_unit",
|
|
18037
|
+
"type": "unit_of_measurement",
|
|
18038
|
+
"required": false,
|
|
18039
|
+
"attributes": [],
|
|
18040
|
+
"annotations": []
|
|
18041
|
+
}, {
|
|
18042
|
+
"name": "package_dimensions",
|
|
18043
|
+
"type": "[dimension]",
|
|
18044
|
+
"required": false,
|
|
18045
|
+
"attributes": [],
|
|
18046
|
+
"annotations": []
|
|
18047
|
+
}, {
|
|
18048
|
+
"name": "monthly_average",
|
|
18049
|
+
"type": "monthly_average",
|
|
18050
|
+
"required": false,
|
|
18051
|
+
"attributes": [],
|
|
18052
|
+
"annotations": [],
|
|
18053
|
+
"description": "Monthly Average Volume & Transactions (#)"
|
|
18054
|
+
}, {
|
|
18055
|
+
"name": "default_country_of_origin",
|
|
18056
|
+
"type": "string",
|
|
18057
|
+
"required": false,
|
|
18058
|
+
"attributes": [],
|
|
18059
|
+
"annotations": [],
|
|
18060
|
+
"description": "Country of Origin populated in the catalog (ISO 3166 3-character country code)"
|
|
18061
|
+
}, {
|
|
18062
|
+
"name": "rate_card",
|
|
18063
|
+
"type": "string",
|
|
18064
|
+
"required": true,
|
|
18065
|
+
"attributes": [],
|
|
18066
|
+
"annotations": []
|
|
18067
|
+
}, {
|
|
18068
|
+
"name": "shop",
|
|
18069
|
+
"type": "shop",
|
|
18070
|
+
"required": false,
|
|
18071
|
+
"attributes": [],
|
|
18072
|
+
"annotations": []
|
|
18073
|
+
}, {
|
|
18074
|
+
"name": "created_at",
|
|
18075
|
+
"type": "date-time-iso8601",
|
|
18076
|
+
"required": true,
|
|
18077
|
+
"attributes": [],
|
|
18078
|
+
"annotations": []
|
|
18079
|
+
}, {
|
|
18080
|
+
"name": "last_year_xborder_gmv",
|
|
18081
|
+
"type": "money",
|
|
18082
|
+
"required": false,
|
|
18083
|
+
"attributes": [],
|
|
18084
|
+
"annotations": [],
|
|
18085
|
+
"description": "Cross border GMV for previous year"
|
|
18086
|
+
}, {
|
|
18087
|
+
"name": "last_month_xborder_gmv",
|
|
18088
|
+
"type": "money",
|
|
18089
|
+
"required": false,
|
|
18090
|
+
"attributes": [],
|
|
18091
|
+
"annotations": [],
|
|
18092
|
+
"description": "Cross border GMV for previous month"
|
|
18093
|
+
}, {
|
|
18094
|
+
"name": "average_order_value",
|
|
18095
|
+
"type": "money",
|
|
18096
|
+
"required": false,
|
|
18097
|
+
"attributes": [],
|
|
18098
|
+
"annotations": [],
|
|
18099
|
+
"description": "Cross border average order value"
|
|
18100
|
+
}, {
|
|
18101
|
+
"name": "mcc_codes",
|
|
18102
|
+
"type": "[long]",
|
|
18103
|
+
"required": false,
|
|
18104
|
+
"attributes": [],
|
|
18105
|
+
"annotations": []
|
|
18106
|
+
}],
|
|
18107
|
+
"attributes": [],
|
|
18108
|
+
"interfaces": [],
|
|
18109
|
+
"description": "Common merchant application"
|
|
18110
|
+
}, {
|
|
18111
|
+
"name": "common_merchant_application_form",
|
|
18112
|
+
"plural": "common_merchant_application_forms",
|
|
18113
|
+
"fields": [{
|
|
18114
|
+
"name": "company",
|
|
18115
|
+
"type": "merchant_info",
|
|
18116
|
+
"required": false,
|
|
18117
|
+
"attributes": [],
|
|
18118
|
+
"annotations": [],
|
|
18119
|
+
"description": "Legal Company Name (DBA), Incorporation Country, and State/Province/Jurisdiction"
|
|
18120
|
+
}, {
|
|
18121
|
+
"name": "indirect_tax",
|
|
18122
|
+
"type": "indirect_tax",
|
|
18123
|
+
"required": false,
|
|
18124
|
+
"attributes": [],
|
|
18125
|
+
"annotations": [],
|
|
18126
|
+
"description": "Indirect Tax Information"
|
|
18127
|
+
}, {
|
|
18128
|
+
"name": "ultimate_beneficiary_owner",
|
|
18129
|
+
"type": "ultimate_beneficiary_owner",
|
|
18130
|
+
"required": false,
|
|
18131
|
+
"attributes": [],
|
|
18132
|
+
"annotations": [],
|
|
18133
|
+
"description": "Ultimate Beneficiary Owner (UBO) info, or CEO's info if no UBO exists"
|
|
18134
|
+
}, {
|
|
18135
|
+
"name": "business_url",
|
|
18136
|
+
"type": "string",
|
|
18137
|
+
"required": false,
|
|
18138
|
+
"attributes": [],
|
|
18139
|
+
"annotations": []
|
|
18140
|
+
}, {
|
|
18141
|
+
"name": "business_description",
|
|
18142
|
+
"type": "string",
|
|
18143
|
+
"required": false,
|
|
18144
|
+
"attributes": [],
|
|
18145
|
+
"annotations": []
|
|
18146
|
+
}, {
|
|
18147
|
+
"name": "business_address",
|
|
18148
|
+
"type": "address",
|
|
18149
|
+
"required": false,
|
|
18150
|
+
"attributes": [],
|
|
18151
|
+
"annotations": []
|
|
18152
|
+
}, {
|
|
18153
|
+
"name": "refund_percentage",
|
|
18154
|
+
"type": "decimal",
|
|
18155
|
+
"required": false,
|
|
18156
|
+
"attributes": [],
|
|
18157
|
+
"annotations": []
|
|
18158
|
+
}, {
|
|
18159
|
+
"name": "chargeback_percentage",
|
|
18160
|
+
"type": "decimal",
|
|
18161
|
+
"required": false,
|
|
18162
|
+
"attributes": [],
|
|
18163
|
+
"annotations": []
|
|
18164
|
+
}, {
|
|
18165
|
+
"name": "beneficiary_details",
|
|
18166
|
+
"type": "merchant_onboarding_beneficiary_details",
|
|
18167
|
+
"required": false,
|
|
18168
|
+
"attributes": [],
|
|
18169
|
+
"annotations": []
|
|
18170
|
+
}, {
|
|
18171
|
+
"name": "other_trade_sector",
|
|
18172
|
+
"type": "string",
|
|
18173
|
+
"required": false,
|
|
18174
|
+
"attributes": [],
|
|
18175
|
+
"annotations": []
|
|
18176
|
+
}, {
|
|
18177
|
+
"name": "center_contact",
|
|
18178
|
+
"type": "operations_contact",
|
|
18179
|
+
"required": false,
|
|
18180
|
+
"attributes": [],
|
|
18181
|
+
"annotations": []
|
|
18182
|
+
}, {
|
|
18183
|
+
"name": "center_address",
|
|
18184
|
+
"type": "address",
|
|
18185
|
+
"required": false,
|
|
18186
|
+
"attributes": [],
|
|
18187
|
+
"annotations": []
|
|
18188
|
+
}, {
|
|
18189
|
+
"name": "average_order_weight",
|
|
18190
|
+
"type": "decimal",
|
|
18191
|
+
"required": false,
|
|
18192
|
+
"attributes": [],
|
|
18193
|
+
"annotations": []
|
|
18194
|
+
}, {
|
|
18195
|
+
"name": "average_order_weight_unit",
|
|
18196
|
+
"type": "unit_of_measurement",
|
|
18197
|
+
"required": false,
|
|
18198
|
+
"attributes": [],
|
|
18199
|
+
"annotations": []
|
|
18200
|
+
}, {
|
|
18201
|
+
"name": "package_dimensions",
|
|
18202
|
+
"type": "[dimension]",
|
|
18203
|
+
"required": false,
|
|
18204
|
+
"attributes": [],
|
|
18205
|
+
"annotations": []
|
|
18206
|
+
}, {
|
|
18207
|
+
"name": "monthly_average_volume_amount",
|
|
18208
|
+
"type": "decimal",
|
|
18209
|
+
"required": false,
|
|
18210
|
+
"attributes": [],
|
|
18211
|
+
"annotations": [],
|
|
18212
|
+
"description": "Monthly average value of domestic transactions"
|
|
18213
|
+
}, {
|
|
18214
|
+
"name": "monthly_average_volume_currency",
|
|
18215
|
+
"type": "string",
|
|
18216
|
+
"required": false,
|
|
18217
|
+
"attributes": [],
|
|
18218
|
+
"annotations": [],
|
|
18219
|
+
"description": "Monthly Average Volume Currency"
|
|
18220
|
+
}, {
|
|
18221
|
+
"name": "monthly_average_number_transactions",
|
|
18222
|
+
"type": "long",
|
|
18223
|
+
"required": false,
|
|
18224
|
+
"attributes": [],
|
|
18225
|
+
"annotations": [],
|
|
18226
|
+
"description": "Monthly average count of domestic transactions"
|
|
18227
|
+
}, {
|
|
18228
|
+
"name": "default_country_of_origin",
|
|
18229
|
+
"type": "string",
|
|
18230
|
+
"required": false,
|
|
18231
|
+
"attributes": [],
|
|
18232
|
+
"annotations": [],
|
|
18233
|
+
"description": "Country of Origin populated in the catalog (ISO 3166 3-character country code)"
|
|
18234
|
+
}, {
|
|
18235
|
+
"name": "shop",
|
|
18236
|
+
"type": "shop",
|
|
18237
|
+
"required": false,
|
|
18238
|
+
"attributes": [],
|
|
18239
|
+
"annotations": []
|
|
18240
|
+
}, {
|
|
18241
|
+
"name": "rate_card",
|
|
18242
|
+
"type": "string",
|
|
18243
|
+
"required": false,
|
|
18244
|
+
"attributes": [],
|
|
18245
|
+
"annotations": []
|
|
18246
|
+
}, {
|
|
18247
|
+
"name": "last_year_xborder_gmv",
|
|
18248
|
+
"type": "money",
|
|
18249
|
+
"required": false,
|
|
18250
|
+
"attributes": [],
|
|
18251
|
+
"annotations": [],
|
|
18252
|
+
"description": "Cross border GMV for previous year"
|
|
18253
|
+
}, {
|
|
18254
|
+
"name": "last_month_xborder_gmv",
|
|
18255
|
+
"type": "money",
|
|
18256
|
+
"required": false,
|
|
18257
|
+
"attributes": [],
|
|
18258
|
+
"annotations": [],
|
|
18259
|
+
"description": "Cross border GMV for previous month"
|
|
18260
|
+
}, {
|
|
18261
|
+
"name": "average_order_value",
|
|
18262
|
+
"type": "money",
|
|
18263
|
+
"required": false,
|
|
18264
|
+
"attributes": [],
|
|
18265
|
+
"annotations": [],
|
|
18266
|
+
"description": "Cross border average order value"
|
|
18267
|
+
}, {
|
|
18268
|
+
"name": "mcc_codes",
|
|
18269
|
+
"type": "[long]",
|
|
18270
|
+
"required": false,
|
|
18271
|
+
"attributes": [],
|
|
18272
|
+
"annotations": []
|
|
18273
|
+
}],
|
|
18274
|
+
"attributes": [],
|
|
18275
|
+
"interfaces": [],
|
|
18276
|
+
"description": "Common merchant application form"
|
|
18277
|
+
}, {
|
|
18278
|
+
"name": "common_merchant_application_put_form",
|
|
18279
|
+
"plural": "common_merchant_application_put_forms",
|
|
18280
|
+
"fields": [{
|
|
18281
|
+
"name": "status",
|
|
18282
|
+
"type": "onboarding_application_status",
|
|
18283
|
+
"required": false,
|
|
18284
|
+
"attributes": [],
|
|
18285
|
+
"annotations": []
|
|
18286
|
+
}],
|
|
18287
|
+
"attributes": [],
|
|
18288
|
+
"interfaces": [],
|
|
18289
|
+
"description": "Common merchant application put form"
|
|
18290
|
+
}, {
|
|
18291
|
+
"name": "common_merchant_applications_summary",
|
|
18292
|
+
"plural": "common_merchant_applications_summaries",
|
|
18293
|
+
"fields": [{
|
|
18294
|
+
"name": "total",
|
|
18295
|
+
"type": "long",
|
|
18296
|
+
"required": true,
|
|
18297
|
+
"attributes": [],
|
|
18298
|
+
"annotations": []
|
|
18299
|
+
}],
|
|
18300
|
+
"attributes": [],
|
|
18301
|
+
"interfaces": [],
|
|
18302
|
+
"description": "Common merchant applications summary"
|
|
17907
18303
|
}, {
|
|
17908
18304
|
"name": "company",
|
|
17909
18305
|
"plural": "companies",
|
|
@@ -18923,6 +19319,19 @@
|
|
|
18923
19319
|
"required": false,
|
|
18924
19320
|
"attributes": [],
|
|
18925
19321
|
"annotations": []
|
|
19322
|
+
}, {
|
|
19323
|
+
"name": "center",
|
|
19324
|
+
"type": "consumer_invoice_center_reference",
|
|
19325
|
+
"required": false,
|
|
19326
|
+
"attributes": [],
|
|
19327
|
+
"annotations": [],
|
|
19328
|
+
"description": "The originating fulfillment center. Will be empty for digital goods."
|
|
19329
|
+
}, {
|
|
19330
|
+
"name": "order",
|
|
19331
|
+
"type": "consumer_invoice_order_summary",
|
|
19332
|
+
"required": false,
|
|
19333
|
+
"attributes": [],
|
|
19334
|
+
"annotations": []
|
|
18926
19335
|
}],
|
|
18927
19336
|
"attributes": [],
|
|
18928
19337
|
"interfaces": [],
|
|
@@ -22407,7 +22816,17 @@
|
|
|
22407
22816
|
"type": "ratecard_region_reference",
|
|
22408
22817
|
"required": false,
|
|
22409
22818
|
"attributes": [],
|
|
22410
|
-
"annotations": []
|
|
22819
|
+
"annotations": [],
|
|
22820
|
+
"deprecation": {
|
|
22821
|
+
"description": "Use destination_regions instead."
|
|
22822
|
+
}
|
|
22823
|
+
}, {
|
|
22824
|
+
"name": "destination_regions",
|
|
22825
|
+
"type": "[ratecard_region_reference]",
|
|
22826
|
+
"required": false,
|
|
22827
|
+
"attributes": [],
|
|
22828
|
+
"annotations": [],
|
|
22829
|
+
"description": "List of regions to which this fee applies. Replaces destination_region."
|
|
22411
22830
|
}, {
|
|
22412
22831
|
"name": "interval_unit",
|
|
22413
22832
|
"type": "unit_of_measurement",
|
|
@@ -23886,6 +24305,25 @@
|
|
|
23886
24305
|
"attributes": [],
|
|
23887
24306
|
"interfaces": [],
|
|
23888
24307
|
"description": "Card external details. (processed through an external PSP)"
|
|
24308
|
+
}, {
|
|
24309
|
+
"name": "external_order_summary",
|
|
24310
|
+
"plural": "external_order_summaries",
|
|
24311
|
+
"fields": [{
|
|
24312
|
+
"name": "id",
|
|
24313
|
+
"type": "string",
|
|
24314
|
+
"required": true,
|
|
24315
|
+
"attributes": [],
|
|
24316
|
+
"annotations": [],
|
|
24317
|
+
"description": "Globally unique identifier"
|
|
24318
|
+
}, {
|
|
24319
|
+
"name": "edit_ids",
|
|
24320
|
+
"type": "[string]",
|
|
24321
|
+
"required": true,
|
|
24322
|
+
"attributes": [],
|
|
24323
|
+
"annotations": []
|
|
24324
|
+
}],
|
|
24325
|
+
"attributes": [],
|
|
24326
|
+
"interfaces": []
|
|
23889
24327
|
}, {
|
|
23890
24328
|
"name": "fee_deduction",
|
|
23891
24329
|
"plural": "fee_deductions",
|
|
@@ -25081,7 +25519,7 @@
|
|
|
25081
25519
|
"annotations": []
|
|
25082
25520
|
}, {
|
|
25083
25521
|
"name": "environment",
|
|
25084
|
-
"type": "
|
|
25522
|
+
"type": "restriction_environment",
|
|
25085
25523
|
"required": true,
|
|
25086
25524
|
"attributes": [],
|
|
25087
25525
|
"annotations": []
|
|
@@ -25381,7 +25819,7 @@
|
|
|
25381
25819
|
"annotations": []
|
|
25382
25820
|
}, {
|
|
25383
25821
|
"name": "environment",
|
|
25384
|
-
"type": "
|
|
25822
|
+
"type": "restriction_environment",
|
|
25385
25823
|
"required": true,
|
|
25386
25824
|
"attributes": [],
|
|
25387
25825
|
"annotations": []
|
|
@@ -25432,7 +25870,7 @@
|
|
|
25432
25870
|
"annotations": []
|
|
25433
25871
|
}, {
|
|
25434
25872
|
"name": "environment",
|
|
25435
|
-
"type": "
|
|
25873
|
+
"type": "restriction_environment",
|
|
25436
25874
|
"required": true,
|
|
25437
25875
|
"attributes": [],
|
|
25438
25876
|
"annotations": []
|
|
@@ -26350,55 +26788,6 @@
|
|
|
26350
26788
|
}],
|
|
26351
26789
|
"attributes": [],
|
|
26352
26790
|
"interfaces": []
|
|
26353
|
-
}, {
|
|
26354
|
-
"name": "hosein_item_deleted",
|
|
26355
|
-
"plural": "hosein_item_deleteds",
|
|
26356
|
-
"fields": [{
|
|
26357
|
-
"name": "event_id",
|
|
26358
|
-
"type": "string",
|
|
26359
|
-
"required": true,
|
|
26360
|
-
"attributes": [],
|
|
26361
|
-
"annotations": []
|
|
26362
|
-
}, {
|
|
26363
|
-
"name": "timestamp",
|
|
26364
|
-
"type": "date-time-iso8601",
|
|
26365
|
-
"required": true,
|
|
26366
|
-
"attributes": [],
|
|
26367
|
-
"annotations": []
|
|
26368
|
-
}, {
|
|
26369
|
-
"name": "id",
|
|
26370
|
-
"type": "string",
|
|
26371
|
-
"required": true,
|
|
26372
|
-
"attributes": [],
|
|
26373
|
-
"annotations": [],
|
|
26374
|
-
"description": "Globally unique identifier"
|
|
26375
|
-
}],
|
|
26376
|
-
"attributes": [],
|
|
26377
|
-
"interfaces": []
|
|
26378
|
-
}, {
|
|
26379
|
-
"name": "hosein_item_upserted",
|
|
26380
|
-
"plural": "hosein_item_upserteds",
|
|
26381
|
-
"fields": [{
|
|
26382
|
-
"name": "event_id",
|
|
26383
|
-
"type": "string",
|
|
26384
|
-
"required": true,
|
|
26385
|
-
"attributes": [],
|
|
26386
|
-
"annotations": []
|
|
26387
|
-
}, {
|
|
26388
|
-
"name": "timestamp",
|
|
26389
|
-
"type": "date-time-iso8601",
|
|
26390
|
-
"required": true,
|
|
26391
|
-
"attributes": [],
|
|
26392
|
-
"annotations": []
|
|
26393
|
-
}, {
|
|
26394
|
-
"name": "item",
|
|
26395
|
-
"type": "io.flow.tech.onboarding.playground.v0.models.hosein_item",
|
|
26396
|
-
"required": true,
|
|
26397
|
-
"attributes": [],
|
|
26398
|
-
"annotations": []
|
|
26399
|
-
}],
|
|
26400
|
-
"attributes": [],
|
|
26401
|
-
"interfaces": []
|
|
26402
26791
|
}, {
|
|
26403
26792
|
"name": "hs10",
|
|
26404
26793
|
"plural": "hs10",
|
|
@@ -31092,6 +31481,12 @@
|
|
|
31092
31481
|
"required": false,
|
|
31093
31482
|
"attributes": [],
|
|
31094
31483
|
"annotations": []
|
|
31484
|
+
}, {
|
|
31485
|
+
"name": "description",
|
|
31486
|
+
"type": "string",
|
|
31487
|
+
"required": false,
|
|
31488
|
+
"attributes": [],
|
|
31489
|
+
"annotations": []
|
|
31095
31490
|
}],
|
|
31096
31491
|
"attributes": [],
|
|
31097
31492
|
"interfaces": []
|
|
@@ -31289,6 +31684,20 @@
|
|
|
31289
31684
|
"annotations": [],
|
|
31290
31685
|
"description": "The country in which this registration number is defined. The ISO 3166-3 country code. Case insensitive. See https://api.flow.io/reference/countries",
|
|
31291
31686
|
"example": "CAN"
|
|
31687
|
+
}, {
|
|
31688
|
+
"name": "province_number",
|
|
31689
|
+
"type": "string",
|
|
31690
|
+
"required": false,
|
|
31691
|
+
"attributes": [],
|
|
31692
|
+
"annotations": [],
|
|
31693
|
+
"description": "An optional additional provincial tax registration number for the entity."
|
|
31694
|
+
}, {
|
|
31695
|
+
"name": "province",
|
|
31696
|
+
"type": "string",
|
|
31697
|
+
"required": false,
|
|
31698
|
+
"attributes": [],
|
|
31699
|
+
"annotations": [],
|
|
31700
|
+
"description": "The province in which the provincial registration number is defined."
|
|
31292
31701
|
}],
|
|
31293
31702
|
"attributes": [],
|
|
31294
31703
|
"interfaces": []
|
|
@@ -31374,6 +31783,62 @@
|
|
|
31374
31783
|
}],
|
|
31375
31784
|
"attributes": [],
|
|
31376
31785
|
"interfaces": []
|
|
31786
|
+
}, {
|
|
31787
|
+
"name": "merchant_onboarding_beneficiary_details",
|
|
31788
|
+
"plural": "merchant_onboarding_beneficiary_detailses",
|
|
31789
|
+
"fields": [{
|
|
31790
|
+
"name": "name",
|
|
31791
|
+
"type": "string",
|
|
31792
|
+
"required": false,
|
|
31793
|
+
"attributes": [],
|
|
31794
|
+
"annotations": ["personal_data"]
|
|
31795
|
+
}, {
|
|
31796
|
+
"name": "address",
|
|
31797
|
+
"type": "address",
|
|
31798
|
+
"required": false,
|
|
31799
|
+
"attributes": [],
|
|
31800
|
+
"annotations": ["personal_data"]
|
|
31801
|
+
}, {
|
|
31802
|
+
"name": "phone",
|
|
31803
|
+
"type": "string",
|
|
31804
|
+
"required": false,
|
|
31805
|
+
"attributes": [],
|
|
31806
|
+
"annotations": ["personal_data"]
|
|
31807
|
+
}, {
|
|
31808
|
+
"name": "email",
|
|
31809
|
+
"type": "string",
|
|
31810
|
+
"required": false,
|
|
31811
|
+
"attributes": [],
|
|
31812
|
+
"annotations": ["personal_data"]
|
|
31813
|
+
}, {
|
|
31814
|
+
"name": "bank_account_number",
|
|
31815
|
+
"type": "string",
|
|
31816
|
+
"required": false,
|
|
31817
|
+
"attributes": [],
|
|
31818
|
+
"annotations": ["personal_data"]
|
|
31819
|
+
}, {
|
|
31820
|
+
"name": "bank_routing_number",
|
|
31821
|
+
"type": "string",
|
|
31822
|
+
"required": false,
|
|
31823
|
+
"attributes": [],
|
|
31824
|
+
"annotations": [],
|
|
31825
|
+
"description": "SWIFT code or US aba routing Number"
|
|
31826
|
+
}, {
|
|
31827
|
+
"name": "bank_name",
|
|
31828
|
+
"type": "string",
|
|
31829
|
+
"required": false,
|
|
31830
|
+
"attributes": [],
|
|
31831
|
+
"annotations": []
|
|
31832
|
+
}, {
|
|
31833
|
+
"name": "bank_address",
|
|
31834
|
+
"type": "address",
|
|
31835
|
+
"required": false,
|
|
31836
|
+
"attributes": [],
|
|
31837
|
+
"annotations": []
|
|
31838
|
+
}],
|
|
31839
|
+
"attributes": [],
|
|
31840
|
+
"interfaces": [],
|
|
31841
|
+
"description": "Beneficiary details"
|
|
31377
31842
|
}, {
|
|
31378
31843
|
"name": "merchant_rejected",
|
|
31379
31844
|
"plural": "merchant_rejecteds",
|
|
@@ -31577,55 +32042,6 @@
|
|
|
31577
32042
|
}],
|
|
31578
32043
|
"attributes": [],
|
|
31579
32044
|
"interfaces": []
|
|
31580
|
-
}, {
|
|
31581
|
-
"name": "niall_item_deleted",
|
|
31582
|
-
"plural": "niall_item_deleteds",
|
|
31583
|
-
"fields": [{
|
|
31584
|
-
"name": "event_id",
|
|
31585
|
-
"type": "string",
|
|
31586
|
-
"required": true,
|
|
31587
|
-
"attributes": [],
|
|
31588
|
-
"annotations": []
|
|
31589
|
-
}, {
|
|
31590
|
-
"name": "timestamp",
|
|
31591
|
-
"type": "date-time-iso8601",
|
|
31592
|
-
"required": true,
|
|
31593
|
-
"attributes": [],
|
|
31594
|
-
"annotations": []
|
|
31595
|
-
}, {
|
|
31596
|
-
"name": "id",
|
|
31597
|
-
"type": "string",
|
|
31598
|
-
"required": true,
|
|
31599
|
-
"attributes": [],
|
|
31600
|
-
"annotations": [],
|
|
31601
|
-
"description": "Globally unique identifier"
|
|
31602
|
-
}],
|
|
31603
|
-
"attributes": [],
|
|
31604
|
-
"interfaces": []
|
|
31605
|
-
}, {
|
|
31606
|
-
"name": "niall_item_upserted",
|
|
31607
|
-
"plural": "niall_item_upserteds",
|
|
31608
|
-
"fields": [{
|
|
31609
|
-
"name": "event_id",
|
|
31610
|
-
"type": "string",
|
|
31611
|
-
"required": true,
|
|
31612
|
-
"attributes": [],
|
|
31613
|
-
"annotations": []
|
|
31614
|
-
}, {
|
|
31615
|
-
"name": "timestamp",
|
|
31616
|
-
"type": "date-time-iso8601",
|
|
31617
|
-
"required": true,
|
|
31618
|
-
"attributes": [],
|
|
31619
|
-
"annotations": []
|
|
31620
|
-
}, {
|
|
31621
|
-
"name": "item",
|
|
31622
|
-
"type": "io.flow.tech.onboarding.playground.v0.models.niall_item",
|
|
31623
|
-
"required": true,
|
|
31624
|
-
"attributes": [],
|
|
31625
|
-
"annotations": []
|
|
31626
|
-
}],
|
|
31627
|
-
"attributes": [],
|
|
31628
|
-
"interfaces": []
|
|
31629
32045
|
}, {
|
|
31630
32046
|
"name": "notification_deleted_v2",
|
|
31631
32047
|
"plural": "notification_deleted_v2s",
|
|
@@ -32378,6 +32794,13 @@
|
|
|
32378
32794
|
"attributes": [],
|
|
32379
32795
|
"annotations": [],
|
|
32380
32796
|
"description": "All rates associated to the order, unique by from/to"
|
|
32797
|
+
}, {
|
|
32798
|
+
"name": "pricing_type",
|
|
32799
|
+
"type": "pricing_type",
|
|
32800
|
+
"required": false,
|
|
32801
|
+
"attributes": [],
|
|
32802
|
+
"annotations": [],
|
|
32803
|
+
"description": "Indicates whether the order is tax and/or duties inclusive or not."
|
|
32381
32804
|
}],
|
|
32382
32805
|
"attributes": [],
|
|
32383
32806
|
"interfaces": [],
|
|
@@ -35656,6 +36079,93 @@
|
|
|
35656
36079
|
}],
|
|
35657
36080
|
"attributes": [],
|
|
35658
36081
|
"interfaces": []
|
|
36082
|
+
}, {
|
|
36083
|
+
"name": "organization_tax_registration",
|
|
36084
|
+
"plural": "organization_tax_registrations",
|
|
36085
|
+
"fields": [{
|
|
36086
|
+
"name": "id",
|
|
36087
|
+
"type": "string",
|
|
36088
|
+
"required": true,
|
|
36089
|
+
"attributes": [],
|
|
36090
|
+
"annotations": [],
|
|
36091
|
+
"description": "Flow's internal ID for this registration",
|
|
36092
|
+
"example": "otr-a1b2c3d4e5f6"
|
|
36093
|
+
}, {
|
|
36094
|
+
"name": "organization",
|
|
36095
|
+
"type": "organization_summary",
|
|
36096
|
+
"required": true,
|
|
36097
|
+
"attributes": [],
|
|
36098
|
+
"annotations": [],
|
|
36099
|
+
"description": "The Flow organization id, name and environment"
|
|
36100
|
+
}, {
|
|
36101
|
+
"name": "address",
|
|
36102
|
+
"type": "billing_address",
|
|
36103
|
+
"required": true,
|
|
36104
|
+
"attributes": [],
|
|
36105
|
+
"annotations": [],
|
|
36106
|
+
"description": "business name and address of the merchant"
|
|
36107
|
+
}, {
|
|
36108
|
+
"name": "registration",
|
|
36109
|
+
"type": "tax_registration_detail",
|
|
36110
|
+
"required": true,
|
|
36111
|
+
"attributes": [],
|
|
36112
|
+
"annotations": []
|
|
36113
|
+
}, {
|
|
36114
|
+
"name": "self_billing_agreement",
|
|
36115
|
+
"type": "self_billing_agreement",
|
|
36116
|
+
"required": true,
|
|
36117
|
+
"attributes": [],
|
|
36118
|
+
"annotations": [],
|
|
36119
|
+
"description": "Details of the self-billing agreement, if one exists"
|
|
36120
|
+
}],
|
|
36121
|
+
"attributes": [],
|
|
36122
|
+
"interfaces": [],
|
|
36123
|
+
"description": "Tax registration and self-billing agreement status."
|
|
36124
|
+
}, {
|
|
36125
|
+
"name": "organization_tax_registration_form",
|
|
36126
|
+
"plural": "organization_tax_registration_forms",
|
|
36127
|
+
"fields": [{
|
|
36128
|
+
"name": "tax_number",
|
|
36129
|
+
"type": "string",
|
|
36130
|
+
"required": true,
|
|
36131
|
+
"attributes": [],
|
|
36132
|
+
"annotations": [],
|
|
36133
|
+
"description": "The merchant's tax registration number/ID for this jurisdiction",
|
|
36134
|
+
"example": "123456789RT0001"
|
|
36135
|
+
}, {
|
|
36136
|
+
"name": "country",
|
|
36137
|
+
"type": "string",
|
|
36138
|
+
"required": true,
|
|
36139
|
+
"attributes": [],
|
|
36140
|
+
"annotations": [],
|
|
36141
|
+
"description": "ISO 3166-1 alpha-3 country code where this tax registration applies",
|
|
36142
|
+
"example": "CAN"
|
|
36143
|
+
}, {
|
|
36144
|
+
"name": "province",
|
|
36145
|
+
"type": "string",
|
|
36146
|
+
"required": false,
|
|
36147
|
+
"attributes": [],
|
|
36148
|
+
"annotations": [],
|
|
36149
|
+
"description": "Province/state/region where this tax registration applies. Required for sub-national tax jurisdictions (e.g., QC for QST). Use ISO 3166-2 subdivision code.",
|
|
36150
|
+
"example": "QC"
|
|
36151
|
+
}, {
|
|
36152
|
+
"name": "self_billing_agreement_effective_at",
|
|
36153
|
+
"type": "date-time-iso8601",
|
|
36154
|
+
"required": true,
|
|
36155
|
+
"attributes": [],
|
|
36156
|
+
"annotations": [],
|
|
36157
|
+
"description": "Timestamp of the self-billing invoice agreement signed by the merchant"
|
|
36158
|
+
}, {
|
|
36159
|
+
"name": "self_billing_agreement_expires_at",
|
|
36160
|
+
"type": "date-time-iso8601",
|
|
36161
|
+
"required": false,
|
|
36162
|
+
"attributes": [],
|
|
36163
|
+
"annotations": [],
|
|
36164
|
+
"description": "Expiration date of the self-billing agreement. If not provided, defaults to 24 months from effective_at."
|
|
36165
|
+
}],
|
|
36166
|
+
"attributes": [],
|
|
36167
|
+
"interfaces": [],
|
|
36168
|
+
"description": "Request body for submitting tax registrations when a self-billing invoice agreement is signed or updated."
|
|
35659
36169
|
}, {
|
|
35660
36170
|
"name": "organization_token",
|
|
35661
36171
|
"plural": "organization_tokens",
|
|
@@ -38879,6 +39389,13 @@
|
|
|
38879
39389
|
"attributes": [],
|
|
38880
39390
|
"annotations": [],
|
|
38881
39391
|
"description": "The result of the checks run against an order and its payment"
|
|
39392
|
+
}, {
|
|
39393
|
+
"name": "client_secret",
|
|
39394
|
+
"type": "string",
|
|
39395
|
+
"required": false,
|
|
39396
|
+
"attributes": [],
|
|
39397
|
+
"annotations": [],
|
|
39398
|
+
"description": "JWT Token for use with ge-checkout.js"
|
|
38882
39399
|
}],
|
|
38883
39400
|
"attributes": [],
|
|
38884
39401
|
"interfaces": []
|
|
@@ -41316,7 +41833,7 @@
|
|
|
41316
41833
|
"description": "The harmonization HS6 code."
|
|
41317
41834
|
}, {
|
|
41318
41835
|
"name": "restricted_regions_by_type",
|
|
41319
|
-
"type": "[
|
|
41836
|
+
"type": "[sellability_region_result]",
|
|
41320
41837
|
"required": false,
|
|
41321
41838
|
"attributes": [],
|
|
41322
41839
|
"annotations": [],
|
|
@@ -41428,7 +41945,7 @@
|
|
|
41428
41945
|
"description": "The low-fi HS6 code for the product to be used pending full classification and a higher fidelity (HS10) code."
|
|
41429
41946
|
}, {
|
|
41430
41947
|
"name": "restricted_regions",
|
|
41431
|
-
"type": "[
|
|
41948
|
+
"type": "[sellability_region_result]",
|
|
41432
41949
|
"required": true,
|
|
41433
41950
|
"attributes": [],
|
|
41434
41951
|
"annotations": [],
|
|
@@ -41499,6 +42016,125 @@
|
|
|
41499
42016
|
"attributes": [],
|
|
41500
42017
|
"interfaces": [],
|
|
41501
42018
|
"description": "information sdubmitted to the sellability service so as to make a sellability decision"
|
|
42019
|
+
}, {
|
|
42020
|
+
"name": "product_sellability_result",
|
|
42021
|
+
"plural": "product_sellability_results",
|
|
42022
|
+
"fields": [{
|
|
42023
|
+
"name": "merchant_id",
|
|
42024
|
+
"type": "string",
|
|
42025
|
+
"required": false,
|
|
42026
|
+
"attributes": [],
|
|
42027
|
+
"annotations": [],
|
|
42028
|
+
"description": "The external merchant ID."
|
|
42029
|
+
}, {
|
|
42030
|
+
"name": "product_id",
|
|
42031
|
+
"type": "string",
|
|
42032
|
+
"required": true,
|
|
42033
|
+
"attributes": [],
|
|
42034
|
+
"annotations": [],
|
|
42035
|
+
"description": "The external product ID."
|
|
42036
|
+
}, {
|
|
42037
|
+
"name": "restricted_regions",
|
|
42038
|
+
"type": "[sellability_restricted_region]",
|
|
42039
|
+
"required": true,
|
|
42040
|
+
"attributes": [],
|
|
42041
|
+
"annotations": [],
|
|
42042
|
+
"description": "List of regions where the product is restricted, grouped by type."
|
|
42043
|
+
}, {
|
|
42044
|
+
"name": "restricted_reasons",
|
|
42045
|
+
"type": "[sellability_restricted_reason]",
|
|
42046
|
+
"required": true,
|
|
42047
|
+
"attributes": [],
|
|
42048
|
+
"annotations": [],
|
|
42049
|
+
"description": "List of restriction reasons grouped by type, with the regions each reason applies to."
|
|
42050
|
+
}, {
|
|
42051
|
+
"name": "needs_action_attributes",
|
|
42052
|
+
"type": "[sellability_needs_action_attributes]",
|
|
42053
|
+
"required": false,
|
|
42054
|
+
"attributes": [],
|
|
42055
|
+
"annotations": [],
|
|
42056
|
+
"description": "List of attributes that can be actioned to potentially change restriction status."
|
|
42057
|
+
}, {
|
|
42058
|
+
"name": "request_id",
|
|
42059
|
+
"type": "string",
|
|
42060
|
+
"required": false,
|
|
42061
|
+
"attributes": [],
|
|
42062
|
+
"annotations": [],
|
|
42063
|
+
"description": "Unique identifier for sellability screening request."
|
|
42064
|
+
}, {
|
|
42065
|
+
"name": "hs6_code",
|
|
42066
|
+
"type": "string",
|
|
42067
|
+
"required": false,
|
|
42068
|
+
"attributes": [],
|
|
42069
|
+
"annotations": [],
|
|
42070
|
+
"description": "The HS6 code for the product."
|
|
42071
|
+
}],
|
|
42072
|
+
"attributes": [],
|
|
42073
|
+
"interfaces": [],
|
|
42074
|
+
"description": "The sellability screening result for the API response."
|
|
42075
|
+
}, {
|
|
42076
|
+
"name": "product_sellability_result_deleted",
|
|
42077
|
+
"plural": "product_sellability_result_deleteds",
|
|
42078
|
+
"fields": [{
|
|
42079
|
+
"name": "event_id",
|
|
42080
|
+
"type": "string",
|
|
42081
|
+
"required": true,
|
|
42082
|
+
"attributes": [],
|
|
42083
|
+
"annotations": []
|
|
42084
|
+
}, {
|
|
42085
|
+
"name": "timestamp",
|
|
42086
|
+
"type": "date-time-iso8601",
|
|
42087
|
+
"required": true,
|
|
42088
|
+
"attributes": [],
|
|
42089
|
+
"annotations": []
|
|
42090
|
+
}, {
|
|
42091
|
+
"name": "organization",
|
|
42092
|
+
"type": "string",
|
|
42093
|
+
"required": true,
|
|
42094
|
+
"attributes": [],
|
|
42095
|
+
"annotations": [],
|
|
42096
|
+
"description": "Refers to your organization's account identifier"
|
|
42097
|
+
}, {
|
|
42098
|
+
"name": "id",
|
|
42099
|
+
"type": "string",
|
|
42100
|
+
"required": true,
|
|
42101
|
+
"attributes": [],
|
|
42102
|
+
"annotations": [],
|
|
42103
|
+
"description": "Globally unique identifier"
|
|
42104
|
+
}],
|
|
42105
|
+
"attributes": [],
|
|
42106
|
+
"interfaces": []
|
|
42107
|
+
}, {
|
|
42108
|
+
"name": "product_sellability_result_upserted",
|
|
42109
|
+
"plural": "product_sellability_result_upserteds",
|
|
42110
|
+
"fields": [{
|
|
42111
|
+
"name": "event_id",
|
|
42112
|
+
"type": "string",
|
|
42113
|
+
"required": true,
|
|
42114
|
+
"attributes": [],
|
|
42115
|
+
"annotations": []
|
|
42116
|
+
}, {
|
|
42117
|
+
"name": "timestamp",
|
|
42118
|
+
"type": "date-time-iso8601",
|
|
42119
|
+
"required": true,
|
|
42120
|
+
"attributes": [],
|
|
42121
|
+
"annotations": []
|
|
42122
|
+
}, {
|
|
42123
|
+
"name": "organization",
|
|
42124
|
+
"type": "string",
|
|
42125
|
+
"required": true,
|
|
42126
|
+
"attributes": [],
|
|
42127
|
+
"annotations": [],
|
|
42128
|
+
"description": "Refers to your organization's account identifier"
|
|
42129
|
+
}, {
|
|
42130
|
+
"name": "product_sellability_result",
|
|
42131
|
+
"type": "product_sellability_result",
|
|
42132
|
+
"required": true,
|
|
42133
|
+
"attributes": [],
|
|
42134
|
+
"annotations": []
|
|
42135
|
+
}],
|
|
42136
|
+
"attributes": [],
|
|
42137
|
+
"interfaces": []
|
|
41502
42138
|
}, {
|
|
41503
42139
|
"name": "product_taxonomy_category",
|
|
41504
42140
|
"plural": "product_taxonomy_categories",
|
|
@@ -42624,6 +43260,12 @@
|
|
|
42624
43260
|
"required": false,
|
|
42625
43261
|
"attributes": [],
|
|
42626
43262
|
"annotations": []
|
|
43263
|
+
}, {
|
|
43264
|
+
"name": "commercial_invoice_mode",
|
|
43265
|
+
"type": "commercial_invoice_mode",
|
|
43266
|
+
"required": false,
|
|
43267
|
+
"attributes": [],
|
|
43268
|
+
"annotations": []
|
|
42627
43269
|
}],
|
|
42628
43270
|
"attributes": [],
|
|
42629
43271
|
"interfaces": []
|
|
@@ -45534,55 +46176,6 @@
|
|
|
45534
46176
|
}],
|
|
45535
46177
|
"attributes": [],
|
|
45536
46178
|
"interfaces": []
|
|
45537
|
-
}, {
|
|
45538
|
-
"name": "rohan_item_deleted",
|
|
45539
|
-
"plural": "rohan_item_deleteds",
|
|
45540
|
-
"fields": [{
|
|
45541
|
-
"name": "event_id",
|
|
45542
|
-
"type": "string",
|
|
45543
|
-
"required": true,
|
|
45544
|
-
"attributes": [],
|
|
45545
|
-
"annotations": []
|
|
45546
|
-
}, {
|
|
45547
|
-
"name": "timestamp",
|
|
45548
|
-
"type": "date-time-iso8601",
|
|
45549
|
-
"required": true,
|
|
45550
|
-
"attributes": [],
|
|
45551
|
-
"annotations": []
|
|
45552
|
-
}, {
|
|
45553
|
-
"name": "id",
|
|
45554
|
-
"type": "string",
|
|
45555
|
-
"required": true,
|
|
45556
|
-
"attributes": [],
|
|
45557
|
-
"annotations": [],
|
|
45558
|
-
"description": "Globally unique identifier"
|
|
45559
|
-
}],
|
|
45560
|
-
"attributes": [],
|
|
45561
|
-
"interfaces": []
|
|
45562
|
-
}, {
|
|
45563
|
-
"name": "rohan_item_upserted",
|
|
45564
|
-
"plural": "rohan_item_upserteds",
|
|
45565
|
-
"fields": [{
|
|
45566
|
-
"name": "event_id",
|
|
45567
|
-
"type": "string",
|
|
45568
|
-
"required": true,
|
|
45569
|
-
"attributes": [],
|
|
45570
|
-
"annotations": []
|
|
45571
|
-
}, {
|
|
45572
|
-
"name": "timestamp",
|
|
45573
|
-
"type": "date-time-iso8601",
|
|
45574
|
-
"required": true,
|
|
45575
|
-
"attributes": [],
|
|
45576
|
-
"annotations": []
|
|
45577
|
-
}, {
|
|
45578
|
-
"name": "item",
|
|
45579
|
-
"type": "io.flow.tech.onboarding.playground.v0.models.rohan_item",
|
|
45580
|
-
"required": true,
|
|
45581
|
-
"attributes": [],
|
|
45582
|
-
"annotations": []
|
|
45583
|
-
}],
|
|
45584
|
-
"attributes": [],
|
|
45585
|
-
"interfaces": []
|
|
45586
46179
|
}, {
|
|
45587
46180
|
"name": "romanization",
|
|
45588
46181
|
"plural": "romanizations",
|
|
@@ -45680,55 +46273,6 @@
|
|
|
45680
46273
|
}],
|
|
45681
46274
|
"attributes": [],
|
|
45682
46275
|
"interfaces": []
|
|
45683
|
-
}, {
|
|
45684
|
-
"name": "sarvesh_item_deleted",
|
|
45685
|
-
"plural": "sarvesh_item_deleteds",
|
|
45686
|
-
"fields": [{
|
|
45687
|
-
"name": "event_id",
|
|
45688
|
-
"type": "string",
|
|
45689
|
-
"required": true,
|
|
45690
|
-
"attributes": [],
|
|
45691
|
-
"annotations": []
|
|
45692
|
-
}, {
|
|
45693
|
-
"name": "timestamp",
|
|
45694
|
-
"type": "date-time-iso8601",
|
|
45695
|
-
"required": true,
|
|
45696
|
-
"attributes": [],
|
|
45697
|
-
"annotations": []
|
|
45698
|
-
}, {
|
|
45699
|
-
"name": "id",
|
|
45700
|
-
"type": "string",
|
|
45701
|
-
"required": true,
|
|
45702
|
-
"attributes": [],
|
|
45703
|
-
"annotations": [],
|
|
45704
|
-
"description": "Globally unique identifier"
|
|
45705
|
-
}],
|
|
45706
|
-
"attributes": [],
|
|
45707
|
-
"interfaces": []
|
|
45708
|
-
}, {
|
|
45709
|
-
"name": "sarvesh_item_upserted",
|
|
45710
|
-
"plural": "sarvesh_item_upserteds",
|
|
45711
|
-
"fields": [{
|
|
45712
|
-
"name": "event_id",
|
|
45713
|
-
"type": "string",
|
|
45714
|
-
"required": true,
|
|
45715
|
-
"attributes": [],
|
|
45716
|
-
"annotations": []
|
|
45717
|
-
}, {
|
|
45718
|
-
"name": "timestamp",
|
|
45719
|
-
"type": "date-time-iso8601",
|
|
45720
|
-
"required": true,
|
|
45721
|
-
"attributes": [],
|
|
45722
|
-
"annotations": []
|
|
45723
|
-
}, {
|
|
45724
|
-
"name": "item",
|
|
45725
|
-
"type": "io.flow.tech.onboarding.playground.v0.models.sarvesh_item",
|
|
45726
|
-
"required": true,
|
|
45727
|
-
"attributes": [],
|
|
45728
|
-
"annotations": []
|
|
45729
|
-
}],
|
|
45730
|
-
"attributes": [],
|
|
45731
|
-
"interfaces": []
|
|
45732
46276
|
}, {
|
|
45733
46277
|
"name": "schedule",
|
|
45734
46278
|
"plural": "schedules",
|
|
@@ -45973,6 +46517,27 @@
|
|
|
45973
46517
|
}],
|
|
45974
46518
|
"attributes": [],
|
|
45975
46519
|
"interfaces": []
|
|
46520
|
+
}, {
|
|
46521
|
+
"name": "self_billing_agreement",
|
|
46522
|
+
"plural": "self_billing_agreements",
|
|
46523
|
+
"fields": [{
|
|
46524
|
+
"name": "effective_at",
|
|
46525
|
+
"type": "date-time-iso8601",
|
|
46526
|
+
"required": true,
|
|
46527
|
+
"attributes": [],
|
|
46528
|
+
"annotations": [],
|
|
46529
|
+
"description": "Timestamp of when the self-billing invoice agreement was signed by the merchant"
|
|
46530
|
+
}, {
|
|
46531
|
+
"name": "expires_at",
|
|
46532
|
+
"type": "date-time-iso8601",
|
|
46533
|
+
"required": true,
|
|
46534
|
+
"attributes": [],
|
|
46535
|
+
"annotations": [],
|
|
46536
|
+
"description": "Expiration date of the self-billing agreement. Default is 24 months from effective_at if not specified."
|
|
46537
|
+
}],
|
|
46538
|
+
"attributes": [],
|
|
46539
|
+
"interfaces": [],
|
|
46540
|
+
"description": "Details of the self-billing invoice agreement (mandate) signed by the merchant. Required for B2B self-bill invoicing."
|
|
45976
46541
|
}, {
|
|
45977
46542
|
"name": "sellability_error",
|
|
45978
46543
|
"plural": "sellability_errors",
|
|
@@ -45998,6 +46563,255 @@
|
|
|
45998
46563
|
}],
|
|
45999
46564
|
"interfaces": [],
|
|
46000
46565
|
"description": "Returns information as to why a sellability response could not be served."
|
|
46566
|
+
}, {
|
|
46567
|
+
"name": "sellability_needs_action_attributes",
|
|
46568
|
+
"plural": "sellability_needs_action_attributes",
|
|
46569
|
+
"fields": [{
|
|
46570
|
+
"name": "reason_code",
|
|
46571
|
+
"type": "string",
|
|
46572
|
+
"required": true,
|
|
46573
|
+
"attributes": [],
|
|
46574
|
+
"annotations": [],
|
|
46575
|
+
"description": "Reason code of corresponding restriction rule"
|
|
46576
|
+
}, {
|
|
46577
|
+
"name": "category_metafield_handles",
|
|
46578
|
+
"type": "[string]",
|
|
46579
|
+
"required": true,
|
|
46580
|
+
"attributes": [],
|
|
46581
|
+
"annotations": [],
|
|
46582
|
+
"description": "List of metafield handles that can be set to influence restriction review."
|
|
46583
|
+
}, {
|
|
46584
|
+
"name": "require_msds",
|
|
46585
|
+
"type": "boolean",
|
|
46586
|
+
"required": false,
|
|
46587
|
+
"attributes": [],
|
|
46588
|
+
"annotations": [],
|
|
46589
|
+
"description": "If true, restriction can be lifted after review of MSDS doc"
|
|
46590
|
+
}],
|
|
46591
|
+
"attributes": [],
|
|
46592
|
+
"interfaces": []
|
|
46593
|
+
}, {
|
|
46594
|
+
"name": "sellability_reason_with_regions",
|
|
46595
|
+
"plural": "sellability_reason_with_regionses",
|
|
46596
|
+
"fields": [{
|
|
46597
|
+
"name": "reason",
|
|
46598
|
+
"type": "string",
|
|
46599
|
+
"required": true,
|
|
46600
|
+
"attributes": [],
|
|
46601
|
+
"annotations": [],
|
|
46602
|
+
"description": "The restriction reason or rule name."
|
|
46603
|
+
}, {
|
|
46604
|
+
"name": "regions",
|
|
46605
|
+
"type": "[string]",
|
|
46606
|
+
"required": true,
|
|
46607
|
+
"attributes": [],
|
|
46608
|
+
"annotations": [],
|
|
46609
|
+
"description": "Region codes (ISO 3166-1 alpha-3) where this reason applies."
|
|
46610
|
+
}],
|
|
46611
|
+
"attributes": [],
|
|
46612
|
+
"interfaces": [],
|
|
46613
|
+
"description": "A restriction reason and the regions it applies to."
|
|
46614
|
+
}, {
|
|
46615
|
+
"name": "sellability_region_result",
|
|
46616
|
+
"plural": "sellability_region_results",
|
|
46617
|
+
"fields": [{
|
|
46618
|
+
"name": "type",
|
|
46619
|
+
"type": "rule_effect_type",
|
|
46620
|
+
"required": true,
|
|
46621
|
+
"attributes": [],
|
|
46622
|
+
"annotations": []
|
|
46623
|
+
}, {
|
|
46624
|
+
"name": "regions",
|
|
46625
|
+
"type": "[string]",
|
|
46626
|
+
"required": true,
|
|
46627
|
+
"attributes": [],
|
|
46628
|
+
"annotations": [],
|
|
46629
|
+
"description": "The region id(s) in which a product should be restricted. List of iso_3166_3 codes of https://api.flow.io/reference/countries"
|
|
46630
|
+
}],
|
|
46631
|
+
"attributes": [],
|
|
46632
|
+
"interfaces": [],
|
|
46633
|
+
"description": "The product information we should return to client for sellability result"
|
|
46634
|
+
}, {
|
|
46635
|
+
"name": "sellability_region_with_reasons",
|
|
46636
|
+
"plural": "sellability_region_with_reasonses",
|
|
46637
|
+
"fields": [{
|
|
46638
|
+
"name": "region",
|
|
46639
|
+
"type": "string",
|
|
46640
|
+
"required": true,
|
|
46641
|
+
"attributes": [],
|
|
46642
|
+
"annotations": [],
|
|
46643
|
+
"description": "Region code (ISO 3166-1 alpha-3)."
|
|
46644
|
+
}, {
|
|
46645
|
+
"name": "reasons",
|
|
46646
|
+
"type": "[string]",
|
|
46647
|
+
"required": true,
|
|
46648
|
+
"attributes": [],
|
|
46649
|
+
"annotations": [],
|
|
46650
|
+
"description": "List of rule names causing the restriction."
|
|
46651
|
+
}],
|
|
46652
|
+
"attributes": [],
|
|
46653
|
+
"interfaces": [],
|
|
46654
|
+
"description": "A region with the reasons for its restriction."
|
|
46655
|
+
}, {
|
|
46656
|
+
"name": "sellability_restricted_reason",
|
|
46657
|
+
"plural": "sellability_restricted_reasons",
|
|
46658
|
+
"fields": [{
|
|
46659
|
+
"name": "type",
|
|
46660
|
+
"type": "rule_effect_type",
|
|
46661
|
+
"required": true,
|
|
46662
|
+
"attributes": [],
|
|
46663
|
+
"annotations": [],
|
|
46664
|
+
"description": "The type of restriction."
|
|
46665
|
+
}, {
|
|
46666
|
+
"name": "reasons_with_regions",
|
|
46667
|
+
"type": "[sellability_reason_with_regions]",
|
|
46668
|
+
"required": true,
|
|
46669
|
+
"attributes": [],
|
|
46670
|
+
"annotations": [],
|
|
46671
|
+
"description": "List of reasons with the regions they apply to."
|
|
46672
|
+
}],
|
|
46673
|
+
"attributes": [],
|
|
46674
|
+
"interfaces": [],
|
|
46675
|
+
"description": "Restriction reasons grouped by type, with the regions each reason applies to."
|
|
46676
|
+
}, {
|
|
46677
|
+
"name": "sellability_restricted_region",
|
|
46678
|
+
"plural": "sellability_restricted_regions",
|
|
46679
|
+
"fields": [{
|
|
46680
|
+
"name": "type",
|
|
46681
|
+
"type": "rule_effect_type",
|
|
46682
|
+
"required": true,
|
|
46683
|
+
"attributes": [],
|
|
46684
|
+
"annotations": [],
|
|
46685
|
+
"description": "The type of restriction."
|
|
46686
|
+
}, {
|
|
46687
|
+
"name": "regions",
|
|
46688
|
+
"type": "[string]",
|
|
46689
|
+
"required": true,
|
|
46690
|
+
"attributes": [],
|
|
46691
|
+
"annotations": [],
|
|
46692
|
+
"description": "The region id(s) in which a product should be restricted. List of iso_3166_3 codes of https://api.flow.io/reference/countries"
|
|
46693
|
+
}],
|
|
46694
|
+
"attributes": [],
|
|
46695
|
+
"interfaces": [],
|
|
46696
|
+
"description": "Regions where the product is restricted, grouped by restriction type."
|
|
46697
|
+
}, {
|
|
46698
|
+
"name": "sellability_screening",
|
|
46699
|
+
"plural": "sellability_screenings",
|
|
46700
|
+
"fields": [{
|
|
46701
|
+
"name": "product_sellability_result",
|
|
46702
|
+
"type": "product_sellability_result",
|
|
46703
|
+
"required": false,
|
|
46704
|
+
"attributes": [],
|
|
46705
|
+
"annotations": [],
|
|
46706
|
+
"description": "The sellability screening result. Present only when status is 'succeeded'."
|
|
46707
|
+
}, {
|
|
46708
|
+
"name": "request_id",
|
|
46709
|
+
"type": "string",
|
|
46710
|
+
"required": true,
|
|
46711
|
+
"attributes": [],
|
|
46712
|
+
"annotations": [],
|
|
46713
|
+
"description": "Unique identifier for sellability screening request."
|
|
46714
|
+
}, {
|
|
46715
|
+
"name": "status",
|
|
46716
|
+
"type": "sellability_result_status",
|
|
46717
|
+
"required": true,
|
|
46718
|
+
"attributes": [],
|
|
46719
|
+
"annotations": [],
|
|
46720
|
+
"description": "Current status of the screening request."
|
|
46721
|
+
}, {
|
|
46722
|
+
"name": "error_code",
|
|
46723
|
+
"type": "sellability_result_error_code",
|
|
46724
|
+
"required": false,
|
|
46725
|
+
"attributes": [],
|
|
46726
|
+
"annotations": [],
|
|
46727
|
+
"description": "Error code if the request failed."
|
|
46728
|
+
}, {
|
|
46729
|
+
"name": "error_message",
|
|
46730
|
+
"type": "string",
|
|
46731
|
+
"required": false,
|
|
46732
|
+
"attributes": [],
|
|
46733
|
+
"annotations": [],
|
|
46734
|
+
"description": "Human-readable error message if the request failed."
|
|
46735
|
+
}],
|
|
46736
|
+
"attributes": [],
|
|
46737
|
+
"interfaces": [],
|
|
46738
|
+
"description": "Result from the sellability screening API."
|
|
46739
|
+
}, {
|
|
46740
|
+
"name": "sellability_screening_form",
|
|
46741
|
+
"plural": "sellability_screening_forms",
|
|
46742
|
+
"fields": [{
|
|
46743
|
+
"name": "merchant_id",
|
|
46744
|
+
"type": "string",
|
|
46745
|
+
"required": true,
|
|
46746
|
+
"attributes": [],
|
|
46747
|
+
"annotations": [],
|
|
46748
|
+
"description": "The external merchant ID."
|
|
46749
|
+
}, {
|
|
46750
|
+
"name": "product_id",
|
|
46751
|
+
"type": "string",
|
|
46752
|
+
"required": true,
|
|
46753
|
+
"attributes": [],
|
|
46754
|
+
"annotations": [],
|
|
46755
|
+
"description": "The product ID."
|
|
46756
|
+
}, {
|
|
46757
|
+
"name": "name",
|
|
46758
|
+
"type": "string",
|
|
46759
|
+
"required": true,
|
|
46760
|
+
"attributes": [],
|
|
46761
|
+
"annotations": [],
|
|
46762
|
+
"description": "The name of the product."
|
|
46763
|
+
}, {
|
|
46764
|
+
"name": "price",
|
|
46765
|
+
"type": "money",
|
|
46766
|
+
"required": true,
|
|
46767
|
+
"attributes": [],
|
|
46768
|
+
"annotations": [],
|
|
46769
|
+
"description": "The price of the product (should be the price of the highest value variant where variants differ in price)."
|
|
46770
|
+
}, {
|
|
46771
|
+
"name": "description",
|
|
46772
|
+
"type": "string",
|
|
46773
|
+
"required": true,
|
|
46774
|
+
"attributes": [],
|
|
46775
|
+
"annotations": [],
|
|
46776
|
+
"description": "The product description."
|
|
46777
|
+
}, {
|
|
46778
|
+
"name": "taxonomy_category",
|
|
46779
|
+
"type": "product_taxonomy_category",
|
|
46780
|
+
"required": true,
|
|
46781
|
+
"attributes": [],
|
|
46782
|
+
"annotations": []
|
|
46783
|
+
}, {
|
|
46784
|
+
"name": "mode",
|
|
46785
|
+
"type": "sellability_screening_mode",
|
|
46786
|
+
"required": true,
|
|
46787
|
+
"attributes": [],
|
|
46788
|
+
"annotations": [],
|
|
46789
|
+
"description": "The sellability screening mode."
|
|
46790
|
+
}, {
|
|
46791
|
+
"name": "catalog_size",
|
|
46792
|
+
"type": "integer",
|
|
46793
|
+
"required": false,
|
|
46794
|
+
"attributes": [],
|
|
46795
|
+
"annotations": [],
|
|
46796
|
+
"description": "Total number of products in the merchant's catalog."
|
|
46797
|
+
}, {
|
|
46798
|
+
"name": "relative_ranking",
|
|
46799
|
+
"type": "decimal",
|
|
46800
|
+
"required": false,
|
|
46801
|
+
"attributes": [],
|
|
46802
|
+
"annotations": [],
|
|
46803
|
+
"description": "Product ranking by value within the catalog (sales percentage)."
|
|
46804
|
+
}, {
|
|
46805
|
+
"name": "dry_run",
|
|
46806
|
+
"type": "boolean",
|
|
46807
|
+
"required": false,
|
|
46808
|
+
"attributes": [],
|
|
46809
|
+
"annotations": [],
|
|
46810
|
+
"description": "Internal flag which is used without any db operation"
|
|
46811
|
+
}],
|
|
46812
|
+
"attributes": [],
|
|
46813
|
+
"interfaces": [],
|
|
46814
|
+
"description": "Information submitted to the sellability screening service for pre-onboarding or default-on screening."
|
|
46001
46815
|
}, {
|
|
46002
46816
|
"name": "sellablility_region_result",
|
|
46003
46817
|
"plural": "sellablility_region_results",
|
|
@@ -46017,7 +46831,10 @@
|
|
|
46017
46831
|
}],
|
|
46018
46832
|
"attributes": [],
|
|
46019
46833
|
"interfaces": [],
|
|
46020
|
-
"description": "
|
|
46834
|
+
"description": "DEPRECATED: Use sellability_region_result instead. This model exists for backwards compatibility only.",
|
|
46835
|
+
"deprecation": {
|
|
46836
|
+
"description": "Use sellability_region_result instead"
|
|
46837
|
+
}
|
|
46021
46838
|
}, {
|
|
46022
46839
|
"name": "service_reference",
|
|
46023
46840
|
"plural": "service_references",
|
|
@@ -47850,6 +48667,209 @@
|
|
|
47850
48667
|
}],
|
|
47851
48668
|
"attributes": [],
|
|
47852
48669
|
"interfaces": []
|
|
48670
|
+
}, {
|
|
48671
|
+
"name": "shipping_rate_estimate",
|
|
48672
|
+
"plural": "shipping_rate_estimates",
|
|
48673
|
+
"fields": [{
|
|
48674
|
+
"name": "origin_address",
|
|
48675
|
+
"type": "address",
|
|
48676
|
+
"required": true,
|
|
48677
|
+
"attributes": [],
|
|
48678
|
+
"annotations": ["personal_data"],
|
|
48679
|
+
"description": "Origin address used for the estimates"
|
|
48680
|
+
}, {
|
|
48681
|
+
"name": "destination_address",
|
|
48682
|
+
"type": "address",
|
|
48683
|
+
"required": true,
|
|
48684
|
+
"attributes": [],
|
|
48685
|
+
"annotations": ["personal_data", "consumer"],
|
|
48686
|
+
"description": "Destination address used for the estimates"
|
|
48687
|
+
}, {
|
|
48688
|
+
"name": "shipping_date_time",
|
|
48689
|
+
"type": "date-time-iso8601",
|
|
48690
|
+
"required": true,
|
|
48691
|
+
"attributes": [],
|
|
48692
|
+
"annotations": [],
|
|
48693
|
+
"description": "The shipping date/time used to calculate the estimates"
|
|
48694
|
+
}, {
|
|
48695
|
+
"name": "services",
|
|
48696
|
+
"type": "[string]",
|
|
48697
|
+
"required": true,
|
|
48698
|
+
"attributes": [],
|
|
48699
|
+
"annotations": [],
|
|
48700
|
+
"description": "Carrier service IDs configured for this channel. See https://api.flow.io/reference/carrier/services for details."
|
|
48701
|
+
}, {
|
|
48702
|
+
"name": "available",
|
|
48703
|
+
"type": "[shipping_rate_estimate_available]",
|
|
48704
|
+
"required": true,
|
|
48705
|
+
"attributes": [],
|
|
48706
|
+
"annotations": [],
|
|
48707
|
+
"description": "Successfully calculated shipping rate estimates"
|
|
48708
|
+
}, {
|
|
48709
|
+
"name": "unavailable",
|
|
48710
|
+
"type": "[shipping_rate_estimate_unavailable]",
|
|
48711
|
+
"required": false,
|
|
48712
|
+
"attributes": [],
|
|
48713
|
+
"annotations": [],
|
|
48714
|
+
"description": "Estimates that could not be calculated, with per-service failure reasons"
|
|
48715
|
+
}],
|
|
48716
|
+
"attributes": [],
|
|
48717
|
+
"interfaces": [],
|
|
48718
|
+
"description": "Response containing shipping rate estimate results"
|
|
48719
|
+
}, {
|
|
48720
|
+
"name": "shipping_rate_estimate_available",
|
|
48721
|
+
"plural": "shipping_rate_estimate_availables",
|
|
48722
|
+
"fields": [{
|
|
48723
|
+
"name": "service",
|
|
48724
|
+
"type": "ratecard_service_summary",
|
|
48725
|
+
"required": true,
|
|
48726
|
+
"attributes": [],
|
|
48727
|
+
"annotations": [],
|
|
48728
|
+
"description": "Carrier service"
|
|
48729
|
+
}, {
|
|
48730
|
+
"name": "delivered_duty",
|
|
48731
|
+
"type": "delivered_duty",
|
|
48732
|
+
"required": true,
|
|
48733
|
+
"attributes": [],
|
|
48734
|
+
"annotations": [],
|
|
48735
|
+
"description": "DDP or DDU"
|
|
48736
|
+
}, {
|
|
48737
|
+
"name": "shipment_window",
|
|
48738
|
+
"type": "shipment_window",
|
|
48739
|
+
"required": true,
|
|
48740
|
+
"attributes": [],
|
|
48741
|
+
"annotations": [],
|
|
48742
|
+
"description": "Represents min/max days of transit time for a shipment in this estimate"
|
|
48743
|
+
}, {
|
|
48744
|
+
"name": "total_amount",
|
|
48745
|
+
"type": "money",
|
|
48746
|
+
"required": true,
|
|
48747
|
+
"attributes": [],
|
|
48748
|
+
"annotations": [],
|
|
48749
|
+
"description": "Total shipping cost (base + fees)"
|
|
48750
|
+
}, {
|
|
48751
|
+
"name": "base_amount",
|
|
48752
|
+
"type": "money",
|
|
48753
|
+
"required": true,
|
|
48754
|
+
"attributes": [],
|
|
48755
|
+
"annotations": [],
|
|
48756
|
+
"description": "Base shipping amount before fees"
|
|
48757
|
+
}, {
|
|
48758
|
+
"name": "fees",
|
|
48759
|
+
"type": "[ratecard_fee]",
|
|
48760
|
+
"required": true,
|
|
48761
|
+
"attributes": [],
|
|
48762
|
+
"annotations": [],
|
|
48763
|
+
"description": "Itemized fees"
|
|
48764
|
+
}, {
|
|
48765
|
+
"name": "dimensional_weight",
|
|
48766
|
+
"type": "measurement",
|
|
48767
|
+
"required": false,
|
|
48768
|
+
"attributes": [],
|
|
48769
|
+
"annotations": [],
|
|
48770
|
+
"description": "Estimated dimensional weight (length x width x depth / dim factor)."
|
|
48771
|
+
}, {
|
|
48772
|
+
"name": "gravitational_weight",
|
|
48773
|
+
"type": "measurement",
|
|
48774
|
+
"required": false,
|
|
48775
|
+
"attributes": [],
|
|
48776
|
+
"annotations": [],
|
|
48777
|
+
"description": "Estimated gravitational weight (actual physical weight)."
|
|
48778
|
+
}, {
|
|
48779
|
+
"name": "weight_break",
|
|
48780
|
+
"type": "decimal",
|
|
48781
|
+
"required": false,
|
|
48782
|
+
"attributes": [],
|
|
48783
|
+
"annotations": [],
|
|
48784
|
+
"description": "Weight corresponding to the rate used to calculate the amount."
|
|
48785
|
+
}],
|
|
48786
|
+
"attributes": [],
|
|
48787
|
+
"interfaces": [],
|
|
48788
|
+
"description": "A successfully calculated shipping rate estimate"
|
|
48789
|
+
}, {
|
|
48790
|
+
"name": "shipping_rate_estimate_request",
|
|
48791
|
+
"plural": "shipping_rate_estimate_requests",
|
|
48792
|
+
"fields": [{
|
|
48793
|
+
"name": "origin_address",
|
|
48794
|
+
"type": "address",
|
|
48795
|
+
"required": true,
|
|
48796
|
+
"attributes": [],
|
|
48797
|
+
"annotations": ["personal_data"],
|
|
48798
|
+
"description": "Origin address"
|
|
48799
|
+
}, {
|
|
48800
|
+
"name": "destination_address",
|
|
48801
|
+
"type": "address",
|
|
48802
|
+
"required": true,
|
|
48803
|
+
"attributes": [],
|
|
48804
|
+
"annotations": ["personal_data", "consumer"],
|
|
48805
|
+
"description": "Destination address"
|
|
48806
|
+
}, {
|
|
48807
|
+
"name": "package_dimensions",
|
|
48808
|
+
"type": "dimension",
|
|
48809
|
+
"required": true,
|
|
48810
|
+
"attributes": [],
|
|
48811
|
+
"annotations": [],
|
|
48812
|
+
"description": "Physical dimensions and weight of the package being shipped"
|
|
48813
|
+
}, {
|
|
48814
|
+
"name": "shipping_date_time",
|
|
48815
|
+
"type": "date-time-iso8601",
|
|
48816
|
+
"required": true,
|
|
48817
|
+
"attributes": [],
|
|
48818
|
+
"annotations": [],
|
|
48819
|
+
"description": "The datetime the shipment is expected to be dispatched. Used for rate effectiveness, fee windows, and transit time calculation."
|
|
48820
|
+
}, {
|
|
48821
|
+
"name": "delivered_duty",
|
|
48822
|
+
"type": "delivered_duty",
|
|
48823
|
+
"required": false,
|
|
48824
|
+
"attributes": [],
|
|
48825
|
+
"annotations": [],
|
|
48826
|
+
"description": "DDP or DDU. If omitted, returns estimates for all available duty types."
|
|
48827
|
+
}, {
|
|
48828
|
+
"name": "duties_owed",
|
|
48829
|
+
"type": "money",
|
|
48830
|
+
"required": false,
|
|
48831
|
+
"attributes": [],
|
|
48832
|
+
"annotations": [],
|
|
48833
|
+
"description": "Duties owed, if known. Used for DTP surcharge calculation on DDP shipments."
|
|
48834
|
+
}, {
|
|
48835
|
+
"name": "taxes_owed",
|
|
48836
|
+
"type": "money",
|
|
48837
|
+
"required": false,
|
|
48838
|
+
"attributes": [],
|
|
48839
|
+
"annotations": [],
|
|
48840
|
+
"description": "Taxes owed, if known. Used for DTP surcharge calculation."
|
|
48841
|
+
}, {
|
|
48842
|
+
"name": "line_items",
|
|
48843
|
+
"type": "[line_item_form]",
|
|
48844
|
+
"required": false,
|
|
48845
|
+
"attributes": [],
|
|
48846
|
+
"annotations": [],
|
|
48847
|
+
"description": "Line items in the shipment. Used for security fee and EEI filing fee calculation."
|
|
48848
|
+
}],
|
|
48849
|
+
"attributes": [],
|
|
48850
|
+
"interfaces": [],
|
|
48851
|
+
"description": "Request for shipping rate estimates"
|
|
48852
|
+
}, {
|
|
48853
|
+
"name": "shipping_rate_estimate_unavailable",
|
|
48854
|
+
"plural": "shipping_rate_estimate_unavailables",
|
|
48855
|
+
"fields": [{
|
|
48856
|
+
"name": "service",
|
|
48857
|
+
"type": "string",
|
|
48858
|
+
"required": true,
|
|
48859
|
+
"attributes": [],
|
|
48860
|
+
"annotations": [],
|
|
48861
|
+
"description": "Carrier service ID that was requested. See https://api.flow.io/reference/carrier/services for valid values."
|
|
48862
|
+
}, {
|
|
48863
|
+
"name": "reason",
|
|
48864
|
+
"type": "string",
|
|
48865
|
+
"required": true,
|
|
48866
|
+
"attributes": [],
|
|
48867
|
+
"annotations": [],
|
|
48868
|
+
"description": "Why the estimate is unavailable"
|
|
48869
|
+
}],
|
|
48870
|
+
"attributes": [],
|
|
48871
|
+
"interfaces": [],
|
|
48872
|
+
"description": "A carrier service for which a shipping rate estimate could not be calculated, including the reason for failure"
|
|
47853
48873
|
}, {
|
|
47854
48874
|
"name": "shop",
|
|
47855
48875
|
"plural": "shops",
|
|
@@ -48839,6 +49859,12 @@
|
|
|
48839
49859
|
"required": false,
|
|
48840
49860
|
"attributes": [],
|
|
48841
49861
|
"annotations": []
|
|
49862
|
+
}, {
|
|
49863
|
+
"name": "average_order_weight_unit",
|
|
49864
|
+
"type": "unit_of_measurement",
|
|
49865
|
+
"required": false,
|
|
49866
|
+
"attributes": [],
|
|
49867
|
+
"annotations": []
|
|
48842
49868
|
}, {
|
|
48843
49869
|
"name": "package_dimensions",
|
|
48844
49870
|
"type": "[dimension]",
|
|
@@ -49038,6 +50064,12 @@
|
|
|
49038
50064
|
"required": false,
|
|
49039
50065
|
"attributes": [],
|
|
49040
50066
|
"annotations": []
|
|
50067
|
+
}, {
|
|
50068
|
+
"name": "average_order_weight_unit",
|
|
50069
|
+
"type": "unit_of_measurement",
|
|
50070
|
+
"required": false,
|
|
50071
|
+
"attributes": [],
|
|
50072
|
+
"annotations": []
|
|
49041
50073
|
}, {
|
|
49042
50074
|
"name": "package_dimensions",
|
|
49043
50075
|
"type": "[dimension]",
|
|
@@ -49689,6 +50721,24 @@
|
|
|
49689
50721
|
}],
|
|
49690
50722
|
"attributes": [],
|
|
49691
50723
|
"interfaces": []
|
|
50724
|
+
}, {
|
|
50725
|
+
"name": "statement_status_form",
|
|
50726
|
+
"plural": "statement_status_forms",
|
|
50727
|
+
"fields": [{
|
|
50728
|
+
"name": "code",
|
|
50729
|
+
"type": "statement_status_code",
|
|
50730
|
+
"required": true,
|
|
50731
|
+
"attributes": [],
|
|
50732
|
+
"annotations": []
|
|
50733
|
+
}, {
|
|
50734
|
+
"name": "failure_reason",
|
|
50735
|
+
"type": "payout_status_failure_code",
|
|
50736
|
+
"required": false,
|
|
50737
|
+
"attributes": [],
|
|
50738
|
+
"annotations": []
|
|
50739
|
+
}],
|
|
50740
|
+
"attributes": [],
|
|
50741
|
+
"interfaces": []
|
|
49692
50742
|
}, {
|
|
49693
50743
|
"name": "statement_upserted",
|
|
49694
50744
|
"plural": "statement_upserteds",
|
|
@@ -51004,6 +52054,78 @@
|
|
|
51004
52054
|
"attributes": [],
|
|
51005
52055
|
"interfaces": [],
|
|
51006
52056
|
"description": "Result of looking up a specific tax registration number. Indicates validity of a number for a specific country and (if valid) the associated person/company."
|
|
52057
|
+
}, {
|
|
52058
|
+
"name": "tax_registration_deleted",
|
|
52059
|
+
"plural": "tax_registration_deleteds",
|
|
52060
|
+
"fields": [{
|
|
52061
|
+
"name": "event_id",
|
|
52062
|
+
"type": "string",
|
|
52063
|
+
"required": true,
|
|
52064
|
+
"attributes": [],
|
|
52065
|
+
"annotations": []
|
|
52066
|
+
}, {
|
|
52067
|
+
"name": "timestamp",
|
|
52068
|
+
"type": "date-time-iso8601",
|
|
52069
|
+
"required": true,
|
|
52070
|
+
"attributes": [],
|
|
52071
|
+
"annotations": []
|
|
52072
|
+
}, {
|
|
52073
|
+
"name": "organization",
|
|
52074
|
+
"type": "string",
|
|
52075
|
+
"required": true,
|
|
52076
|
+
"attributes": [],
|
|
52077
|
+
"annotations": [],
|
|
52078
|
+
"description": "Refers to your organization's account identifier"
|
|
52079
|
+
}, {
|
|
52080
|
+
"name": "id",
|
|
52081
|
+
"type": "string",
|
|
52082
|
+
"required": true,
|
|
52083
|
+
"attributes": [],
|
|
52084
|
+
"annotations": [],
|
|
52085
|
+
"description": "Globally unique identifier"
|
|
52086
|
+
}],
|
|
52087
|
+
"attributes": [],
|
|
52088
|
+
"interfaces": [],
|
|
52089
|
+
"description": "Tax Registration deleted"
|
|
52090
|
+
}, {
|
|
52091
|
+
"name": "tax_registration_detail",
|
|
52092
|
+
"plural": "tax_registration_details",
|
|
52093
|
+
"fields": [{
|
|
52094
|
+
"name": "tax_number",
|
|
52095
|
+
"type": "string",
|
|
52096
|
+
"required": true,
|
|
52097
|
+
"attributes": [],
|
|
52098
|
+
"annotations": [],
|
|
52099
|
+
"description": "The merchant's tax registration number/ID for this jurisdiction",
|
|
52100
|
+
"example": "123456789RT0001"
|
|
52101
|
+
}, {
|
|
52102
|
+
"name": "country",
|
|
52103
|
+
"type": "string",
|
|
52104
|
+
"required": true,
|
|
52105
|
+
"attributes": [],
|
|
52106
|
+
"annotations": [],
|
|
52107
|
+
"description": "ISO 3166-1 alpha-3 country code where this tax registration applies",
|
|
52108
|
+
"example": "CAN"
|
|
52109
|
+
}, {
|
|
52110
|
+
"name": "tax_code",
|
|
52111
|
+
"type": "string",
|
|
52112
|
+
"required": true,
|
|
52113
|
+
"attributes": [],
|
|
52114
|
+
"annotations": [],
|
|
52115
|
+
"description": "Tax authority code identifying the type of tax (e.g., CA_GST, CA_QST, CA_PST_BC, GB_VAT)",
|
|
52116
|
+
"example": "CA_GST"
|
|
52117
|
+
}, {
|
|
52118
|
+
"name": "province",
|
|
52119
|
+
"type": "string",
|
|
52120
|
+
"required": false,
|
|
52121
|
+
"attributes": [],
|
|
52122
|
+
"annotations": [],
|
|
52123
|
+
"description": "Province/state/region where this tax registration applies. Required for sub-national tax jurisdictions (e.g., QC for QST). Use ISO 3166-2 subdivision code.",
|
|
52124
|
+
"example": "QC"
|
|
52125
|
+
}],
|
|
52126
|
+
"attributes": [],
|
|
52127
|
+
"interfaces": [],
|
|
52128
|
+
"description": "Represents a single tax registration for a specific jurisdiction. A single organization can have multiple registrations across different jurisdictions (e.g., CA GST + QC QST + BC PST)."
|
|
51007
52129
|
}, {
|
|
51008
52130
|
"name": "tax_registration_form",
|
|
51009
52131
|
"plural": "tax_registration_forms",
|
|
@@ -51023,6 +52145,38 @@
|
|
|
51023
52145
|
}],
|
|
51024
52146
|
"attributes": [],
|
|
51025
52147
|
"interfaces": []
|
|
52148
|
+
}, {
|
|
52149
|
+
"name": "tax_registration_upserted",
|
|
52150
|
+
"plural": "tax_registration_upserteds",
|
|
52151
|
+
"fields": [{
|
|
52152
|
+
"name": "event_id",
|
|
52153
|
+
"type": "string",
|
|
52154
|
+
"required": true,
|
|
52155
|
+
"attributes": [],
|
|
52156
|
+
"annotations": []
|
|
52157
|
+
}, {
|
|
52158
|
+
"name": "timestamp",
|
|
52159
|
+
"type": "date-time-iso8601",
|
|
52160
|
+
"required": true,
|
|
52161
|
+
"attributes": [],
|
|
52162
|
+
"annotations": []
|
|
52163
|
+
}, {
|
|
52164
|
+
"name": "organization",
|
|
52165
|
+
"type": "string",
|
|
52166
|
+
"required": true,
|
|
52167
|
+
"attributes": [],
|
|
52168
|
+
"annotations": [],
|
|
52169
|
+
"description": "Refers to your organization's account identifier"
|
|
52170
|
+
}, {
|
|
52171
|
+
"name": "tax_registration",
|
|
52172
|
+
"type": "organization_tax_registration",
|
|
52173
|
+
"required": true,
|
|
52174
|
+
"attributes": [],
|
|
52175
|
+
"annotations": []
|
|
52176
|
+
}],
|
|
52177
|
+
"attributes": [],
|
|
52178
|
+
"interfaces": [],
|
|
52179
|
+
"description": "Tax Registration updated"
|
|
51026
52180
|
}, {
|
|
51027
52181
|
"name": "tax_report",
|
|
51028
52182
|
"plural": "tax_reports",
|
|
@@ -52336,6 +53490,120 @@
|
|
|
52336
53490
|
}],
|
|
52337
53491
|
"attributes": [],
|
|
52338
53492
|
"interfaces": []
|
|
53493
|
+
}, {
|
|
53494
|
+
"name": "tracking_label_event_upserted_v2",
|
|
53495
|
+
"plural": "tracking_label_event_upserted_v2s",
|
|
53496
|
+
"fields": [{
|
|
53497
|
+
"name": "event_id",
|
|
53498
|
+
"type": "string",
|
|
53499
|
+
"required": true,
|
|
53500
|
+
"attributes": [],
|
|
53501
|
+
"annotations": []
|
|
53502
|
+
}, {
|
|
53503
|
+
"name": "timestamp",
|
|
53504
|
+
"type": "date-time-iso8601",
|
|
53505
|
+
"required": true,
|
|
53506
|
+
"attributes": [],
|
|
53507
|
+
"annotations": []
|
|
53508
|
+
}, {
|
|
53509
|
+
"name": "organization",
|
|
53510
|
+
"type": "string",
|
|
53511
|
+
"required": true,
|
|
53512
|
+
"attributes": [],
|
|
53513
|
+
"annotations": [],
|
|
53514
|
+
"description": "Refers to your organization's account identifier"
|
|
53515
|
+
}, {
|
|
53516
|
+
"name": "tracking_label_event",
|
|
53517
|
+
"type": "tracking_label_event_v2",
|
|
53518
|
+
"required": true,
|
|
53519
|
+
"attributes": [],
|
|
53520
|
+
"annotations": []
|
|
53521
|
+
}],
|
|
53522
|
+
"attributes": [],
|
|
53523
|
+
"interfaces": []
|
|
53524
|
+
}, {
|
|
53525
|
+
"name": "tracking_label_event_v2",
|
|
53526
|
+
"plural": "tracking_label_event_v2s",
|
|
53527
|
+
"fields": [{
|
|
53528
|
+
"name": "id",
|
|
53529
|
+
"type": "string",
|
|
53530
|
+
"required": true,
|
|
53531
|
+
"attributes": [],
|
|
53532
|
+
"annotations": [],
|
|
53533
|
+
"description": "Globally unique identifier"
|
|
53534
|
+
}, {
|
|
53535
|
+
"name": "carrier_id",
|
|
53536
|
+
"type": "string",
|
|
53537
|
+
"required": true,
|
|
53538
|
+
"attributes": [],
|
|
53539
|
+
"annotations": []
|
|
53540
|
+
}, {
|
|
53541
|
+
"name": "carrier_tracking_number",
|
|
53542
|
+
"type": "string",
|
|
53543
|
+
"required": true,
|
|
53544
|
+
"attributes": [],
|
|
53545
|
+
"annotations": []
|
|
53546
|
+
}, {
|
|
53547
|
+
"name": "carrier_tracking_url",
|
|
53548
|
+
"type": "string",
|
|
53549
|
+
"required": false,
|
|
53550
|
+
"attributes": [],
|
|
53551
|
+
"annotations": [],
|
|
53552
|
+
"description": "Full carrier tracking URL for this shipment"
|
|
53553
|
+
}, {
|
|
53554
|
+
"name": "label_id",
|
|
53555
|
+
"type": "string",
|
|
53556
|
+
"required": true,
|
|
53557
|
+
"attributes": [],
|
|
53558
|
+
"annotations": []
|
|
53559
|
+
}, {
|
|
53560
|
+
"name": "order_number",
|
|
53561
|
+
"type": "string",
|
|
53562
|
+
"required": false,
|
|
53563
|
+
"attributes": [],
|
|
53564
|
+
"annotations": []
|
|
53565
|
+
}, {
|
|
53566
|
+
"name": "status",
|
|
53567
|
+
"type": "tracking_status",
|
|
53568
|
+
"required": true,
|
|
53569
|
+
"attributes": [],
|
|
53570
|
+
"annotations": []
|
|
53571
|
+
}, {
|
|
53572
|
+
"name": "substatus",
|
|
53573
|
+
"type": "substatus_code",
|
|
53574
|
+
"required": false,
|
|
53575
|
+
"attributes": [],
|
|
53576
|
+
"annotations": []
|
|
53577
|
+
}, {
|
|
53578
|
+
"name": "carrier_timestamp",
|
|
53579
|
+
"type": "date-time-iso8601",
|
|
53580
|
+
"required": true,
|
|
53581
|
+
"attributes": [],
|
|
53582
|
+
"annotations": [],
|
|
53583
|
+
"description": "Actual carrier-reported timestamp for event"
|
|
53584
|
+
}, {
|
|
53585
|
+
"name": "description",
|
|
53586
|
+
"type": "string",
|
|
53587
|
+
"required": false,
|
|
53588
|
+
"attributes": [],
|
|
53589
|
+
"annotations": []
|
|
53590
|
+
}, {
|
|
53591
|
+
"name": "delivery_estimate",
|
|
53592
|
+
"type": "date-time-iso8601",
|
|
53593
|
+
"required": false,
|
|
53594
|
+
"attributes": [],
|
|
53595
|
+
"annotations": [],
|
|
53596
|
+
"description": "Carrier-provided delivery estimate when available"
|
|
53597
|
+
}, {
|
|
53598
|
+
"name": "address",
|
|
53599
|
+
"type": "address",
|
|
53600
|
+
"required": false,
|
|
53601
|
+
"attributes": [],
|
|
53602
|
+
"annotations": ["personal_data", "consumer"],
|
|
53603
|
+
"description": "Location of the label tracking event"
|
|
53604
|
+
}],
|
|
53605
|
+
"attributes": [],
|
|
53606
|
+
"interfaces": []
|
|
52339
53607
|
}, {
|
|
52340
53608
|
"name": "tracking_label_form",
|
|
52341
53609
|
"plural": "tracking_label_forms",
|
|
@@ -63019,6 +64287,85 @@
|
|
|
63019
64287
|
}],
|
|
63020
64288
|
"path": "/:organization/shipping-notifications",
|
|
63021
64289
|
"description": "Represents information about a client-facilitated shipment where the shipping label and fulfillment was not handled by Flow. For merchant-of-record and tracking purposes, clients doing their own shipping will need to notify Flow of shipped packages."
|
|
64290
|
+
}, {
|
|
64291
|
+
"type": "shipping_rate_estimate",
|
|
64292
|
+
"plural": "shipping_rate_estimates",
|
|
64293
|
+
"operations": [{
|
|
64294
|
+
"method": "POST",
|
|
64295
|
+
"path": "/channel/:channel_id/organization/:organization_id/shipping-rate-estimates",
|
|
64296
|
+
"parameters": [{
|
|
64297
|
+
"name": "channel_id",
|
|
64298
|
+
"type": "string",
|
|
64299
|
+
"location": "Path",
|
|
64300
|
+
"required": true
|
|
64301
|
+
}, {
|
|
64302
|
+
"name": "organization_id",
|
|
64303
|
+
"type": "string",
|
|
64304
|
+
"location": "Path",
|
|
64305
|
+
"required": true
|
|
64306
|
+
}],
|
|
64307
|
+
"responses": [{
|
|
64308
|
+
"code": {
|
|
64309
|
+
"integer": {
|
|
64310
|
+
"value": 200
|
|
64311
|
+
}
|
|
64312
|
+
},
|
|
64313
|
+
"type": "shipping_rate_estimate",
|
|
64314
|
+
"description": "Successful response",
|
|
64315
|
+
"attributes": []
|
|
64316
|
+
}, {
|
|
64317
|
+
"code": {
|
|
64318
|
+
"integer": {
|
|
64319
|
+
"value": 401
|
|
64320
|
+
}
|
|
64321
|
+
},
|
|
64322
|
+
"type": "unit",
|
|
64323
|
+
"description": "Authorization failed",
|
|
64324
|
+
"attributes": []
|
|
64325
|
+
}, {
|
|
64326
|
+
"code": {
|
|
64327
|
+
"integer": {
|
|
64328
|
+
"value": 403
|
|
64329
|
+
}
|
|
64330
|
+
},
|
|
64331
|
+
"type": "unit",
|
|
64332
|
+
"attributes": []
|
|
64333
|
+
}, {
|
|
64334
|
+
"code": {
|
|
64335
|
+
"integer": {
|
|
64336
|
+
"value": 422
|
|
64337
|
+
}
|
|
64338
|
+
},
|
|
64339
|
+
"type": "generic_error",
|
|
64340
|
+
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
64341
|
+
"attributes": []
|
|
64342
|
+
}, {
|
|
64343
|
+
"code": {
|
|
64344
|
+
"integer": {
|
|
64345
|
+
"value": 429
|
|
64346
|
+
}
|
|
64347
|
+
},
|
|
64348
|
+
"type": "unit",
|
|
64349
|
+
"attributes": []
|
|
64350
|
+
}],
|
|
64351
|
+
"attributes": [{
|
|
64352
|
+
"name": "non-crud",
|
|
64353
|
+
"value": {}
|
|
64354
|
+
}],
|
|
64355
|
+
"description": "Get shipping rate estimates. Channel-scoped endpoint with a clean response contract.",
|
|
64356
|
+
"body": {
|
|
64357
|
+
"type": "shipping_rate_estimate_request",
|
|
64358
|
+
"attributes": []
|
|
64359
|
+
}
|
|
64360
|
+
}],
|
|
64361
|
+
"attributes": [{
|
|
64362
|
+
"name": "docs",
|
|
64363
|
+
"value": {
|
|
64364
|
+
"module": "logistics"
|
|
64365
|
+
}
|
|
64366
|
+
}],
|
|
64367
|
+
"path": "/channel/:channel_id/organization/:organization_id/shipping-rate-estimates",
|
|
64368
|
+
"description": "Response containing shipping rate estimate results"
|
|
63022
64369
|
}, {
|
|
63023
64370
|
"type": "surcharge_setting",
|
|
63024
64371
|
"plural": "surcharge_settings",
|
|
@@ -68223,6 +69570,63 @@
|
|
|
68223
69570
|
"attributes": []
|
|
68224
69571
|
}],
|
|
68225
69572
|
"attributes": []
|
|
69573
|
+
}, {
|
|
69574
|
+
"method": "PUT",
|
|
69575
|
+
"path": "/channel/:channel/billing/statements/:id/status",
|
|
69576
|
+
"parameters": [{
|
|
69577
|
+
"name": "channel",
|
|
69578
|
+
"type": "string",
|
|
69579
|
+
"location": "Path",
|
|
69580
|
+
"required": true
|
|
69581
|
+
}, {
|
|
69582
|
+
"name": "id",
|
|
69583
|
+
"type": "string",
|
|
69584
|
+
"location": "Path",
|
|
69585
|
+
"required": true,
|
|
69586
|
+
"description": "Filter by one or more IDs of this resource"
|
|
69587
|
+
}],
|
|
69588
|
+
"responses": [{
|
|
69589
|
+
"code": {
|
|
69590
|
+
"integer": {
|
|
69591
|
+
"value": 200
|
|
69592
|
+
}
|
|
69593
|
+
},
|
|
69594
|
+
"type": "channel_statement",
|
|
69595
|
+
"description": "Successful response",
|
|
69596
|
+
"attributes": []
|
|
69597
|
+
}, {
|
|
69598
|
+
"code": {
|
|
69599
|
+
"integer": {
|
|
69600
|
+
"value": 401
|
|
69601
|
+
}
|
|
69602
|
+
},
|
|
69603
|
+
"type": "unit",
|
|
69604
|
+
"description": "Authorization failed",
|
|
69605
|
+
"attributes": []
|
|
69606
|
+
}, {
|
|
69607
|
+
"code": {
|
|
69608
|
+
"integer": {
|
|
69609
|
+
"value": 404
|
|
69610
|
+
}
|
|
69611
|
+
},
|
|
69612
|
+
"type": "unit",
|
|
69613
|
+
"description": "Resource was not found",
|
|
69614
|
+
"attributes": []
|
|
69615
|
+
}, {
|
|
69616
|
+
"code": {
|
|
69617
|
+
"integer": {
|
|
69618
|
+
"value": 422
|
|
69619
|
+
}
|
|
69620
|
+
},
|
|
69621
|
+
"type": "generic_error",
|
|
69622
|
+
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
69623
|
+
"attributes": []
|
|
69624
|
+
}],
|
|
69625
|
+
"attributes": [],
|
|
69626
|
+
"body": {
|
|
69627
|
+
"type": "statement_status_form",
|
|
69628
|
+
"attributes": []
|
|
69629
|
+
}
|
|
68226
69630
|
}],
|
|
68227
69631
|
"attributes": [{
|
|
68228
69632
|
"name": "docs",
|
|
@@ -76632,6 +78036,179 @@
|
|
|
76632
78036
|
}],
|
|
76633
78037
|
"path": "/:organization/billing/pending/payout/transactions",
|
|
76634
78038
|
"description": "A transaction that is pending payout."
|
|
78039
|
+
}, {
|
|
78040
|
+
"type": "organization_tax_registration",
|
|
78041
|
+
"plural": "organization_tax_registrations",
|
|
78042
|
+
"operations": [{
|
|
78043
|
+
"method": "GET",
|
|
78044
|
+
"path": "/organizations/:organization_id/tax/registrations",
|
|
78045
|
+
"parameters": [{
|
|
78046
|
+
"name": "organization_id",
|
|
78047
|
+
"type": "string",
|
|
78048
|
+
"location": "Path",
|
|
78049
|
+
"required": true
|
|
78050
|
+
}, {
|
|
78051
|
+
"name": "tax_code",
|
|
78052
|
+
"type": "[string]",
|
|
78053
|
+
"location": "Query",
|
|
78054
|
+
"required": false,
|
|
78055
|
+
"description": "Filter by specific tax codes (e.g., CA_GST, CA_QST)",
|
|
78056
|
+
"maximum": 100
|
|
78057
|
+
}],
|
|
78058
|
+
"responses": [{
|
|
78059
|
+
"code": {
|
|
78060
|
+
"integer": {
|
|
78061
|
+
"value": 200
|
|
78062
|
+
}
|
|
78063
|
+
},
|
|
78064
|
+
"type": "[organization_tax_registration]",
|
|
78065
|
+
"description": "Successful response",
|
|
78066
|
+
"attributes": []
|
|
78067
|
+
}, {
|
|
78068
|
+
"code": {
|
|
78069
|
+
"integer": {
|
|
78070
|
+
"value": 401
|
|
78071
|
+
}
|
|
78072
|
+
},
|
|
78073
|
+
"type": "unit",
|
|
78074
|
+
"description": "Authorization failed",
|
|
78075
|
+
"attributes": []
|
|
78076
|
+
}, {
|
|
78077
|
+
"code": {
|
|
78078
|
+
"integer": {
|
|
78079
|
+
"value": 404
|
|
78080
|
+
}
|
|
78081
|
+
},
|
|
78082
|
+
"type": "unit",
|
|
78083
|
+
"description": "Organization not found or no registrations exist",
|
|
78084
|
+
"attributes": []
|
|
78085
|
+
}],
|
|
78086
|
+
"attributes": [{
|
|
78087
|
+
"name": "linter",
|
|
78088
|
+
"value": {
|
|
78089
|
+
"ignore": ["get", "versions", "id", "limit", "offset", "sort"]
|
|
78090
|
+
}
|
|
78091
|
+
}],
|
|
78092
|
+
"description": "Retrieve all active tax registrations and self-billing agreement status for an organization."
|
|
78093
|
+
}, {
|
|
78094
|
+
"method": "PUT",
|
|
78095
|
+
"path": "/organizations/:organization_id/tax/registrations/:tax_code",
|
|
78096
|
+
"parameters": [{
|
|
78097
|
+
"name": "organization_id",
|
|
78098
|
+
"type": "string",
|
|
78099
|
+
"location": "Path",
|
|
78100
|
+
"required": true
|
|
78101
|
+
}, {
|
|
78102
|
+
"name": "tax_code",
|
|
78103
|
+
"type": "string",
|
|
78104
|
+
"location": "Path",
|
|
78105
|
+
"required": true
|
|
78106
|
+
}],
|
|
78107
|
+
"responses": [{
|
|
78108
|
+
"code": {
|
|
78109
|
+
"integer": {
|
|
78110
|
+
"value": 200
|
|
78111
|
+
}
|
|
78112
|
+
},
|
|
78113
|
+
"type": "organization_tax_registration",
|
|
78114
|
+
"description": "Registration updated successfully",
|
|
78115
|
+
"attributes": []
|
|
78116
|
+
}, {
|
|
78117
|
+
"code": {
|
|
78118
|
+
"integer": {
|
|
78119
|
+
"value": 201
|
|
78120
|
+
}
|
|
78121
|
+
},
|
|
78122
|
+
"type": "organization_tax_registration",
|
|
78123
|
+
"description": "Registration created successfully",
|
|
78124
|
+
"attributes": []
|
|
78125
|
+
}, {
|
|
78126
|
+
"code": {
|
|
78127
|
+
"integer": {
|
|
78128
|
+
"value": 401
|
|
78129
|
+
}
|
|
78130
|
+
},
|
|
78131
|
+
"type": "unit",
|
|
78132
|
+
"description": "Authorization failed",
|
|
78133
|
+
"attributes": []
|
|
78134
|
+
}, {
|
|
78135
|
+
"code": {
|
|
78136
|
+
"integer": {
|
|
78137
|
+
"value": 404
|
|
78138
|
+
}
|
|
78139
|
+
},
|
|
78140
|
+
"type": "unit",
|
|
78141
|
+
"description": "Resource was not found",
|
|
78142
|
+
"attributes": []
|
|
78143
|
+
}, {
|
|
78144
|
+
"code": {
|
|
78145
|
+
"integer": {
|
|
78146
|
+
"value": 422
|
|
78147
|
+
}
|
|
78148
|
+
},
|
|
78149
|
+
"type": "generic_error",
|
|
78150
|
+
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
78151
|
+
"attributes": []
|
|
78152
|
+
}],
|
|
78153
|
+
"attributes": [],
|
|
78154
|
+
"description": "Create or update a tax registration and self-billing agreement for an organization. Called when a merchant signs or renews a self-billing invoice agreement.",
|
|
78155
|
+
"body": {
|
|
78156
|
+
"type": "organization_tax_registration_form",
|
|
78157
|
+
"attributes": []
|
|
78158
|
+
}
|
|
78159
|
+
}, {
|
|
78160
|
+
"method": "DELETE",
|
|
78161
|
+
"path": "/organizations/:organization_id/tax/registrations/:tax_code",
|
|
78162
|
+
"parameters": [{
|
|
78163
|
+
"name": "organization_id",
|
|
78164
|
+
"type": "string",
|
|
78165
|
+
"location": "Path",
|
|
78166
|
+
"required": true
|
|
78167
|
+
}, {
|
|
78168
|
+
"name": "tax_code",
|
|
78169
|
+
"type": "string",
|
|
78170
|
+
"location": "Path",
|
|
78171
|
+
"required": true
|
|
78172
|
+
}],
|
|
78173
|
+
"responses": [{
|
|
78174
|
+
"code": {
|
|
78175
|
+
"integer": {
|
|
78176
|
+
"value": 204
|
|
78177
|
+
}
|
|
78178
|
+
},
|
|
78179
|
+
"type": "unit",
|
|
78180
|
+
"description": "Registration deleted successfully",
|
|
78181
|
+
"attributes": []
|
|
78182
|
+
}, {
|
|
78183
|
+
"code": {
|
|
78184
|
+
"integer": {
|
|
78185
|
+
"value": 401
|
|
78186
|
+
}
|
|
78187
|
+
},
|
|
78188
|
+
"type": "unit",
|
|
78189
|
+
"description": "Authorization failed",
|
|
78190
|
+
"attributes": []
|
|
78191
|
+
}, {
|
|
78192
|
+
"code": {
|
|
78193
|
+
"integer": {
|
|
78194
|
+
"value": 404
|
|
78195
|
+
}
|
|
78196
|
+
},
|
|
78197
|
+
"type": "unit",
|
|
78198
|
+
"description": "Resource was not found",
|
|
78199
|
+
"attributes": []
|
|
78200
|
+
}],
|
|
78201
|
+
"attributes": [],
|
|
78202
|
+
"description": "Remove a tax registration for an organization by tax code."
|
|
78203
|
+
}],
|
|
78204
|
+
"attributes": [{
|
|
78205
|
+
"name": "docs",
|
|
78206
|
+
"value": {
|
|
78207
|
+
"module": "general"
|
|
78208
|
+
}
|
|
78209
|
+
}],
|
|
78210
|
+
"path": "/organizations/:organization_id/tax/registrations",
|
|
78211
|
+
"description": "Tax registration and self-billing agreement status."
|
|
76635
78212
|
}, {
|
|
76636
78213
|
"type": "organization_token",
|
|
76637
78214
|
"plural": "organization_tokens",
|
|
@@ -78283,7 +79860,7 @@
|
|
|
78283
79860
|
"attributes": [],
|
|
78284
79861
|
"description": "Get the sellability of product",
|
|
78285
79862
|
"body": {
|
|
78286
|
-
"type": "
|
|
79863
|
+
"type": "sellability_request",
|
|
78287
79864
|
"attributes": []
|
|
78288
79865
|
}
|
|
78289
79866
|
}],
|
|
@@ -80791,7 +82368,7 @@
|
|
|
80791
82368
|
"description": "Identifies a field that contains data that must be handled in a way that is compliant with the PCI standard."
|
|
80792
82369
|
}],
|
|
80793
82370
|
"apidoc": {
|
|
80794
|
-
"version": "0.20
|
|
82371
|
+
"version": "0.21.20"
|
|
80795
82372
|
},
|
|
80796
82373
|
"base_url": "https://api.flow.io",
|
|
80797
82374
|
"description": "The Flow Commerce REST API provides full access to the global ecommerce platform."
|