@flowio/api-mock-generator 6.17.110 → 6.17.111
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 +1923 -474
- package/package.json +2 -2
- package/src/api.json +1923 -474
package/src/api.json
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
"key" : "api"
|
|
8
8
|
},
|
|
9
9
|
"namespace" : "io.flow.v0",
|
|
10
|
-
"version" : "0.
|
|
10
|
+
"version" : "0.21.14",
|
|
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.32",
|
|
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.62",
|
|
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.62",
|
|
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.62",
|
|
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.31",
|
|
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",
|
|
@@ -3776,7 +3747,7 @@
|
|
|
3776
3747
|
"attributes" : [ ]
|
|
3777
3748
|
} ],
|
|
3778
3749
|
"attributes" : [ ],
|
|
3779
|
-
"description" : "
|
|
3750
|
+
"description" : "Payout status failure code"
|
|
3780
3751
|
}, {
|
|
3781
3752
|
"name" : "pending_payout_transaction_reason_code",
|
|
3782
3753
|
"plural" : "pending_payout_transaction_reason_codes",
|
|
@@ -4288,6 +4259,24 @@
|
|
|
4288
4259
|
} ],
|
|
4289
4260
|
"attributes" : [ ],
|
|
4290
4261
|
"description" : "review status of a restricted product."
|
|
4262
|
+
}, {
|
|
4263
|
+
"name" : "restriction_environment",
|
|
4264
|
+
"plural" : "restriction_environments",
|
|
4265
|
+
"values" : [ {
|
|
4266
|
+
"name" : "sandbox",
|
|
4267
|
+
"attributes" : [ ],
|
|
4268
|
+
"description" : "In sandbox, no external services (e.g. orders, payments, logistics) will generate real transactions"
|
|
4269
|
+
}, {
|
|
4270
|
+
"name" : "production",
|
|
4271
|
+
"attributes" : [ ],
|
|
4272
|
+
"description" : "In production, all external services are live and will generate real transactions"
|
|
4273
|
+
}, {
|
|
4274
|
+
"name" : "qa",
|
|
4275
|
+
"attributes" : [ ],
|
|
4276
|
+
"description" : "The enterprise QA environment"
|
|
4277
|
+
} ],
|
|
4278
|
+
"attributes" : [ ],
|
|
4279
|
+
"description" : "Environment values for restrictions. Replicates io.flow.common.v0.enums.environment with an additional QA value for enterprise."
|
|
4291
4280
|
}, {
|
|
4292
4281
|
"name" : "return_item_status",
|
|
4293
4282
|
"plural" : "return_item_statuses",
|
|
@@ -4572,6 +4561,56 @@
|
|
|
4572
4561
|
"description" : "commit this request to be associated to the corresponding product_id."
|
|
4573
4562
|
} ],
|
|
4574
4563
|
"attributes" : [ ]
|
|
4564
|
+
}, {
|
|
4565
|
+
"name" : "sellability_result_error_code",
|
|
4566
|
+
"plural" : "sellability_result_error_codes",
|
|
4567
|
+
"values" : [ {
|
|
4568
|
+
"name" : "insufficient_details",
|
|
4569
|
+
"attributes" : [ ],
|
|
4570
|
+
"description" : "The request failed for insufficient details"
|
|
4571
|
+
}, {
|
|
4572
|
+
"name" : "generic_error",
|
|
4573
|
+
"attributes" : [ ],
|
|
4574
|
+
"description" : "The request failed for a generic error"
|
|
4575
|
+
} ],
|
|
4576
|
+
"attributes" : [ ],
|
|
4577
|
+
"description" : "The error code for a failed sellability screening result."
|
|
4578
|
+
}, {
|
|
4579
|
+
"name" : "sellability_result_status",
|
|
4580
|
+
"plural" : "sellability_result_statuses",
|
|
4581
|
+
"values" : [ {
|
|
4582
|
+
"name" : "in_review",
|
|
4583
|
+
"attributes" : [ ],
|
|
4584
|
+
"description" : "The request is in review"
|
|
4585
|
+
}, {
|
|
4586
|
+
"name" : "succeeded",
|
|
4587
|
+
"attributes" : [ ],
|
|
4588
|
+
"description" : "The request has succeeded"
|
|
4589
|
+
}, {
|
|
4590
|
+
"name" : "failed",
|
|
4591
|
+
"attributes" : [ ],
|
|
4592
|
+
"description" : "The request has failed"
|
|
4593
|
+
} ],
|
|
4594
|
+
"attributes" : [ ],
|
|
4595
|
+
"description" : "The status of a sellability screening result."
|
|
4596
|
+
}, {
|
|
4597
|
+
"name" : "sellability_screening_mode",
|
|
4598
|
+
"plural" : "sellability_screening_modes",
|
|
4599
|
+
"values" : [ {
|
|
4600
|
+
"name" : "pre_onboarding",
|
|
4601
|
+
"attributes" : [ ],
|
|
4602
|
+
"description" : "Pre-onboarding sellability screening."
|
|
4603
|
+
}, {
|
|
4604
|
+
"name" : "default_on",
|
|
4605
|
+
"attributes" : [ ],
|
|
4606
|
+
"description" : "Default-on sellability screening."
|
|
4607
|
+
}, {
|
|
4608
|
+
"name" : "active",
|
|
4609
|
+
"attributes" : [ ],
|
|
4610
|
+
"description" : "Active sellability screening."
|
|
4611
|
+
} ],
|
|
4612
|
+
"attributes" : [ ],
|
|
4613
|
+
"description" : "Determines the type of sellability screening to perform."
|
|
4575
4614
|
}, {
|
|
4576
4615
|
"name" : "shipment_integration_type",
|
|
4577
4616
|
"plural" : "shipment_integration_types",
|
|
@@ -4727,6 +4766,23 @@
|
|
|
4727
4766
|
"values" : [ {
|
|
4728
4767
|
"name" : "csv",
|
|
4729
4768
|
"attributes" : [ ]
|
|
4769
|
+
}, {
|
|
4770
|
+
"name" : "pdf",
|
|
4771
|
+
"attributes" : [ ]
|
|
4772
|
+
} ],
|
|
4773
|
+
"attributes" : [ ]
|
|
4774
|
+
}, {
|
|
4775
|
+
"name" : "statement_status_code",
|
|
4776
|
+
"plural" : "statement_status_codes",
|
|
4777
|
+
"values" : [ {
|
|
4778
|
+
"name" : "scheduled",
|
|
4779
|
+
"attributes" : [ ]
|
|
4780
|
+
}, {
|
|
4781
|
+
"name" : "sent",
|
|
4782
|
+
"attributes" : [ ]
|
|
4783
|
+
}, {
|
|
4784
|
+
"name" : "failed",
|
|
4785
|
+
"attributes" : [ ]
|
|
4730
4786
|
} ],
|
|
4731
4787
|
"attributes" : [ ]
|
|
4732
4788
|
}, {
|
|
@@ -5041,6 +5097,9 @@
|
|
|
5041
5097
|
}, {
|
|
5042
5098
|
"name" : "lvg_refund",
|
|
5043
5099
|
"attributes" : [ ]
|
|
5100
|
+
}, {
|
|
5101
|
+
"name" : "us_inbound_tax_refund",
|
|
5102
|
+
"attributes" : [ ]
|
|
5044
5103
|
}, {
|
|
5045
5104
|
"name" : "order_cancellation_above_de_min",
|
|
5046
5105
|
"attributes" : [ ]
|
|
@@ -5423,6 +5482,12 @@
|
|
|
5423
5482
|
}, {
|
|
5424
5483
|
"name" : "merchant_fee",
|
|
5425
5484
|
"attributes" : [ ]
|
|
5485
|
+
}, {
|
|
5486
|
+
"name" : "b2b_tax",
|
|
5487
|
+
"attributes" : [ ]
|
|
5488
|
+
}, {
|
|
5489
|
+
"name" : "b2b_tax_refund",
|
|
5490
|
+
"attributes" : [ ]
|
|
5426
5491
|
} ],
|
|
5427
5492
|
"attributes" : [ ]
|
|
5428
5493
|
}, {
|
|
@@ -5485,6 +5550,9 @@
|
|
|
5485
5550
|
}, {
|
|
5486
5551
|
"name" : "ups",
|
|
5487
5552
|
"attributes" : [ ]
|
|
5553
|
+
}, {
|
|
5554
|
+
"name" : "fedex",
|
|
5555
|
+
"attributes" : [ ]
|
|
5488
5556
|
} ],
|
|
5489
5557
|
"attributes" : [ ]
|
|
5490
5558
|
}, {
|
|
@@ -6423,7 +6491,7 @@
|
|
|
6423
6491
|
"annotations" : [ ]
|
|
6424
6492
|
}, {
|
|
6425
6493
|
"name" : "environment",
|
|
6426
|
-
"type" : "
|
|
6494
|
+
"type" : "restriction_environment",
|
|
6427
6495
|
"required" : true,
|
|
6428
6496
|
"attributes" : [ ],
|
|
6429
6497
|
"annotations" : [ ]
|
|
@@ -6893,7 +6961,7 @@
|
|
|
6893
6961
|
"description" : "The low-fi HS6 code for the product to be used pending full classification and a higher fidelity (HS10) code."
|
|
6894
6962
|
}, {
|
|
6895
6963
|
"name" : "restricted_regions",
|
|
6896
|
-
"type" : "[
|
|
6964
|
+
"type" : "[sellability_region_result]",
|
|
6897
6965
|
"required" : true,
|
|
6898
6966
|
"attributes" : [ ],
|
|
6899
6967
|
"annotations" : [ ],
|
|
@@ -7653,62 +7721,6 @@
|
|
|
7653
7721
|
"type" : "generate_load",
|
|
7654
7722
|
"attributes" : [ ],
|
|
7655
7723
|
"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
7724
|
}, {
|
|
7713
7725
|
"type" : "transaction_upserted",
|
|
7714
7726
|
"attributes" : [ ],
|
|
@@ -8133,6 +8145,14 @@
|
|
|
8133
8145
|
"type" : "ecommerce_platform_deleted",
|
|
8134
8146
|
"attributes" : [ ],
|
|
8135
8147
|
"discriminator_value" : "ecommerce_platform_deleted"
|
|
8148
|
+
}, {
|
|
8149
|
+
"type" : "tax_registration_upserted",
|
|
8150
|
+
"attributes" : [ ],
|
|
8151
|
+
"discriminator_value" : "tax_registration_upserted"
|
|
8152
|
+
}, {
|
|
8153
|
+
"type" : "tax_registration_deleted",
|
|
8154
|
+
"attributes" : [ ],
|
|
8155
|
+
"discriminator_value" : "tax_registration_deleted"
|
|
8136
8156
|
}, {
|
|
8137
8157
|
"type" : "organization_onboarding_state_upserted",
|
|
8138
8158
|
"attributes" : [ ],
|
|
@@ -8322,6 +8342,14 @@
|
|
|
8322
8342
|
"type" : "product_restriction_result_deleted",
|
|
8323
8343
|
"attributes" : [ ],
|
|
8324
8344
|
"discriminator_value" : "product_restriction_result_deleted"
|
|
8345
|
+
}, {
|
|
8346
|
+
"type" : "product_sellability_result_upserted",
|
|
8347
|
+
"attributes" : [ ],
|
|
8348
|
+
"discriminator_value" : "product_sellability_result_upserted"
|
|
8349
|
+
}, {
|
|
8350
|
+
"type" : "product_sellability_result_deleted",
|
|
8351
|
+
"attributes" : [ ],
|
|
8352
|
+
"discriminator_value" : "product_sellability_result_deleted"
|
|
8325
8353
|
}, {
|
|
8326
8354
|
"type" : "shopify_localization_setting_upserted",
|
|
8327
8355
|
"attributes" : [ ],
|
|
@@ -8334,6 +8362,10 @@
|
|
|
8334
8362
|
"type" : "tracking_label_event_upserted",
|
|
8335
8363
|
"attributes" : [ ],
|
|
8336
8364
|
"discriminator_value" : "tracking_label_event_upserted"
|
|
8365
|
+
}, {
|
|
8366
|
+
"type" : "tracking_label_event_upserted_v2",
|
|
8367
|
+
"attributes" : [ ],
|
|
8368
|
+
"discriminator_value" : "tracking_label_event_upserted_v2"
|
|
8337
8369
|
} ],
|
|
8338
8370
|
"attributes" : [ {
|
|
8339
8371
|
"name" : "docs",
|
|
@@ -8773,6 +8805,10 @@
|
|
|
8773
8805
|
"type" : "shopify_merchant_application",
|
|
8774
8806
|
"attributes" : [ ],
|
|
8775
8807
|
"discriminator_value" : "shopify_merchant_application"
|
|
8808
|
+
}, {
|
|
8809
|
+
"type" : "common_merchant_application",
|
|
8810
|
+
"attributes" : [ ],
|
|
8811
|
+
"discriminator_value" : "common_merchant_application"
|
|
8776
8812
|
} ],
|
|
8777
8813
|
"attributes" : [ ],
|
|
8778
8814
|
"interfaces" : [ ],
|
|
@@ -8784,6 +8820,10 @@
|
|
|
8784
8820
|
"type" : "shopify_merchant_application_form",
|
|
8785
8821
|
"attributes" : [ ],
|
|
8786
8822
|
"discriminator_value" : "shopify_merchant_application_form"
|
|
8823
|
+
}, {
|
|
8824
|
+
"type" : "common_merchant_application_form",
|
|
8825
|
+
"attributes" : [ ],
|
|
8826
|
+
"discriminator_value" : "common_merchant_application_form"
|
|
8787
8827
|
} ],
|
|
8788
8828
|
"attributes" : [ ],
|
|
8789
8829
|
"interfaces" : [ ],
|
|
@@ -8795,6 +8835,10 @@
|
|
|
8795
8835
|
"type" : "shopify_merchant_application_put_form",
|
|
8796
8836
|
"attributes" : [ ],
|
|
8797
8837
|
"discriminator_value" : "shopify_merchant_application_put_form"
|
|
8838
|
+
}, {
|
|
8839
|
+
"type" : "common_merchant_application_put_form",
|
|
8840
|
+
"attributes" : [ ],
|
|
8841
|
+
"discriminator_value" : "common_merchant_application_put_form"
|
|
8798
8842
|
} ],
|
|
8799
8843
|
"attributes" : [ ],
|
|
8800
8844
|
"interfaces" : [ ],
|
|
@@ -8806,6 +8850,10 @@
|
|
|
8806
8850
|
"type" : "shopify_merchant_applications_summary",
|
|
8807
8851
|
"attributes" : [ ],
|
|
8808
8852
|
"discriminator_value" : "shopify_merchant_applications_summary"
|
|
8853
|
+
}, {
|
|
8854
|
+
"type" : "common_merchant_applications_summary",
|
|
8855
|
+
"attributes" : [ ],
|
|
8856
|
+
"discriminator_value" : "common_merchant_applications_summary"
|
|
8809
8857
|
} ],
|
|
8810
8858
|
"attributes" : [ ],
|
|
8811
8859
|
"interfaces" : [ ],
|
|
@@ -9562,6 +9610,22 @@
|
|
|
9562
9610
|
"attributes" : [ ],
|
|
9563
9611
|
"interfaces" : [ ],
|
|
9564
9612
|
"discriminator" : "type"
|
|
9613
|
+
}, {
|
|
9614
|
+
"name" : "sellability_request",
|
|
9615
|
+
"plural" : "sellability_requests",
|
|
9616
|
+
"types" : [ {
|
|
9617
|
+
"type" : "product_sellability_form",
|
|
9618
|
+
"attributes" : [ ],
|
|
9619
|
+
"default" : true,
|
|
9620
|
+
"discriminator_value" : "product_sellability_form"
|
|
9621
|
+
}, {
|
|
9622
|
+
"type" : "sellability_screening_form",
|
|
9623
|
+
"attributes" : [ ],
|
|
9624
|
+
"discriminator_value" : "sellability_screening_form"
|
|
9625
|
+
} ],
|
|
9626
|
+
"attributes" : [ ],
|
|
9627
|
+
"interfaces" : [ ],
|
|
9628
|
+
"discriminator" : "discriminator"
|
|
9565
9629
|
}, {
|
|
9566
9630
|
"name" : "sellability_response",
|
|
9567
9631
|
"plural" : "sellability_responses",
|
|
@@ -9573,6 +9637,10 @@
|
|
|
9573
9637
|
"type" : "sellability_error",
|
|
9574
9638
|
"attributes" : [ ],
|
|
9575
9639
|
"discriminator_value" : "sellability_error"
|
|
9640
|
+
}, {
|
|
9641
|
+
"type" : "sellability_screening",
|
|
9642
|
+
"attributes" : [ ],
|
|
9643
|
+
"discriminator_value" : "sellability_screening"
|
|
9576
9644
|
} ],
|
|
9577
9645
|
"attributes" : [ ],
|
|
9578
9646
|
"interfaces" : [ ],
|
|
@@ -11352,55 +11420,6 @@
|
|
|
11352
11420
|
"attributes" : [ ],
|
|
11353
11421
|
"interfaces" : [ ],
|
|
11354
11422
|
"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
11423
|
}, {
|
|
11405
11424
|
"name" : "allocation",
|
|
11406
11425
|
"plural" : "allocations",
|
|
@@ -11963,104 +11982,6 @@
|
|
|
11963
11982
|
} ],
|
|
11964
11983
|
"attributes" : [ ],
|
|
11965
11984
|
"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
11985
|
}, {
|
|
12065
11986
|
"name" : "apple_pay_merchant_validation_payload",
|
|
12066
11987
|
"plural" : "apple_pay_merchant_validation_payloads",
|
|
@@ -13264,6 +13185,13 @@
|
|
|
13264
13185
|
"attributes" : [ ],
|
|
13265
13186
|
"annotations" : [ ],
|
|
13266
13187
|
"description" : "detailed tax breakdown for items & shipping line"
|
|
13188
|
+
}, {
|
|
13189
|
+
"name" : "tax",
|
|
13190
|
+
"type" : "money",
|
|
13191
|
+
"required" : false,
|
|
13192
|
+
"attributes" : [ ],
|
|
13193
|
+
"annotations" : [ ],
|
|
13194
|
+
"description" : "The total amount of tax for this invoice"
|
|
13267
13195
|
}, {
|
|
13268
13196
|
"name" : "documents",
|
|
13269
13197
|
"type" : "[consumer_invoice_document]",
|
|
@@ -13283,6 +13211,19 @@
|
|
|
13283
13211
|
"attributes" : [ ],
|
|
13284
13212
|
"annotations" : [ ],
|
|
13285
13213
|
"default" : "self_bill_invoice"
|
|
13214
|
+
}, {
|
|
13215
|
+
"name" : "center",
|
|
13216
|
+
"type" : "consumer_invoice_center_reference",
|
|
13217
|
+
"required" : false,
|
|
13218
|
+
"attributes" : [ ],
|
|
13219
|
+
"annotations" : [ ],
|
|
13220
|
+
"description" : "The originating fulfillment center. Will be empty for digital goods."
|
|
13221
|
+
}, {
|
|
13222
|
+
"name" : "order",
|
|
13223
|
+
"type" : "consumer_invoice_order_summary",
|
|
13224
|
+
"required" : false,
|
|
13225
|
+
"attributes" : [ ],
|
|
13226
|
+
"annotations" : [ ]
|
|
13286
13227
|
} ],
|
|
13287
13228
|
"attributes" : [ ],
|
|
13288
13229
|
"interfaces" : [ ],
|
|
@@ -16900,6 +16841,12 @@
|
|
|
16900
16841
|
"required" : false,
|
|
16901
16842
|
"attributes" : [ ],
|
|
16902
16843
|
"annotations" : [ ]
|
|
16844
|
+
}, {
|
|
16845
|
+
"name" : "external_order_summary",
|
|
16846
|
+
"type" : "external_order_summary",
|
|
16847
|
+
"required" : false,
|
|
16848
|
+
"attributes" : [ ],
|
|
16849
|
+
"annotations" : [ ]
|
|
16903
16850
|
} ],
|
|
16904
16851
|
"attributes" : [ ],
|
|
16905
16852
|
"interfaces" : [ ]
|
|
@@ -17904,6 +17851,383 @@
|
|
|
17904
17851
|
} ],
|
|
17905
17852
|
"attributes" : [ ],
|
|
17906
17853
|
"interfaces" : [ ]
|
|
17854
|
+
}, {
|
|
17855
|
+
"name" : "common_merchant_application",
|
|
17856
|
+
"plural" : "common_merchant_applications",
|
|
17857
|
+
"fields" : [ {
|
|
17858
|
+
"name" : "id",
|
|
17859
|
+
"type" : "string",
|
|
17860
|
+
"required" : true,
|
|
17861
|
+
"attributes" : [ ],
|
|
17862
|
+
"annotations" : [ ],
|
|
17863
|
+
"description" : "Globally unique identifier"
|
|
17864
|
+
}, {
|
|
17865
|
+
"name" : "organization_id",
|
|
17866
|
+
"type" : "string",
|
|
17867
|
+
"required" : true,
|
|
17868
|
+
"attributes" : [ ],
|
|
17869
|
+
"annotations" : [ ]
|
|
17870
|
+
}, {
|
|
17871
|
+
"name" : "organization_reference",
|
|
17872
|
+
"type" : "onboarding_organization_reference",
|
|
17873
|
+
"required" : true,
|
|
17874
|
+
"attributes" : [ ],
|
|
17875
|
+
"annotations" : [ ]
|
|
17876
|
+
}, {
|
|
17877
|
+
"name" : "status",
|
|
17878
|
+
"type" : "onboarding_application_status",
|
|
17879
|
+
"required" : true,
|
|
17880
|
+
"attributes" : [ ],
|
|
17881
|
+
"annotations" : [ ]
|
|
17882
|
+
}, {
|
|
17883
|
+
"name" : "company",
|
|
17884
|
+
"type" : "merchant_info",
|
|
17885
|
+
"required" : false,
|
|
17886
|
+
"attributes" : [ ],
|
|
17887
|
+
"annotations" : [ ],
|
|
17888
|
+
"description" : "Legal Company Name (DBA), Incorporation Country, and State/Province/Jurisdiction"
|
|
17889
|
+
}, {
|
|
17890
|
+
"name" : "indirect_tax",
|
|
17891
|
+
"type" : "indirect_tax",
|
|
17892
|
+
"required" : false,
|
|
17893
|
+
"attributes" : [ ],
|
|
17894
|
+
"annotations" : [ ],
|
|
17895
|
+
"description" : "Indirect Tax Information"
|
|
17896
|
+
}, {
|
|
17897
|
+
"name" : "ultimate_beneficiary_owner",
|
|
17898
|
+
"type" : "ultimate_beneficiary_owner",
|
|
17899
|
+
"required" : false,
|
|
17900
|
+
"attributes" : [ ],
|
|
17901
|
+
"annotations" : [ ],
|
|
17902
|
+
"description" : "Ultimate Beneficiary Owner (UBO) info, or CEO's info if no UBO exists"
|
|
17903
|
+
}, {
|
|
17904
|
+
"name" : "business_url",
|
|
17905
|
+
"type" : "string",
|
|
17906
|
+
"required" : false,
|
|
17907
|
+
"attributes" : [ ],
|
|
17908
|
+
"annotations" : [ ]
|
|
17909
|
+
}, {
|
|
17910
|
+
"name" : "business_description",
|
|
17911
|
+
"type" : "string",
|
|
17912
|
+
"required" : false,
|
|
17913
|
+
"attributes" : [ ],
|
|
17914
|
+
"annotations" : [ ]
|
|
17915
|
+
}, {
|
|
17916
|
+
"name" : "business_address",
|
|
17917
|
+
"type" : "address",
|
|
17918
|
+
"required" : false,
|
|
17919
|
+
"attributes" : [ ],
|
|
17920
|
+
"annotations" : [ ]
|
|
17921
|
+
}, {
|
|
17922
|
+
"name" : "refund_percentage",
|
|
17923
|
+
"type" : "decimal",
|
|
17924
|
+
"required" : false,
|
|
17925
|
+
"attributes" : [ ],
|
|
17926
|
+
"annotations" : [ ]
|
|
17927
|
+
}, {
|
|
17928
|
+
"name" : "chargeback_percentage",
|
|
17929
|
+
"type" : "decimal",
|
|
17930
|
+
"required" : false,
|
|
17931
|
+
"attributes" : [ ],
|
|
17932
|
+
"annotations" : [ ]
|
|
17933
|
+
}, {
|
|
17934
|
+
"name" : "beneficiary_details",
|
|
17935
|
+
"type" : "merchant_onboarding_beneficiary_details",
|
|
17936
|
+
"required" : false,
|
|
17937
|
+
"attributes" : [ ],
|
|
17938
|
+
"annotations" : [ ]
|
|
17939
|
+
}, {
|
|
17940
|
+
"name" : "other_trade_sector",
|
|
17941
|
+
"type" : "string",
|
|
17942
|
+
"required" : false,
|
|
17943
|
+
"attributes" : [ ],
|
|
17944
|
+
"annotations" : [ ]
|
|
17945
|
+
}, {
|
|
17946
|
+
"name" : "center_contact",
|
|
17947
|
+
"type" : "operations_contact",
|
|
17948
|
+
"required" : false,
|
|
17949
|
+
"attributes" : [ ],
|
|
17950
|
+
"annotations" : [ ]
|
|
17951
|
+
}, {
|
|
17952
|
+
"name" : "center_address",
|
|
17953
|
+
"type" : "address",
|
|
17954
|
+
"required" : false,
|
|
17955
|
+
"attributes" : [ ],
|
|
17956
|
+
"annotations" : [ ]
|
|
17957
|
+
}, {
|
|
17958
|
+
"name" : "average_order_weight",
|
|
17959
|
+
"type" : "decimal",
|
|
17960
|
+
"required" : false,
|
|
17961
|
+
"attributes" : [ ],
|
|
17962
|
+
"annotations" : [ ]
|
|
17963
|
+
}, {
|
|
17964
|
+
"name" : "average_order_weight_unit",
|
|
17965
|
+
"type" : "unit_of_measurement",
|
|
17966
|
+
"required" : false,
|
|
17967
|
+
"attributes" : [ ],
|
|
17968
|
+
"annotations" : [ ]
|
|
17969
|
+
}, {
|
|
17970
|
+
"name" : "package_dimensions",
|
|
17971
|
+
"type" : "[dimension]",
|
|
17972
|
+
"required" : false,
|
|
17973
|
+
"attributes" : [ ],
|
|
17974
|
+
"annotations" : [ ]
|
|
17975
|
+
}, {
|
|
17976
|
+
"name" : "monthly_average",
|
|
17977
|
+
"type" : "monthly_average",
|
|
17978
|
+
"required" : false,
|
|
17979
|
+
"attributes" : [ ],
|
|
17980
|
+
"annotations" : [ ],
|
|
17981
|
+
"description" : "Monthly Average Volume & Transactions (#)"
|
|
17982
|
+
}, {
|
|
17983
|
+
"name" : "default_country_of_origin",
|
|
17984
|
+
"type" : "string",
|
|
17985
|
+
"required" : false,
|
|
17986
|
+
"attributes" : [ ],
|
|
17987
|
+
"annotations" : [ ],
|
|
17988
|
+
"description" : "Country of Origin populated in the catalog (ISO 3166 3-character country code)"
|
|
17989
|
+
}, {
|
|
17990
|
+
"name" : "rate_card",
|
|
17991
|
+
"type" : "string",
|
|
17992
|
+
"required" : true,
|
|
17993
|
+
"attributes" : [ ],
|
|
17994
|
+
"annotations" : [ ]
|
|
17995
|
+
}, {
|
|
17996
|
+
"name" : "shop",
|
|
17997
|
+
"type" : "shop",
|
|
17998
|
+
"required" : false,
|
|
17999
|
+
"attributes" : [ ],
|
|
18000
|
+
"annotations" : [ ]
|
|
18001
|
+
}, {
|
|
18002
|
+
"name" : "created_at",
|
|
18003
|
+
"type" : "date-time-iso8601",
|
|
18004
|
+
"required" : true,
|
|
18005
|
+
"attributes" : [ ],
|
|
18006
|
+
"annotations" : [ ]
|
|
18007
|
+
}, {
|
|
18008
|
+
"name" : "last_year_xborder_gmv",
|
|
18009
|
+
"type" : "money",
|
|
18010
|
+
"required" : false,
|
|
18011
|
+
"attributes" : [ ],
|
|
18012
|
+
"annotations" : [ ],
|
|
18013
|
+
"description" : "Cross border GMV for previous year"
|
|
18014
|
+
}, {
|
|
18015
|
+
"name" : "last_month_xborder_gmv",
|
|
18016
|
+
"type" : "money",
|
|
18017
|
+
"required" : false,
|
|
18018
|
+
"attributes" : [ ],
|
|
18019
|
+
"annotations" : [ ],
|
|
18020
|
+
"description" : "Cross border GMV for previous month"
|
|
18021
|
+
}, {
|
|
18022
|
+
"name" : "average_order_value",
|
|
18023
|
+
"type" : "money",
|
|
18024
|
+
"required" : false,
|
|
18025
|
+
"attributes" : [ ],
|
|
18026
|
+
"annotations" : [ ],
|
|
18027
|
+
"description" : "Cross border average order value"
|
|
18028
|
+
}, {
|
|
18029
|
+
"name" : "mcc_codes",
|
|
18030
|
+
"type" : "[long]",
|
|
18031
|
+
"required" : false,
|
|
18032
|
+
"attributes" : [ ],
|
|
18033
|
+
"annotations" : [ ]
|
|
18034
|
+
} ],
|
|
18035
|
+
"attributes" : [ ],
|
|
18036
|
+
"interfaces" : [ ],
|
|
18037
|
+
"description" : "Common merchant application"
|
|
18038
|
+
}, {
|
|
18039
|
+
"name" : "common_merchant_application_form",
|
|
18040
|
+
"plural" : "common_merchant_application_forms",
|
|
18041
|
+
"fields" : [ {
|
|
18042
|
+
"name" : "company",
|
|
18043
|
+
"type" : "merchant_info",
|
|
18044
|
+
"required" : false,
|
|
18045
|
+
"attributes" : [ ],
|
|
18046
|
+
"annotations" : [ ],
|
|
18047
|
+
"description" : "Legal Company Name (DBA), Incorporation Country, and State/Province/Jurisdiction"
|
|
18048
|
+
}, {
|
|
18049
|
+
"name" : "indirect_tax",
|
|
18050
|
+
"type" : "indirect_tax",
|
|
18051
|
+
"required" : false,
|
|
18052
|
+
"attributes" : [ ],
|
|
18053
|
+
"annotations" : [ ],
|
|
18054
|
+
"description" : "Indirect Tax Information"
|
|
18055
|
+
}, {
|
|
18056
|
+
"name" : "ultimate_beneficiary_owner",
|
|
18057
|
+
"type" : "ultimate_beneficiary_owner",
|
|
18058
|
+
"required" : false,
|
|
18059
|
+
"attributes" : [ ],
|
|
18060
|
+
"annotations" : [ ],
|
|
18061
|
+
"description" : "Ultimate Beneficiary Owner (UBO) info, or CEO's info if no UBO exists"
|
|
18062
|
+
}, {
|
|
18063
|
+
"name" : "business_url",
|
|
18064
|
+
"type" : "string",
|
|
18065
|
+
"required" : false,
|
|
18066
|
+
"attributes" : [ ],
|
|
18067
|
+
"annotations" : [ ]
|
|
18068
|
+
}, {
|
|
18069
|
+
"name" : "business_description",
|
|
18070
|
+
"type" : "string",
|
|
18071
|
+
"required" : false,
|
|
18072
|
+
"attributes" : [ ],
|
|
18073
|
+
"annotations" : [ ]
|
|
18074
|
+
}, {
|
|
18075
|
+
"name" : "business_address",
|
|
18076
|
+
"type" : "address",
|
|
18077
|
+
"required" : false,
|
|
18078
|
+
"attributes" : [ ],
|
|
18079
|
+
"annotations" : [ ]
|
|
18080
|
+
}, {
|
|
18081
|
+
"name" : "refund_percentage",
|
|
18082
|
+
"type" : "decimal",
|
|
18083
|
+
"required" : false,
|
|
18084
|
+
"attributes" : [ ],
|
|
18085
|
+
"annotations" : [ ]
|
|
18086
|
+
}, {
|
|
18087
|
+
"name" : "chargeback_percentage",
|
|
18088
|
+
"type" : "decimal",
|
|
18089
|
+
"required" : false,
|
|
18090
|
+
"attributes" : [ ],
|
|
18091
|
+
"annotations" : [ ]
|
|
18092
|
+
}, {
|
|
18093
|
+
"name" : "beneficiary_details",
|
|
18094
|
+
"type" : "merchant_onboarding_beneficiary_details",
|
|
18095
|
+
"required" : false,
|
|
18096
|
+
"attributes" : [ ],
|
|
18097
|
+
"annotations" : [ ]
|
|
18098
|
+
}, {
|
|
18099
|
+
"name" : "other_trade_sector",
|
|
18100
|
+
"type" : "string",
|
|
18101
|
+
"required" : false,
|
|
18102
|
+
"attributes" : [ ],
|
|
18103
|
+
"annotations" : [ ]
|
|
18104
|
+
}, {
|
|
18105
|
+
"name" : "center_contact",
|
|
18106
|
+
"type" : "operations_contact",
|
|
18107
|
+
"required" : false,
|
|
18108
|
+
"attributes" : [ ],
|
|
18109
|
+
"annotations" : [ ]
|
|
18110
|
+
}, {
|
|
18111
|
+
"name" : "center_address",
|
|
18112
|
+
"type" : "address",
|
|
18113
|
+
"required" : false,
|
|
18114
|
+
"attributes" : [ ],
|
|
18115
|
+
"annotations" : [ ]
|
|
18116
|
+
}, {
|
|
18117
|
+
"name" : "average_order_weight",
|
|
18118
|
+
"type" : "decimal",
|
|
18119
|
+
"required" : false,
|
|
18120
|
+
"attributes" : [ ],
|
|
18121
|
+
"annotations" : [ ]
|
|
18122
|
+
}, {
|
|
18123
|
+
"name" : "average_order_weight_unit",
|
|
18124
|
+
"type" : "unit_of_measurement",
|
|
18125
|
+
"required" : false,
|
|
18126
|
+
"attributes" : [ ],
|
|
18127
|
+
"annotations" : [ ]
|
|
18128
|
+
}, {
|
|
18129
|
+
"name" : "package_dimensions",
|
|
18130
|
+
"type" : "[dimension]",
|
|
18131
|
+
"required" : false,
|
|
18132
|
+
"attributes" : [ ],
|
|
18133
|
+
"annotations" : [ ]
|
|
18134
|
+
}, {
|
|
18135
|
+
"name" : "monthly_average_volume_amount",
|
|
18136
|
+
"type" : "decimal",
|
|
18137
|
+
"required" : false,
|
|
18138
|
+
"attributes" : [ ],
|
|
18139
|
+
"annotations" : [ ],
|
|
18140
|
+
"description" : "Monthly average value of domestic transactions"
|
|
18141
|
+
}, {
|
|
18142
|
+
"name" : "monthly_average_volume_currency",
|
|
18143
|
+
"type" : "string",
|
|
18144
|
+
"required" : false,
|
|
18145
|
+
"attributes" : [ ],
|
|
18146
|
+
"annotations" : [ ],
|
|
18147
|
+
"description" : "Monthly Average Volume Currency"
|
|
18148
|
+
}, {
|
|
18149
|
+
"name" : "monthly_average_number_transactions",
|
|
18150
|
+
"type" : "long",
|
|
18151
|
+
"required" : false,
|
|
18152
|
+
"attributes" : [ ],
|
|
18153
|
+
"annotations" : [ ],
|
|
18154
|
+
"description" : "Monthly average count of domestic transactions"
|
|
18155
|
+
}, {
|
|
18156
|
+
"name" : "default_country_of_origin",
|
|
18157
|
+
"type" : "string",
|
|
18158
|
+
"required" : false,
|
|
18159
|
+
"attributes" : [ ],
|
|
18160
|
+
"annotations" : [ ],
|
|
18161
|
+
"description" : "Country of Origin populated in the catalog (ISO 3166 3-character country code)"
|
|
18162
|
+
}, {
|
|
18163
|
+
"name" : "shop",
|
|
18164
|
+
"type" : "shop",
|
|
18165
|
+
"required" : false,
|
|
18166
|
+
"attributes" : [ ],
|
|
18167
|
+
"annotations" : [ ]
|
|
18168
|
+
}, {
|
|
18169
|
+
"name" : "rate_card",
|
|
18170
|
+
"type" : "string",
|
|
18171
|
+
"required" : false,
|
|
18172
|
+
"attributes" : [ ],
|
|
18173
|
+
"annotations" : [ ]
|
|
18174
|
+
}, {
|
|
18175
|
+
"name" : "last_year_xborder_gmv",
|
|
18176
|
+
"type" : "money",
|
|
18177
|
+
"required" : false,
|
|
18178
|
+
"attributes" : [ ],
|
|
18179
|
+
"annotations" : [ ],
|
|
18180
|
+
"description" : "Cross border GMV for previous year"
|
|
18181
|
+
}, {
|
|
18182
|
+
"name" : "last_month_xborder_gmv",
|
|
18183
|
+
"type" : "money",
|
|
18184
|
+
"required" : false,
|
|
18185
|
+
"attributes" : [ ],
|
|
18186
|
+
"annotations" : [ ],
|
|
18187
|
+
"description" : "Cross border GMV for previous month"
|
|
18188
|
+
}, {
|
|
18189
|
+
"name" : "average_order_value",
|
|
18190
|
+
"type" : "money",
|
|
18191
|
+
"required" : false,
|
|
18192
|
+
"attributes" : [ ],
|
|
18193
|
+
"annotations" : [ ],
|
|
18194
|
+
"description" : "Cross border average order value"
|
|
18195
|
+
}, {
|
|
18196
|
+
"name" : "mcc_codes",
|
|
18197
|
+
"type" : "[long]",
|
|
18198
|
+
"required" : false,
|
|
18199
|
+
"attributes" : [ ],
|
|
18200
|
+
"annotations" : [ ]
|
|
18201
|
+
} ],
|
|
18202
|
+
"attributes" : [ ],
|
|
18203
|
+
"interfaces" : [ ],
|
|
18204
|
+
"description" : "Common merchant application form"
|
|
18205
|
+
}, {
|
|
18206
|
+
"name" : "common_merchant_application_put_form",
|
|
18207
|
+
"plural" : "common_merchant_application_put_forms",
|
|
18208
|
+
"fields" : [ {
|
|
18209
|
+
"name" : "status",
|
|
18210
|
+
"type" : "onboarding_application_status",
|
|
18211
|
+
"required" : false,
|
|
18212
|
+
"attributes" : [ ],
|
|
18213
|
+
"annotations" : [ ]
|
|
18214
|
+
} ],
|
|
18215
|
+
"attributes" : [ ],
|
|
18216
|
+
"interfaces" : [ ],
|
|
18217
|
+
"description" : "Common merchant application put form"
|
|
18218
|
+
}, {
|
|
18219
|
+
"name" : "common_merchant_applications_summary",
|
|
18220
|
+
"plural" : "common_merchant_applications_summaries",
|
|
18221
|
+
"fields" : [ {
|
|
18222
|
+
"name" : "total",
|
|
18223
|
+
"type" : "long",
|
|
18224
|
+
"required" : true,
|
|
18225
|
+
"attributes" : [ ],
|
|
18226
|
+
"annotations" : [ ]
|
|
18227
|
+
} ],
|
|
18228
|
+
"attributes" : [ ],
|
|
18229
|
+
"interfaces" : [ ],
|
|
18230
|
+
"description" : "Common merchant applications summary"
|
|
17907
18231
|
}, {
|
|
17908
18232
|
"name" : "company",
|
|
17909
18233
|
"plural" : "companies",
|
|
@@ -18923,6 +19247,19 @@
|
|
|
18923
19247
|
"required" : false,
|
|
18924
19248
|
"attributes" : [ ],
|
|
18925
19249
|
"annotations" : [ ]
|
|
19250
|
+
}, {
|
|
19251
|
+
"name" : "center",
|
|
19252
|
+
"type" : "consumer_invoice_center_reference",
|
|
19253
|
+
"required" : false,
|
|
19254
|
+
"attributes" : [ ],
|
|
19255
|
+
"annotations" : [ ],
|
|
19256
|
+
"description" : "The originating fulfillment center. Will be empty for digital goods."
|
|
19257
|
+
}, {
|
|
19258
|
+
"name" : "order",
|
|
19259
|
+
"type" : "consumer_invoice_order_summary",
|
|
19260
|
+
"required" : false,
|
|
19261
|
+
"attributes" : [ ],
|
|
19262
|
+
"annotations" : [ ]
|
|
18926
19263
|
} ],
|
|
18927
19264
|
"attributes" : [ ],
|
|
18928
19265
|
"interfaces" : [ ],
|
|
@@ -22407,7 +22744,17 @@
|
|
|
22407
22744
|
"type" : "ratecard_region_reference",
|
|
22408
22745
|
"required" : false,
|
|
22409
22746
|
"attributes" : [ ],
|
|
22410
|
-
"annotations" : [ ]
|
|
22747
|
+
"annotations" : [ ],
|
|
22748
|
+
"deprecation" : {
|
|
22749
|
+
"description" : "Use destination_regions instead."
|
|
22750
|
+
}
|
|
22751
|
+
}, {
|
|
22752
|
+
"name" : "destination_regions",
|
|
22753
|
+
"type" : "[ratecard_region_reference]",
|
|
22754
|
+
"required" : false,
|
|
22755
|
+
"attributes" : [ ],
|
|
22756
|
+
"annotations" : [ ],
|
|
22757
|
+
"description" : "List of regions to which this fee applies. Replaces destination_region."
|
|
22411
22758
|
}, {
|
|
22412
22759
|
"name" : "interval_unit",
|
|
22413
22760
|
"type" : "unit_of_measurement",
|
|
@@ -23886,6 +24233,25 @@
|
|
|
23886
24233
|
"attributes" : [ ],
|
|
23887
24234
|
"interfaces" : [ ],
|
|
23888
24235
|
"description" : "Card external details. (processed through an external PSP)"
|
|
24236
|
+
}, {
|
|
24237
|
+
"name" : "external_order_summary",
|
|
24238
|
+
"plural" : "external_order_summaries",
|
|
24239
|
+
"fields" : [ {
|
|
24240
|
+
"name" : "id",
|
|
24241
|
+
"type" : "string",
|
|
24242
|
+
"required" : true,
|
|
24243
|
+
"attributes" : [ ],
|
|
24244
|
+
"annotations" : [ ],
|
|
24245
|
+
"description" : "Globally unique identifier"
|
|
24246
|
+
}, {
|
|
24247
|
+
"name" : "edit_ids",
|
|
24248
|
+
"type" : "[string]",
|
|
24249
|
+
"required" : true,
|
|
24250
|
+
"attributes" : [ ],
|
|
24251
|
+
"annotations" : [ ]
|
|
24252
|
+
} ],
|
|
24253
|
+
"attributes" : [ ],
|
|
24254
|
+
"interfaces" : [ ]
|
|
23889
24255
|
}, {
|
|
23890
24256
|
"name" : "fee_deduction",
|
|
23891
24257
|
"plural" : "fee_deductions",
|
|
@@ -25081,7 +25447,7 @@
|
|
|
25081
25447
|
"annotations" : [ ]
|
|
25082
25448
|
}, {
|
|
25083
25449
|
"name" : "environment",
|
|
25084
|
-
"type" : "
|
|
25450
|
+
"type" : "restriction_environment",
|
|
25085
25451
|
"required" : true,
|
|
25086
25452
|
"attributes" : [ ],
|
|
25087
25453
|
"annotations" : [ ]
|
|
@@ -25381,7 +25747,7 @@
|
|
|
25381
25747
|
"annotations" : [ ]
|
|
25382
25748
|
}, {
|
|
25383
25749
|
"name" : "environment",
|
|
25384
|
-
"type" : "
|
|
25750
|
+
"type" : "restriction_environment",
|
|
25385
25751
|
"required" : true,
|
|
25386
25752
|
"attributes" : [ ],
|
|
25387
25753
|
"annotations" : [ ]
|
|
@@ -25432,7 +25798,7 @@
|
|
|
25432
25798
|
"annotations" : [ ]
|
|
25433
25799
|
}, {
|
|
25434
25800
|
"name" : "environment",
|
|
25435
|
-
"type" : "
|
|
25801
|
+
"type" : "restriction_environment",
|
|
25436
25802
|
"required" : true,
|
|
25437
25803
|
"attributes" : [ ],
|
|
25438
25804
|
"annotations" : [ ]
|
|
@@ -26350,55 +26716,6 @@
|
|
|
26350
26716
|
} ],
|
|
26351
26717
|
"attributes" : [ ],
|
|
26352
26718
|
"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
26719
|
}, {
|
|
26403
26720
|
"name" : "hs10",
|
|
26404
26721
|
"plural" : "hs10",
|
|
@@ -31092,6 +31409,12 @@
|
|
|
31092
31409
|
"required" : false,
|
|
31093
31410
|
"attributes" : [ ],
|
|
31094
31411
|
"annotations" : [ ]
|
|
31412
|
+
}, {
|
|
31413
|
+
"name" : "description",
|
|
31414
|
+
"type" : "string",
|
|
31415
|
+
"required" : false,
|
|
31416
|
+
"attributes" : [ ],
|
|
31417
|
+
"annotations" : [ ]
|
|
31095
31418
|
} ],
|
|
31096
31419
|
"attributes" : [ ],
|
|
31097
31420
|
"interfaces" : [ ]
|
|
@@ -31289,6 +31612,20 @@
|
|
|
31289
31612
|
"annotations" : [ ],
|
|
31290
31613
|
"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
31614
|
"example" : "CAN"
|
|
31615
|
+
}, {
|
|
31616
|
+
"name" : "province_number",
|
|
31617
|
+
"type" : "string",
|
|
31618
|
+
"required" : false,
|
|
31619
|
+
"attributes" : [ ],
|
|
31620
|
+
"annotations" : [ ],
|
|
31621
|
+
"description" : "An optional additional provincial tax registration number for the entity."
|
|
31622
|
+
}, {
|
|
31623
|
+
"name" : "province",
|
|
31624
|
+
"type" : "string",
|
|
31625
|
+
"required" : false,
|
|
31626
|
+
"attributes" : [ ],
|
|
31627
|
+
"annotations" : [ ],
|
|
31628
|
+
"description" : "The province in which the provincial registration number is defined."
|
|
31292
31629
|
} ],
|
|
31293
31630
|
"attributes" : [ ],
|
|
31294
31631
|
"interfaces" : [ ]
|
|
@@ -31374,6 +31711,62 @@
|
|
|
31374
31711
|
} ],
|
|
31375
31712
|
"attributes" : [ ],
|
|
31376
31713
|
"interfaces" : [ ]
|
|
31714
|
+
}, {
|
|
31715
|
+
"name" : "merchant_onboarding_beneficiary_details",
|
|
31716
|
+
"plural" : "merchant_onboarding_beneficiary_detailses",
|
|
31717
|
+
"fields" : [ {
|
|
31718
|
+
"name" : "name",
|
|
31719
|
+
"type" : "string",
|
|
31720
|
+
"required" : false,
|
|
31721
|
+
"attributes" : [ ],
|
|
31722
|
+
"annotations" : [ "personal_data" ]
|
|
31723
|
+
}, {
|
|
31724
|
+
"name" : "address",
|
|
31725
|
+
"type" : "address",
|
|
31726
|
+
"required" : false,
|
|
31727
|
+
"attributes" : [ ],
|
|
31728
|
+
"annotations" : [ "personal_data" ]
|
|
31729
|
+
}, {
|
|
31730
|
+
"name" : "phone",
|
|
31731
|
+
"type" : "string",
|
|
31732
|
+
"required" : false,
|
|
31733
|
+
"attributes" : [ ],
|
|
31734
|
+
"annotations" : [ "personal_data" ]
|
|
31735
|
+
}, {
|
|
31736
|
+
"name" : "email",
|
|
31737
|
+
"type" : "string",
|
|
31738
|
+
"required" : false,
|
|
31739
|
+
"attributes" : [ ],
|
|
31740
|
+
"annotations" : [ "personal_data" ]
|
|
31741
|
+
}, {
|
|
31742
|
+
"name" : "bank_account_number",
|
|
31743
|
+
"type" : "string",
|
|
31744
|
+
"required" : false,
|
|
31745
|
+
"attributes" : [ ],
|
|
31746
|
+
"annotations" : [ "personal_data" ]
|
|
31747
|
+
}, {
|
|
31748
|
+
"name" : "bank_routing_number",
|
|
31749
|
+
"type" : "string",
|
|
31750
|
+
"required" : false,
|
|
31751
|
+
"attributes" : [ ],
|
|
31752
|
+
"annotations" : [ ],
|
|
31753
|
+
"description" : "SWIFT code or US aba routing Number"
|
|
31754
|
+
}, {
|
|
31755
|
+
"name" : "bank_name",
|
|
31756
|
+
"type" : "string",
|
|
31757
|
+
"required" : false,
|
|
31758
|
+
"attributes" : [ ],
|
|
31759
|
+
"annotations" : [ ]
|
|
31760
|
+
}, {
|
|
31761
|
+
"name" : "bank_address",
|
|
31762
|
+
"type" : "address",
|
|
31763
|
+
"required" : false,
|
|
31764
|
+
"attributes" : [ ],
|
|
31765
|
+
"annotations" : [ ]
|
|
31766
|
+
} ],
|
|
31767
|
+
"attributes" : [ ],
|
|
31768
|
+
"interfaces" : [ ],
|
|
31769
|
+
"description" : "Beneficiary details"
|
|
31377
31770
|
}, {
|
|
31378
31771
|
"name" : "merchant_rejected",
|
|
31379
31772
|
"plural" : "merchant_rejecteds",
|
|
@@ -31577,55 +31970,6 @@
|
|
|
31577
31970
|
} ],
|
|
31578
31971
|
"attributes" : [ ],
|
|
31579
31972
|
"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
31973
|
}, {
|
|
31630
31974
|
"name" : "notification_deleted_v2",
|
|
31631
31975
|
"plural" : "notification_deleted_v2s",
|
|
@@ -35656,6 +36000,93 @@
|
|
|
35656
36000
|
} ],
|
|
35657
36001
|
"attributes" : [ ],
|
|
35658
36002
|
"interfaces" : [ ]
|
|
36003
|
+
}, {
|
|
36004
|
+
"name" : "organization_tax_registration",
|
|
36005
|
+
"plural" : "organization_tax_registrations",
|
|
36006
|
+
"fields" : [ {
|
|
36007
|
+
"name" : "id",
|
|
36008
|
+
"type" : "string",
|
|
36009
|
+
"required" : true,
|
|
36010
|
+
"attributes" : [ ],
|
|
36011
|
+
"annotations" : [ ],
|
|
36012
|
+
"description" : "Flow's internal ID for this registration",
|
|
36013
|
+
"example" : "otr-a1b2c3d4e5f6"
|
|
36014
|
+
}, {
|
|
36015
|
+
"name" : "organization",
|
|
36016
|
+
"type" : "organization_summary",
|
|
36017
|
+
"required" : true,
|
|
36018
|
+
"attributes" : [ ],
|
|
36019
|
+
"annotations" : [ ],
|
|
36020
|
+
"description" : "The Flow organization id, name and environment"
|
|
36021
|
+
}, {
|
|
36022
|
+
"name" : "address",
|
|
36023
|
+
"type" : "billing_address",
|
|
36024
|
+
"required" : true,
|
|
36025
|
+
"attributes" : [ ],
|
|
36026
|
+
"annotations" : [ ],
|
|
36027
|
+
"description" : "business name and address of the merchant"
|
|
36028
|
+
}, {
|
|
36029
|
+
"name" : "registration",
|
|
36030
|
+
"type" : "tax_registration_detail",
|
|
36031
|
+
"required" : true,
|
|
36032
|
+
"attributes" : [ ],
|
|
36033
|
+
"annotations" : [ ]
|
|
36034
|
+
}, {
|
|
36035
|
+
"name" : "self_billing_agreement",
|
|
36036
|
+
"type" : "self_billing_agreement",
|
|
36037
|
+
"required" : true,
|
|
36038
|
+
"attributes" : [ ],
|
|
36039
|
+
"annotations" : [ ],
|
|
36040
|
+
"description" : "Details of the self-billing agreement, if one exists"
|
|
36041
|
+
} ],
|
|
36042
|
+
"attributes" : [ ],
|
|
36043
|
+
"interfaces" : [ ],
|
|
36044
|
+
"description" : "Tax registration and self-billing agreement status."
|
|
36045
|
+
}, {
|
|
36046
|
+
"name" : "organization_tax_registration_form",
|
|
36047
|
+
"plural" : "organization_tax_registration_forms",
|
|
36048
|
+
"fields" : [ {
|
|
36049
|
+
"name" : "tax_number",
|
|
36050
|
+
"type" : "string",
|
|
36051
|
+
"required" : true,
|
|
36052
|
+
"attributes" : [ ],
|
|
36053
|
+
"annotations" : [ ],
|
|
36054
|
+
"description" : "The merchant's tax registration number/ID for this jurisdiction",
|
|
36055
|
+
"example" : "123456789RT0001"
|
|
36056
|
+
}, {
|
|
36057
|
+
"name" : "country",
|
|
36058
|
+
"type" : "string",
|
|
36059
|
+
"required" : true,
|
|
36060
|
+
"attributes" : [ ],
|
|
36061
|
+
"annotations" : [ ],
|
|
36062
|
+
"description" : "ISO 3166-1 alpha-3 country code where this tax registration applies",
|
|
36063
|
+
"example" : "CAN"
|
|
36064
|
+
}, {
|
|
36065
|
+
"name" : "province",
|
|
36066
|
+
"type" : "string",
|
|
36067
|
+
"required" : false,
|
|
36068
|
+
"attributes" : [ ],
|
|
36069
|
+
"annotations" : [ ],
|
|
36070
|
+
"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.",
|
|
36071
|
+
"example" : "QC"
|
|
36072
|
+
}, {
|
|
36073
|
+
"name" : "self_billing_agreement_effective_at",
|
|
36074
|
+
"type" : "date-time-iso8601",
|
|
36075
|
+
"required" : true,
|
|
36076
|
+
"attributes" : [ ],
|
|
36077
|
+
"annotations" : [ ],
|
|
36078
|
+
"description" : "Timestamp of the self-billing invoice agreement signed by the merchant"
|
|
36079
|
+
}, {
|
|
36080
|
+
"name" : "self_billing_agreement_expires_at",
|
|
36081
|
+
"type" : "date-time-iso8601",
|
|
36082
|
+
"required" : false,
|
|
36083
|
+
"attributes" : [ ],
|
|
36084
|
+
"annotations" : [ ],
|
|
36085
|
+
"description" : "Expiration date of the self-billing agreement. If not provided, defaults to 24 months from effective_at."
|
|
36086
|
+
} ],
|
|
36087
|
+
"attributes" : [ ],
|
|
36088
|
+
"interfaces" : [ ],
|
|
36089
|
+
"description" : "Request body for submitting tax registrations when a self-billing invoice agreement is signed or updated."
|
|
35659
36090
|
}, {
|
|
35660
36091
|
"name" : "organization_token",
|
|
35661
36092
|
"plural" : "organization_tokens",
|
|
@@ -38879,6 +39310,13 @@
|
|
|
38879
39310
|
"attributes" : [ ],
|
|
38880
39311
|
"annotations" : [ ],
|
|
38881
39312
|
"description" : "The result of the checks run against an order and its payment"
|
|
39313
|
+
}, {
|
|
39314
|
+
"name" : "client_secret",
|
|
39315
|
+
"type" : "string",
|
|
39316
|
+
"required" : false,
|
|
39317
|
+
"attributes" : [ ],
|
|
39318
|
+
"annotations" : [ ],
|
|
39319
|
+
"description" : "JWT Token for use with ge-checkout.js"
|
|
38882
39320
|
} ],
|
|
38883
39321
|
"attributes" : [ ],
|
|
38884
39322
|
"interfaces" : [ ]
|
|
@@ -41316,7 +41754,7 @@
|
|
|
41316
41754
|
"description" : "The harmonization HS6 code."
|
|
41317
41755
|
}, {
|
|
41318
41756
|
"name" : "restricted_regions_by_type",
|
|
41319
|
-
"type" : "[
|
|
41757
|
+
"type" : "[sellability_region_result]",
|
|
41320
41758
|
"required" : false,
|
|
41321
41759
|
"attributes" : [ ],
|
|
41322
41760
|
"annotations" : [ ],
|
|
@@ -41428,7 +41866,7 @@
|
|
|
41428
41866
|
"description" : "The low-fi HS6 code for the product to be used pending full classification and a higher fidelity (HS10) code."
|
|
41429
41867
|
}, {
|
|
41430
41868
|
"name" : "restricted_regions",
|
|
41431
|
-
"type" : "[
|
|
41869
|
+
"type" : "[sellability_region_result]",
|
|
41432
41870
|
"required" : true,
|
|
41433
41871
|
"attributes" : [ ],
|
|
41434
41872
|
"annotations" : [ ],
|
|
@@ -41499,6 +41937,118 @@
|
|
|
41499
41937
|
"attributes" : [ ],
|
|
41500
41938
|
"interfaces" : [ ],
|
|
41501
41939
|
"description" : "information sdubmitted to the sellability service so as to make a sellability decision"
|
|
41940
|
+
}, {
|
|
41941
|
+
"name" : "product_sellability_result",
|
|
41942
|
+
"plural" : "product_sellability_results",
|
|
41943
|
+
"fields" : [ {
|
|
41944
|
+
"name" : "merchant_id",
|
|
41945
|
+
"type" : "string",
|
|
41946
|
+
"required" : false,
|
|
41947
|
+
"attributes" : [ ],
|
|
41948
|
+
"annotations" : [ ],
|
|
41949
|
+
"description" : "The external merchant ID."
|
|
41950
|
+
}, {
|
|
41951
|
+
"name" : "product_id",
|
|
41952
|
+
"type" : "string",
|
|
41953
|
+
"required" : true,
|
|
41954
|
+
"attributes" : [ ],
|
|
41955
|
+
"annotations" : [ ],
|
|
41956
|
+
"description" : "The external product ID."
|
|
41957
|
+
}, {
|
|
41958
|
+
"name" : "restricted_regions",
|
|
41959
|
+
"type" : "[sellability_restricted_region]",
|
|
41960
|
+
"required" : true,
|
|
41961
|
+
"attributes" : [ ],
|
|
41962
|
+
"annotations" : [ ],
|
|
41963
|
+
"description" : "List of regions where the product is restricted, grouped by type with reasons."
|
|
41964
|
+
}, {
|
|
41965
|
+
"name" : "needs_action_attributes",
|
|
41966
|
+
"type" : "[sellability_needs_action_attributes]",
|
|
41967
|
+
"required" : false,
|
|
41968
|
+
"attributes" : [ ],
|
|
41969
|
+
"annotations" : [ ],
|
|
41970
|
+
"description" : "List of attributes that can be actioned to potentially change restriction status."
|
|
41971
|
+
}, {
|
|
41972
|
+
"name" : "request_id",
|
|
41973
|
+
"type" : "string",
|
|
41974
|
+
"required" : false,
|
|
41975
|
+
"attributes" : [ ],
|
|
41976
|
+
"annotations" : [ ],
|
|
41977
|
+
"description" : "Unique identifier for sellability screening request."
|
|
41978
|
+
}, {
|
|
41979
|
+
"name" : "hs6_code",
|
|
41980
|
+
"type" : "string",
|
|
41981
|
+
"required" : false,
|
|
41982
|
+
"attributes" : [ ],
|
|
41983
|
+
"annotations" : [ ],
|
|
41984
|
+
"description" : "The HS6 code for the product."
|
|
41985
|
+
} ],
|
|
41986
|
+
"attributes" : [ ],
|
|
41987
|
+
"interfaces" : [ ],
|
|
41988
|
+
"description" : "The sellability screening result for the API response."
|
|
41989
|
+
}, {
|
|
41990
|
+
"name" : "product_sellability_result_deleted",
|
|
41991
|
+
"plural" : "product_sellability_result_deleteds",
|
|
41992
|
+
"fields" : [ {
|
|
41993
|
+
"name" : "event_id",
|
|
41994
|
+
"type" : "string",
|
|
41995
|
+
"required" : true,
|
|
41996
|
+
"attributes" : [ ],
|
|
41997
|
+
"annotations" : [ ]
|
|
41998
|
+
}, {
|
|
41999
|
+
"name" : "timestamp",
|
|
42000
|
+
"type" : "date-time-iso8601",
|
|
42001
|
+
"required" : true,
|
|
42002
|
+
"attributes" : [ ],
|
|
42003
|
+
"annotations" : [ ]
|
|
42004
|
+
}, {
|
|
42005
|
+
"name" : "organization",
|
|
42006
|
+
"type" : "string",
|
|
42007
|
+
"required" : true,
|
|
42008
|
+
"attributes" : [ ],
|
|
42009
|
+
"annotations" : [ ],
|
|
42010
|
+
"description" : "Refers to your organization's account identifier"
|
|
42011
|
+
}, {
|
|
42012
|
+
"name" : "id",
|
|
42013
|
+
"type" : "string",
|
|
42014
|
+
"required" : true,
|
|
42015
|
+
"attributes" : [ ],
|
|
42016
|
+
"annotations" : [ ],
|
|
42017
|
+
"description" : "Globally unique identifier"
|
|
42018
|
+
} ],
|
|
42019
|
+
"attributes" : [ ],
|
|
42020
|
+
"interfaces" : [ ]
|
|
42021
|
+
}, {
|
|
42022
|
+
"name" : "product_sellability_result_upserted",
|
|
42023
|
+
"plural" : "product_sellability_result_upserteds",
|
|
42024
|
+
"fields" : [ {
|
|
42025
|
+
"name" : "event_id",
|
|
42026
|
+
"type" : "string",
|
|
42027
|
+
"required" : true,
|
|
42028
|
+
"attributes" : [ ],
|
|
42029
|
+
"annotations" : [ ]
|
|
42030
|
+
}, {
|
|
42031
|
+
"name" : "timestamp",
|
|
42032
|
+
"type" : "date-time-iso8601",
|
|
42033
|
+
"required" : true,
|
|
42034
|
+
"attributes" : [ ],
|
|
42035
|
+
"annotations" : [ ]
|
|
42036
|
+
}, {
|
|
42037
|
+
"name" : "organization",
|
|
42038
|
+
"type" : "string",
|
|
42039
|
+
"required" : true,
|
|
42040
|
+
"attributes" : [ ],
|
|
42041
|
+
"annotations" : [ ],
|
|
42042
|
+
"description" : "Refers to your organization's account identifier"
|
|
42043
|
+
}, {
|
|
42044
|
+
"name" : "product_sellability_result",
|
|
42045
|
+
"type" : "product_sellability_result",
|
|
42046
|
+
"required" : true,
|
|
42047
|
+
"attributes" : [ ],
|
|
42048
|
+
"annotations" : [ ]
|
|
42049
|
+
} ],
|
|
42050
|
+
"attributes" : [ ],
|
|
42051
|
+
"interfaces" : [ ]
|
|
41502
42052
|
}, {
|
|
41503
42053
|
"name" : "product_taxonomy_category",
|
|
41504
42054
|
"plural" : "product_taxonomy_categories",
|
|
@@ -42624,6 +43174,12 @@
|
|
|
42624
43174
|
"required" : false,
|
|
42625
43175
|
"attributes" : [ ],
|
|
42626
43176
|
"annotations" : [ ]
|
|
43177
|
+
}, {
|
|
43178
|
+
"name" : "commercial_invoice_mode",
|
|
43179
|
+
"type" : "commercial_invoice_mode",
|
|
43180
|
+
"required" : false,
|
|
43181
|
+
"attributes" : [ ],
|
|
43182
|
+
"annotations" : [ ]
|
|
42627
43183
|
} ],
|
|
42628
43184
|
"attributes" : [ ],
|
|
42629
43185
|
"interfaces" : [ ]
|
|
@@ -45534,55 +46090,6 @@
|
|
|
45534
46090
|
} ],
|
|
45535
46091
|
"attributes" : [ ],
|
|
45536
46092
|
"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
46093
|
}, {
|
|
45587
46094
|
"name" : "romanization",
|
|
45588
46095
|
"plural" : "romanizations",
|
|
@@ -45680,55 +46187,6 @@
|
|
|
45680
46187
|
} ],
|
|
45681
46188
|
"attributes" : [ ],
|
|
45682
46189
|
"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
46190
|
}, {
|
|
45733
46191
|
"name" : "schedule",
|
|
45734
46192
|
"plural" : "schedules",
|
|
@@ -45973,6 +46431,27 @@
|
|
|
45973
46431
|
} ],
|
|
45974
46432
|
"attributes" : [ ],
|
|
45975
46433
|
"interfaces" : [ ]
|
|
46434
|
+
}, {
|
|
46435
|
+
"name" : "self_billing_agreement",
|
|
46436
|
+
"plural" : "self_billing_agreements",
|
|
46437
|
+
"fields" : [ {
|
|
46438
|
+
"name" : "effective_at",
|
|
46439
|
+
"type" : "date-time-iso8601",
|
|
46440
|
+
"required" : true,
|
|
46441
|
+
"attributes" : [ ],
|
|
46442
|
+
"annotations" : [ ],
|
|
46443
|
+
"description" : "Timestamp of when the self-billing invoice agreement was signed by the merchant"
|
|
46444
|
+
}, {
|
|
46445
|
+
"name" : "expires_at",
|
|
46446
|
+
"type" : "date-time-iso8601",
|
|
46447
|
+
"required" : true,
|
|
46448
|
+
"attributes" : [ ],
|
|
46449
|
+
"annotations" : [ ],
|
|
46450
|
+
"description" : "Expiration date of the self-billing agreement. Default is 24 months from effective_at if not specified."
|
|
46451
|
+
} ],
|
|
46452
|
+
"attributes" : [ ],
|
|
46453
|
+
"interfaces" : [ ],
|
|
46454
|
+
"description" : "Details of the self-billing invoice agreement (mandate) signed by the merchant. Required for B2B self-bill invoicing."
|
|
45976
46455
|
}, {
|
|
45977
46456
|
"name" : "sellability_error",
|
|
45978
46457
|
"plural" : "sellability_errors",
|
|
@@ -45998,6 +46477,213 @@
|
|
|
45998
46477
|
} ],
|
|
45999
46478
|
"interfaces" : [ ],
|
|
46000
46479
|
"description" : "Returns information as to why a sellability response could not be served."
|
|
46480
|
+
}, {
|
|
46481
|
+
"name" : "sellability_needs_action_attributes",
|
|
46482
|
+
"plural" : "sellability_needs_action_attributes",
|
|
46483
|
+
"fields" : [ {
|
|
46484
|
+
"name" : "reason_code",
|
|
46485
|
+
"type" : "string",
|
|
46486
|
+
"required" : true,
|
|
46487
|
+
"attributes" : [ ],
|
|
46488
|
+
"annotations" : [ ],
|
|
46489
|
+
"description" : "Reason code of corresponding restriction rule"
|
|
46490
|
+
}, {
|
|
46491
|
+
"name" : "category_metafield_handles",
|
|
46492
|
+
"type" : "[string]",
|
|
46493
|
+
"required" : true,
|
|
46494
|
+
"attributes" : [ ],
|
|
46495
|
+
"annotations" : [ ],
|
|
46496
|
+
"description" : "List of metafield handles that can be set to influence restriction review."
|
|
46497
|
+
}, {
|
|
46498
|
+
"name" : "require_msds",
|
|
46499
|
+
"type" : "boolean",
|
|
46500
|
+
"required" : false,
|
|
46501
|
+
"attributes" : [ ],
|
|
46502
|
+
"annotations" : [ ],
|
|
46503
|
+
"description" : "If true, restriction can be lifted after review of MSDS doc"
|
|
46504
|
+
} ],
|
|
46505
|
+
"attributes" : [ ],
|
|
46506
|
+
"interfaces" : [ ]
|
|
46507
|
+
}, {
|
|
46508
|
+
"name" : "sellability_region_result",
|
|
46509
|
+
"plural" : "sellability_region_results",
|
|
46510
|
+
"fields" : [ {
|
|
46511
|
+
"name" : "type",
|
|
46512
|
+
"type" : "rule_effect_type",
|
|
46513
|
+
"required" : true,
|
|
46514
|
+
"attributes" : [ ],
|
|
46515
|
+
"annotations" : [ ]
|
|
46516
|
+
}, {
|
|
46517
|
+
"name" : "regions",
|
|
46518
|
+
"type" : "[string]",
|
|
46519
|
+
"required" : true,
|
|
46520
|
+
"attributes" : [ ],
|
|
46521
|
+
"annotations" : [ ],
|
|
46522
|
+
"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"
|
|
46523
|
+
} ],
|
|
46524
|
+
"attributes" : [ ],
|
|
46525
|
+
"interfaces" : [ ],
|
|
46526
|
+
"description" : "The product information we should return to client for sellability result"
|
|
46527
|
+
}, {
|
|
46528
|
+
"name" : "sellability_region_with_reasons",
|
|
46529
|
+
"plural" : "sellability_region_with_reasonses",
|
|
46530
|
+
"fields" : [ {
|
|
46531
|
+
"name" : "region",
|
|
46532
|
+
"type" : "string",
|
|
46533
|
+
"required" : true,
|
|
46534
|
+
"attributes" : [ ],
|
|
46535
|
+
"annotations" : [ ],
|
|
46536
|
+
"description" : "Region code (ISO 3166-1 alpha-3)."
|
|
46537
|
+
}, {
|
|
46538
|
+
"name" : "reasons",
|
|
46539
|
+
"type" : "[string]",
|
|
46540
|
+
"required" : true,
|
|
46541
|
+
"attributes" : [ ],
|
|
46542
|
+
"annotations" : [ ],
|
|
46543
|
+
"description" : "List of rule names causing the restriction."
|
|
46544
|
+
} ],
|
|
46545
|
+
"attributes" : [ ],
|
|
46546
|
+
"interfaces" : [ ],
|
|
46547
|
+
"description" : "A region with the reasons for its restriction."
|
|
46548
|
+
}, {
|
|
46549
|
+
"name" : "sellability_restricted_region",
|
|
46550
|
+
"plural" : "sellability_restricted_regions",
|
|
46551
|
+
"fields" : [ {
|
|
46552
|
+
"name" : "type",
|
|
46553
|
+
"type" : "rule_effect_type",
|
|
46554
|
+
"required" : true,
|
|
46555
|
+
"attributes" : [ ],
|
|
46556
|
+
"annotations" : [ ],
|
|
46557
|
+
"description" : "The type of restriction."
|
|
46558
|
+
}, {
|
|
46559
|
+
"name" : "regions_with_reasons",
|
|
46560
|
+
"type" : "[sellability_region_with_reasons]",
|
|
46561
|
+
"required" : true,
|
|
46562
|
+
"attributes" : [ ],
|
|
46563
|
+
"annotations" : [ ],
|
|
46564
|
+
"description" : "Regions with their restriction reasons."
|
|
46565
|
+
} ],
|
|
46566
|
+
"attributes" : [ ],
|
|
46567
|
+
"interfaces" : [ ],
|
|
46568
|
+
"description" : "Regions where the product is restricted, grouped by restriction type."
|
|
46569
|
+
}, {
|
|
46570
|
+
"name" : "sellability_screening",
|
|
46571
|
+
"plural" : "sellability_screenings",
|
|
46572
|
+
"fields" : [ {
|
|
46573
|
+
"name" : "sellability_result",
|
|
46574
|
+
"type" : "product_sellability_result",
|
|
46575
|
+
"required" : false,
|
|
46576
|
+
"attributes" : [ ],
|
|
46577
|
+
"annotations" : [ ],
|
|
46578
|
+
"description" : "The sellability screening result. Present only when status is 'succeeded'."
|
|
46579
|
+
}, {
|
|
46580
|
+
"name" : "request_id",
|
|
46581
|
+
"type" : "string",
|
|
46582
|
+
"required" : true,
|
|
46583
|
+
"attributes" : [ ],
|
|
46584
|
+
"annotations" : [ ],
|
|
46585
|
+
"description" : "Unique identifier for sellability screening request."
|
|
46586
|
+
}, {
|
|
46587
|
+
"name" : "status",
|
|
46588
|
+
"type" : "sellability_result_status",
|
|
46589
|
+
"required" : true,
|
|
46590
|
+
"attributes" : [ ],
|
|
46591
|
+
"annotations" : [ ],
|
|
46592
|
+
"description" : "Current status of the screening request."
|
|
46593
|
+
}, {
|
|
46594
|
+
"name" : "error_code",
|
|
46595
|
+
"type" : "sellability_result_error_code",
|
|
46596
|
+
"required" : false,
|
|
46597
|
+
"attributes" : [ ],
|
|
46598
|
+
"annotations" : [ ],
|
|
46599
|
+
"description" : "Error code if the request failed."
|
|
46600
|
+
}, {
|
|
46601
|
+
"name" : "error_message",
|
|
46602
|
+
"type" : "string",
|
|
46603
|
+
"required" : false,
|
|
46604
|
+
"attributes" : [ ],
|
|
46605
|
+
"annotations" : [ ],
|
|
46606
|
+
"description" : "Human-readable error message if the request failed."
|
|
46607
|
+
} ],
|
|
46608
|
+
"attributes" : [ ],
|
|
46609
|
+
"interfaces" : [ ],
|
|
46610
|
+
"description" : "Result from the sellability screening API."
|
|
46611
|
+
}, {
|
|
46612
|
+
"name" : "sellability_screening_form",
|
|
46613
|
+
"plural" : "sellability_screening_forms",
|
|
46614
|
+
"fields" : [ {
|
|
46615
|
+
"name" : "merchant_id",
|
|
46616
|
+
"type" : "string",
|
|
46617
|
+
"required" : true,
|
|
46618
|
+
"attributes" : [ ],
|
|
46619
|
+
"annotations" : [ ],
|
|
46620
|
+
"description" : "The external merchant ID."
|
|
46621
|
+
}, {
|
|
46622
|
+
"name" : "product_id",
|
|
46623
|
+
"type" : "string",
|
|
46624
|
+
"required" : true,
|
|
46625
|
+
"attributes" : [ ],
|
|
46626
|
+
"annotations" : [ ],
|
|
46627
|
+
"description" : "The product ID."
|
|
46628
|
+
}, {
|
|
46629
|
+
"name" : "name",
|
|
46630
|
+
"type" : "string",
|
|
46631
|
+
"required" : true,
|
|
46632
|
+
"attributes" : [ ],
|
|
46633
|
+
"annotations" : [ ],
|
|
46634
|
+
"description" : "The name of the product."
|
|
46635
|
+
}, {
|
|
46636
|
+
"name" : "price",
|
|
46637
|
+
"type" : "money",
|
|
46638
|
+
"required" : true,
|
|
46639
|
+
"attributes" : [ ],
|
|
46640
|
+
"annotations" : [ ],
|
|
46641
|
+
"description" : "The price of the product (should be the price of the highest value variant where variants differ in price)."
|
|
46642
|
+
}, {
|
|
46643
|
+
"name" : "description",
|
|
46644
|
+
"type" : "string",
|
|
46645
|
+
"required" : true,
|
|
46646
|
+
"attributes" : [ ],
|
|
46647
|
+
"annotations" : [ ],
|
|
46648
|
+
"description" : "The product description."
|
|
46649
|
+
}, {
|
|
46650
|
+
"name" : "taxonomy_category",
|
|
46651
|
+
"type" : "product_taxonomy_category",
|
|
46652
|
+
"required" : true,
|
|
46653
|
+
"attributes" : [ ],
|
|
46654
|
+
"annotations" : [ ]
|
|
46655
|
+
}, {
|
|
46656
|
+
"name" : "mode",
|
|
46657
|
+
"type" : "sellability_screening_mode",
|
|
46658
|
+
"required" : true,
|
|
46659
|
+
"attributes" : [ ],
|
|
46660
|
+
"annotations" : [ ],
|
|
46661
|
+
"description" : "The sellability screening mode."
|
|
46662
|
+
}, {
|
|
46663
|
+
"name" : "catalog_size",
|
|
46664
|
+
"type" : "integer",
|
|
46665
|
+
"required" : false,
|
|
46666
|
+
"attributes" : [ ],
|
|
46667
|
+
"annotations" : [ ],
|
|
46668
|
+
"description" : "Total number of products in the merchant's catalog."
|
|
46669
|
+
}, {
|
|
46670
|
+
"name" : "relative_ranking",
|
|
46671
|
+
"type" : "decimal",
|
|
46672
|
+
"required" : false,
|
|
46673
|
+
"attributes" : [ ],
|
|
46674
|
+
"annotations" : [ ],
|
|
46675
|
+
"description" : "Product ranking by value within the catalog (sales percentage)."
|
|
46676
|
+
}, {
|
|
46677
|
+
"name" : "dry_run",
|
|
46678
|
+
"type" : "boolean",
|
|
46679
|
+
"required" : false,
|
|
46680
|
+
"attributes" : [ ],
|
|
46681
|
+
"annotations" : [ ],
|
|
46682
|
+
"description" : "Internal flag which is used without any db operation"
|
|
46683
|
+
} ],
|
|
46684
|
+
"attributes" : [ ],
|
|
46685
|
+
"interfaces" : [ ],
|
|
46686
|
+
"description" : "Information submitted to the sellability screening service for pre-onboarding or default-on screening."
|
|
46001
46687
|
}, {
|
|
46002
46688
|
"name" : "sellablility_region_result",
|
|
46003
46689
|
"plural" : "sellablility_region_results",
|
|
@@ -46017,7 +46703,10 @@
|
|
|
46017
46703
|
} ],
|
|
46018
46704
|
"attributes" : [ ],
|
|
46019
46705
|
"interfaces" : [ ],
|
|
46020
|
-
"description" : "
|
|
46706
|
+
"description" : "DEPRECATED: Use sellability_region_result instead. This model exists for backwards compatibility only.",
|
|
46707
|
+
"deprecation" : {
|
|
46708
|
+
"description" : "Use sellability_region_result instead"
|
|
46709
|
+
}
|
|
46021
46710
|
}, {
|
|
46022
46711
|
"name" : "service_reference",
|
|
46023
46712
|
"plural" : "service_references",
|
|
@@ -47850,6 +48539,209 @@
|
|
|
47850
48539
|
} ],
|
|
47851
48540
|
"attributes" : [ ],
|
|
47852
48541
|
"interfaces" : [ ]
|
|
48542
|
+
}, {
|
|
48543
|
+
"name" : "shipping_rate_estimate",
|
|
48544
|
+
"plural" : "shipping_rate_estimates",
|
|
48545
|
+
"fields" : [ {
|
|
48546
|
+
"name" : "origin_address",
|
|
48547
|
+
"type" : "address",
|
|
48548
|
+
"required" : true,
|
|
48549
|
+
"attributes" : [ ],
|
|
48550
|
+
"annotations" : [ "personal_data" ],
|
|
48551
|
+
"description" : "Origin address used for the estimates"
|
|
48552
|
+
}, {
|
|
48553
|
+
"name" : "destination_address",
|
|
48554
|
+
"type" : "address",
|
|
48555
|
+
"required" : true,
|
|
48556
|
+
"attributes" : [ ],
|
|
48557
|
+
"annotations" : [ "personal_data", "consumer" ],
|
|
48558
|
+
"description" : "Destination address used for the estimates"
|
|
48559
|
+
}, {
|
|
48560
|
+
"name" : "shipping_date_time",
|
|
48561
|
+
"type" : "date-time-iso8601",
|
|
48562
|
+
"required" : true,
|
|
48563
|
+
"attributes" : [ ],
|
|
48564
|
+
"annotations" : [ ],
|
|
48565
|
+
"description" : "The shipping date/time used to calculate the estimates"
|
|
48566
|
+
}, {
|
|
48567
|
+
"name" : "services",
|
|
48568
|
+
"type" : "[string]",
|
|
48569
|
+
"required" : true,
|
|
48570
|
+
"attributes" : [ ],
|
|
48571
|
+
"annotations" : [ ],
|
|
48572
|
+
"description" : "Carrier service IDs configured for this channel. See https://api.flow.io/reference/carrier/services for details."
|
|
48573
|
+
}, {
|
|
48574
|
+
"name" : "available",
|
|
48575
|
+
"type" : "[shipping_rate_estimate_available]",
|
|
48576
|
+
"required" : true,
|
|
48577
|
+
"attributes" : [ ],
|
|
48578
|
+
"annotations" : [ ],
|
|
48579
|
+
"description" : "Successfully calculated shipping rate estimates"
|
|
48580
|
+
}, {
|
|
48581
|
+
"name" : "unavailable",
|
|
48582
|
+
"type" : "[shipping_rate_estimate_unavailable]",
|
|
48583
|
+
"required" : false,
|
|
48584
|
+
"attributes" : [ ],
|
|
48585
|
+
"annotations" : [ ],
|
|
48586
|
+
"description" : "Estimates that could not be calculated, with per-service failure reasons"
|
|
48587
|
+
} ],
|
|
48588
|
+
"attributes" : [ ],
|
|
48589
|
+
"interfaces" : [ ],
|
|
48590
|
+
"description" : "Response containing shipping rate estimate results"
|
|
48591
|
+
}, {
|
|
48592
|
+
"name" : "shipping_rate_estimate_available",
|
|
48593
|
+
"plural" : "shipping_rate_estimate_availables",
|
|
48594
|
+
"fields" : [ {
|
|
48595
|
+
"name" : "service",
|
|
48596
|
+
"type" : "ratecard_service_summary",
|
|
48597
|
+
"required" : true,
|
|
48598
|
+
"attributes" : [ ],
|
|
48599
|
+
"annotations" : [ ],
|
|
48600
|
+
"description" : "Carrier service"
|
|
48601
|
+
}, {
|
|
48602
|
+
"name" : "delivered_duty",
|
|
48603
|
+
"type" : "delivered_duty",
|
|
48604
|
+
"required" : true,
|
|
48605
|
+
"attributes" : [ ],
|
|
48606
|
+
"annotations" : [ ],
|
|
48607
|
+
"description" : "DDP or DDU"
|
|
48608
|
+
}, {
|
|
48609
|
+
"name" : "shipment_window",
|
|
48610
|
+
"type" : "shipment_window",
|
|
48611
|
+
"required" : true,
|
|
48612
|
+
"attributes" : [ ],
|
|
48613
|
+
"annotations" : [ ],
|
|
48614
|
+
"description" : "Represents min/max days of transit time for a shipment in this estimate"
|
|
48615
|
+
}, {
|
|
48616
|
+
"name" : "total_amount",
|
|
48617
|
+
"type" : "money",
|
|
48618
|
+
"required" : true,
|
|
48619
|
+
"attributes" : [ ],
|
|
48620
|
+
"annotations" : [ ],
|
|
48621
|
+
"description" : "Total shipping cost (base + fees)"
|
|
48622
|
+
}, {
|
|
48623
|
+
"name" : "base_amount",
|
|
48624
|
+
"type" : "money",
|
|
48625
|
+
"required" : true,
|
|
48626
|
+
"attributes" : [ ],
|
|
48627
|
+
"annotations" : [ ],
|
|
48628
|
+
"description" : "Base shipping amount before fees"
|
|
48629
|
+
}, {
|
|
48630
|
+
"name" : "fees",
|
|
48631
|
+
"type" : "[ratecard_fee]",
|
|
48632
|
+
"required" : true,
|
|
48633
|
+
"attributes" : [ ],
|
|
48634
|
+
"annotations" : [ ],
|
|
48635
|
+
"description" : "Itemized fees"
|
|
48636
|
+
}, {
|
|
48637
|
+
"name" : "dimensional_weight",
|
|
48638
|
+
"type" : "measurement",
|
|
48639
|
+
"required" : false,
|
|
48640
|
+
"attributes" : [ ],
|
|
48641
|
+
"annotations" : [ ],
|
|
48642
|
+
"description" : "Estimated dimensional weight (length x width x depth / dim factor)."
|
|
48643
|
+
}, {
|
|
48644
|
+
"name" : "gravitational_weight",
|
|
48645
|
+
"type" : "measurement",
|
|
48646
|
+
"required" : false,
|
|
48647
|
+
"attributes" : [ ],
|
|
48648
|
+
"annotations" : [ ],
|
|
48649
|
+
"description" : "Estimated gravitational weight (actual physical weight)."
|
|
48650
|
+
}, {
|
|
48651
|
+
"name" : "weight_break",
|
|
48652
|
+
"type" : "decimal",
|
|
48653
|
+
"required" : false,
|
|
48654
|
+
"attributes" : [ ],
|
|
48655
|
+
"annotations" : [ ],
|
|
48656
|
+
"description" : "Weight corresponding to the rate used to calculate the amount."
|
|
48657
|
+
} ],
|
|
48658
|
+
"attributes" : [ ],
|
|
48659
|
+
"interfaces" : [ ],
|
|
48660
|
+
"description" : "A successfully calculated shipping rate estimate"
|
|
48661
|
+
}, {
|
|
48662
|
+
"name" : "shipping_rate_estimate_request",
|
|
48663
|
+
"plural" : "shipping_rate_estimate_requests",
|
|
48664
|
+
"fields" : [ {
|
|
48665
|
+
"name" : "origin_address",
|
|
48666
|
+
"type" : "address",
|
|
48667
|
+
"required" : true,
|
|
48668
|
+
"attributes" : [ ],
|
|
48669
|
+
"annotations" : [ "personal_data" ],
|
|
48670
|
+
"description" : "Origin address"
|
|
48671
|
+
}, {
|
|
48672
|
+
"name" : "destination_address",
|
|
48673
|
+
"type" : "address",
|
|
48674
|
+
"required" : true,
|
|
48675
|
+
"attributes" : [ ],
|
|
48676
|
+
"annotations" : [ "personal_data", "consumer" ],
|
|
48677
|
+
"description" : "Destination address"
|
|
48678
|
+
}, {
|
|
48679
|
+
"name" : "package_dimensions",
|
|
48680
|
+
"type" : "dimension",
|
|
48681
|
+
"required" : true,
|
|
48682
|
+
"attributes" : [ ],
|
|
48683
|
+
"annotations" : [ ],
|
|
48684
|
+
"description" : "Physical dimensions and weight of the package being shipped"
|
|
48685
|
+
}, {
|
|
48686
|
+
"name" : "shipping_date_time",
|
|
48687
|
+
"type" : "date-time-iso8601",
|
|
48688
|
+
"required" : true,
|
|
48689
|
+
"attributes" : [ ],
|
|
48690
|
+
"annotations" : [ ],
|
|
48691
|
+
"description" : "The datetime the shipment is expected to be dispatched. Used for rate effectiveness, fee windows, and transit time calculation."
|
|
48692
|
+
}, {
|
|
48693
|
+
"name" : "delivered_duty",
|
|
48694
|
+
"type" : "delivered_duty",
|
|
48695
|
+
"required" : false,
|
|
48696
|
+
"attributes" : [ ],
|
|
48697
|
+
"annotations" : [ ],
|
|
48698
|
+
"description" : "DDP or DDU. If omitted, returns estimates for all available duty types."
|
|
48699
|
+
}, {
|
|
48700
|
+
"name" : "duties_owed",
|
|
48701
|
+
"type" : "money",
|
|
48702
|
+
"required" : false,
|
|
48703
|
+
"attributes" : [ ],
|
|
48704
|
+
"annotations" : [ ],
|
|
48705
|
+
"description" : "Duties owed, if known. Used for DTP surcharge calculation on DDP shipments."
|
|
48706
|
+
}, {
|
|
48707
|
+
"name" : "taxes_owed",
|
|
48708
|
+
"type" : "money",
|
|
48709
|
+
"required" : false,
|
|
48710
|
+
"attributes" : [ ],
|
|
48711
|
+
"annotations" : [ ],
|
|
48712
|
+
"description" : "Taxes owed, if known. Used for DTP surcharge calculation."
|
|
48713
|
+
}, {
|
|
48714
|
+
"name" : "line_items",
|
|
48715
|
+
"type" : "[line_item_form]",
|
|
48716
|
+
"required" : false,
|
|
48717
|
+
"attributes" : [ ],
|
|
48718
|
+
"annotations" : [ ],
|
|
48719
|
+
"description" : "Line items in the shipment. Used for security fee and EEI filing fee calculation."
|
|
48720
|
+
} ],
|
|
48721
|
+
"attributes" : [ ],
|
|
48722
|
+
"interfaces" : [ ],
|
|
48723
|
+
"description" : "Request for shipping rate estimates"
|
|
48724
|
+
}, {
|
|
48725
|
+
"name" : "shipping_rate_estimate_unavailable",
|
|
48726
|
+
"plural" : "shipping_rate_estimate_unavailables",
|
|
48727
|
+
"fields" : [ {
|
|
48728
|
+
"name" : "service",
|
|
48729
|
+
"type" : "string",
|
|
48730
|
+
"required" : true,
|
|
48731
|
+
"attributes" : [ ],
|
|
48732
|
+
"annotations" : [ ],
|
|
48733
|
+
"description" : "Carrier service ID that was requested. See https://api.flow.io/reference/carrier/services for valid values."
|
|
48734
|
+
}, {
|
|
48735
|
+
"name" : "reason",
|
|
48736
|
+
"type" : "string",
|
|
48737
|
+
"required" : true,
|
|
48738
|
+
"attributes" : [ ],
|
|
48739
|
+
"annotations" : [ ],
|
|
48740
|
+
"description" : "Why the estimate is unavailable"
|
|
48741
|
+
} ],
|
|
48742
|
+
"attributes" : [ ],
|
|
48743
|
+
"interfaces" : [ ],
|
|
48744
|
+
"description" : "A carrier service for which a shipping rate estimate could not be calculated, including the reason for failure"
|
|
47853
48745
|
}, {
|
|
47854
48746
|
"name" : "shop",
|
|
47855
48747
|
"plural" : "shops",
|
|
@@ -48839,6 +49731,12 @@
|
|
|
48839
49731
|
"required" : false,
|
|
48840
49732
|
"attributes" : [ ],
|
|
48841
49733
|
"annotations" : [ ]
|
|
49734
|
+
}, {
|
|
49735
|
+
"name" : "average_order_weight_unit",
|
|
49736
|
+
"type" : "unit_of_measurement",
|
|
49737
|
+
"required" : false,
|
|
49738
|
+
"attributes" : [ ],
|
|
49739
|
+
"annotations" : [ ]
|
|
48842
49740
|
}, {
|
|
48843
49741
|
"name" : "package_dimensions",
|
|
48844
49742
|
"type" : "[dimension]",
|
|
@@ -49038,6 +49936,12 @@
|
|
|
49038
49936
|
"required" : false,
|
|
49039
49937
|
"attributes" : [ ],
|
|
49040
49938
|
"annotations" : [ ]
|
|
49939
|
+
}, {
|
|
49940
|
+
"name" : "average_order_weight_unit",
|
|
49941
|
+
"type" : "unit_of_measurement",
|
|
49942
|
+
"required" : false,
|
|
49943
|
+
"attributes" : [ ],
|
|
49944
|
+
"annotations" : [ ]
|
|
49041
49945
|
}, {
|
|
49042
49946
|
"name" : "package_dimensions",
|
|
49043
49947
|
"type" : "[dimension]",
|
|
@@ -49689,6 +50593,24 @@
|
|
|
49689
50593
|
} ],
|
|
49690
50594
|
"attributes" : [ ],
|
|
49691
50595
|
"interfaces" : [ ]
|
|
50596
|
+
}, {
|
|
50597
|
+
"name" : "statement_status_form",
|
|
50598
|
+
"plural" : "statement_status_forms",
|
|
50599
|
+
"fields" : [ {
|
|
50600
|
+
"name" : "code",
|
|
50601
|
+
"type" : "statement_status_code",
|
|
50602
|
+
"required" : true,
|
|
50603
|
+
"attributes" : [ ],
|
|
50604
|
+
"annotations" : [ ]
|
|
50605
|
+
}, {
|
|
50606
|
+
"name" : "failure_reason",
|
|
50607
|
+
"type" : "payout_status_failure_code",
|
|
50608
|
+
"required" : false,
|
|
50609
|
+
"attributes" : [ ],
|
|
50610
|
+
"annotations" : [ ]
|
|
50611
|
+
} ],
|
|
50612
|
+
"attributes" : [ ],
|
|
50613
|
+
"interfaces" : [ ]
|
|
49692
50614
|
}, {
|
|
49693
50615
|
"name" : "statement_upserted",
|
|
49694
50616
|
"plural" : "statement_upserteds",
|
|
@@ -51004,6 +51926,78 @@
|
|
|
51004
51926
|
"attributes" : [ ],
|
|
51005
51927
|
"interfaces" : [ ],
|
|
51006
51928
|
"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."
|
|
51929
|
+
}, {
|
|
51930
|
+
"name" : "tax_registration_deleted",
|
|
51931
|
+
"plural" : "tax_registration_deleteds",
|
|
51932
|
+
"fields" : [ {
|
|
51933
|
+
"name" : "event_id",
|
|
51934
|
+
"type" : "string",
|
|
51935
|
+
"required" : true,
|
|
51936
|
+
"attributes" : [ ],
|
|
51937
|
+
"annotations" : [ ]
|
|
51938
|
+
}, {
|
|
51939
|
+
"name" : "timestamp",
|
|
51940
|
+
"type" : "date-time-iso8601",
|
|
51941
|
+
"required" : true,
|
|
51942
|
+
"attributes" : [ ],
|
|
51943
|
+
"annotations" : [ ]
|
|
51944
|
+
}, {
|
|
51945
|
+
"name" : "organization",
|
|
51946
|
+
"type" : "string",
|
|
51947
|
+
"required" : true,
|
|
51948
|
+
"attributes" : [ ],
|
|
51949
|
+
"annotations" : [ ],
|
|
51950
|
+
"description" : "Refers to your organization's account identifier"
|
|
51951
|
+
}, {
|
|
51952
|
+
"name" : "id",
|
|
51953
|
+
"type" : "string",
|
|
51954
|
+
"required" : true,
|
|
51955
|
+
"attributes" : [ ],
|
|
51956
|
+
"annotations" : [ ],
|
|
51957
|
+
"description" : "Globally unique identifier"
|
|
51958
|
+
} ],
|
|
51959
|
+
"attributes" : [ ],
|
|
51960
|
+
"interfaces" : [ ],
|
|
51961
|
+
"description" : "Tax Registration deleted"
|
|
51962
|
+
}, {
|
|
51963
|
+
"name" : "tax_registration_detail",
|
|
51964
|
+
"plural" : "tax_registration_details",
|
|
51965
|
+
"fields" : [ {
|
|
51966
|
+
"name" : "tax_number",
|
|
51967
|
+
"type" : "string",
|
|
51968
|
+
"required" : true,
|
|
51969
|
+
"attributes" : [ ],
|
|
51970
|
+
"annotations" : [ ],
|
|
51971
|
+
"description" : "The merchant's tax registration number/ID for this jurisdiction",
|
|
51972
|
+
"example" : "123456789RT0001"
|
|
51973
|
+
}, {
|
|
51974
|
+
"name" : "country",
|
|
51975
|
+
"type" : "string",
|
|
51976
|
+
"required" : true,
|
|
51977
|
+
"attributes" : [ ],
|
|
51978
|
+
"annotations" : [ ],
|
|
51979
|
+
"description" : "ISO 3166-1 alpha-3 country code where this tax registration applies",
|
|
51980
|
+
"example" : "CAN"
|
|
51981
|
+
}, {
|
|
51982
|
+
"name" : "tax_code",
|
|
51983
|
+
"type" : "string",
|
|
51984
|
+
"required" : true,
|
|
51985
|
+
"attributes" : [ ],
|
|
51986
|
+
"annotations" : [ ],
|
|
51987
|
+
"description" : "Tax authority code identifying the type of tax (e.g., CA_GST, CA_QST, CA_PST_BC, GB_VAT)",
|
|
51988
|
+
"example" : "CA_GST"
|
|
51989
|
+
}, {
|
|
51990
|
+
"name" : "province",
|
|
51991
|
+
"type" : "string",
|
|
51992
|
+
"required" : false,
|
|
51993
|
+
"attributes" : [ ],
|
|
51994
|
+
"annotations" : [ ],
|
|
51995
|
+
"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.",
|
|
51996
|
+
"example" : "QC"
|
|
51997
|
+
} ],
|
|
51998
|
+
"attributes" : [ ],
|
|
51999
|
+
"interfaces" : [ ],
|
|
52000
|
+
"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
52001
|
}, {
|
|
51008
52002
|
"name" : "tax_registration_form",
|
|
51009
52003
|
"plural" : "tax_registration_forms",
|
|
@@ -51023,6 +52017,38 @@
|
|
|
51023
52017
|
} ],
|
|
51024
52018
|
"attributes" : [ ],
|
|
51025
52019
|
"interfaces" : [ ]
|
|
52020
|
+
}, {
|
|
52021
|
+
"name" : "tax_registration_upserted",
|
|
52022
|
+
"plural" : "tax_registration_upserteds",
|
|
52023
|
+
"fields" : [ {
|
|
52024
|
+
"name" : "event_id",
|
|
52025
|
+
"type" : "string",
|
|
52026
|
+
"required" : true,
|
|
52027
|
+
"attributes" : [ ],
|
|
52028
|
+
"annotations" : [ ]
|
|
52029
|
+
}, {
|
|
52030
|
+
"name" : "timestamp",
|
|
52031
|
+
"type" : "date-time-iso8601",
|
|
52032
|
+
"required" : true,
|
|
52033
|
+
"attributes" : [ ],
|
|
52034
|
+
"annotations" : [ ]
|
|
52035
|
+
}, {
|
|
52036
|
+
"name" : "organization",
|
|
52037
|
+
"type" : "string",
|
|
52038
|
+
"required" : true,
|
|
52039
|
+
"attributes" : [ ],
|
|
52040
|
+
"annotations" : [ ],
|
|
52041
|
+
"description" : "Refers to your organization's account identifier"
|
|
52042
|
+
}, {
|
|
52043
|
+
"name" : "tax_registration",
|
|
52044
|
+
"type" : "organization_tax_registration",
|
|
52045
|
+
"required" : true,
|
|
52046
|
+
"attributes" : [ ],
|
|
52047
|
+
"annotations" : [ ]
|
|
52048
|
+
} ],
|
|
52049
|
+
"attributes" : [ ],
|
|
52050
|
+
"interfaces" : [ ],
|
|
52051
|
+
"description" : "Tax Registration updated"
|
|
51026
52052
|
}, {
|
|
51027
52053
|
"name" : "tax_report",
|
|
51028
52054
|
"plural" : "tax_reports",
|
|
@@ -52336,6 +53362,120 @@
|
|
|
52336
53362
|
} ],
|
|
52337
53363
|
"attributes" : [ ],
|
|
52338
53364
|
"interfaces" : [ ]
|
|
53365
|
+
}, {
|
|
53366
|
+
"name" : "tracking_label_event_upserted_v2",
|
|
53367
|
+
"plural" : "tracking_label_event_upserted_v2s",
|
|
53368
|
+
"fields" : [ {
|
|
53369
|
+
"name" : "event_id",
|
|
53370
|
+
"type" : "string",
|
|
53371
|
+
"required" : true,
|
|
53372
|
+
"attributes" : [ ],
|
|
53373
|
+
"annotations" : [ ]
|
|
53374
|
+
}, {
|
|
53375
|
+
"name" : "timestamp",
|
|
53376
|
+
"type" : "date-time-iso8601",
|
|
53377
|
+
"required" : true,
|
|
53378
|
+
"attributes" : [ ],
|
|
53379
|
+
"annotations" : [ ]
|
|
53380
|
+
}, {
|
|
53381
|
+
"name" : "organization",
|
|
53382
|
+
"type" : "string",
|
|
53383
|
+
"required" : true,
|
|
53384
|
+
"attributes" : [ ],
|
|
53385
|
+
"annotations" : [ ],
|
|
53386
|
+
"description" : "Refers to your organization's account identifier"
|
|
53387
|
+
}, {
|
|
53388
|
+
"name" : "tracking_label_event",
|
|
53389
|
+
"type" : "tracking_label_event_v2",
|
|
53390
|
+
"required" : true,
|
|
53391
|
+
"attributes" : [ ],
|
|
53392
|
+
"annotations" : [ ]
|
|
53393
|
+
} ],
|
|
53394
|
+
"attributes" : [ ],
|
|
53395
|
+
"interfaces" : [ ]
|
|
53396
|
+
}, {
|
|
53397
|
+
"name" : "tracking_label_event_v2",
|
|
53398
|
+
"plural" : "tracking_label_event_v2s",
|
|
53399
|
+
"fields" : [ {
|
|
53400
|
+
"name" : "id",
|
|
53401
|
+
"type" : "string",
|
|
53402
|
+
"required" : true,
|
|
53403
|
+
"attributes" : [ ],
|
|
53404
|
+
"annotations" : [ ],
|
|
53405
|
+
"description" : "Globally unique identifier"
|
|
53406
|
+
}, {
|
|
53407
|
+
"name" : "carrier_id",
|
|
53408
|
+
"type" : "string",
|
|
53409
|
+
"required" : true,
|
|
53410
|
+
"attributes" : [ ],
|
|
53411
|
+
"annotations" : [ ]
|
|
53412
|
+
}, {
|
|
53413
|
+
"name" : "carrier_tracking_number",
|
|
53414
|
+
"type" : "string",
|
|
53415
|
+
"required" : true,
|
|
53416
|
+
"attributes" : [ ],
|
|
53417
|
+
"annotations" : [ ]
|
|
53418
|
+
}, {
|
|
53419
|
+
"name" : "carrier_tracking_url",
|
|
53420
|
+
"type" : "string",
|
|
53421
|
+
"required" : false,
|
|
53422
|
+
"attributes" : [ ],
|
|
53423
|
+
"annotations" : [ ],
|
|
53424
|
+
"description" : "Full carrier tracking URL for this shipment"
|
|
53425
|
+
}, {
|
|
53426
|
+
"name" : "label_id",
|
|
53427
|
+
"type" : "string",
|
|
53428
|
+
"required" : true,
|
|
53429
|
+
"attributes" : [ ],
|
|
53430
|
+
"annotations" : [ ]
|
|
53431
|
+
}, {
|
|
53432
|
+
"name" : "order_number",
|
|
53433
|
+
"type" : "string",
|
|
53434
|
+
"required" : false,
|
|
53435
|
+
"attributes" : [ ],
|
|
53436
|
+
"annotations" : [ ]
|
|
53437
|
+
}, {
|
|
53438
|
+
"name" : "status",
|
|
53439
|
+
"type" : "tracking_status",
|
|
53440
|
+
"required" : true,
|
|
53441
|
+
"attributes" : [ ],
|
|
53442
|
+
"annotations" : [ ]
|
|
53443
|
+
}, {
|
|
53444
|
+
"name" : "substatus",
|
|
53445
|
+
"type" : "substatus_code",
|
|
53446
|
+
"required" : false,
|
|
53447
|
+
"attributes" : [ ],
|
|
53448
|
+
"annotations" : [ ]
|
|
53449
|
+
}, {
|
|
53450
|
+
"name" : "carrier_timestamp",
|
|
53451
|
+
"type" : "date-time-iso8601",
|
|
53452
|
+
"required" : true,
|
|
53453
|
+
"attributes" : [ ],
|
|
53454
|
+
"annotations" : [ ],
|
|
53455
|
+
"description" : "Actual carrier-reported timestamp for event"
|
|
53456
|
+
}, {
|
|
53457
|
+
"name" : "description",
|
|
53458
|
+
"type" : "string",
|
|
53459
|
+
"required" : false,
|
|
53460
|
+
"attributes" : [ ],
|
|
53461
|
+
"annotations" : [ ]
|
|
53462
|
+
}, {
|
|
53463
|
+
"name" : "delivery_estimate",
|
|
53464
|
+
"type" : "date-time-iso8601",
|
|
53465
|
+
"required" : false,
|
|
53466
|
+
"attributes" : [ ],
|
|
53467
|
+
"annotations" : [ ],
|
|
53468
|
+
"description" : "Carrier-provided delivery estimate when available"
|
|
53469
|
+
}, {
|
|
53470
|
+
"name" : "address",
|
|
53471
|
+
"type" : "address",
|
|
53472
|
+
"required" : false,
|
|
53473
|
+
"attributes" : [ ],
|
|
53474
|
+
"annotations" : [ "personal_data", "consumer" ],
|
|
53475
|
+
"description" : "Location of the label tracking event"
|
|
53476
|
+
} ],
|
|
53477
|
+
"attributes" : [ ],
|
|
53478
|
+
"interfaces" : [ ]
|
|
52339
53479
|
}, {
|
|
52340
53480
|
"name" : "tracking_label_form",
|
|
52341
53481
|
"plural" : "tracking_label_forms",
|
|
@@ -63019,6 +64159,85 @@
|
|
|
63019
64159
|
} ],
|
|
63020
64160
|
"path" : "/:organization/shipping-notifications",
|
|
63021
64161
|
"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."
|
|
64162
|
+
}, {
|
|
64163
|
+
"type" : "shipping_rate_estimate",
|
|
64164
|
+
"plural" : "shipping_rate_estimates",
|
|
64165
|
+
"operations" : [ {
|
|
64166
|
+
"method" : "POST",
|
|
64167
|
+
"path" : "/channel/:channel_id/organization/:organization_id/shipping-rate-estimates",
|
|
64168
|
+
"parameters" : [ {
|
|
64169
|
+
"name" : "channel_id",
|
|
64170
|
+
"type" : "string",
|
|
64171
|
+
"location" : "Path",
|
|
64172
|
+
"required" : true
|
|
64173
|
+
}, {
|
|
64174
|
+
"name" : "organization_id",
|
|
64175
|
+
"type" : "string",
|
|
64176
|
+
"location" : "Path",
|
|
64177
|
+
"required" : true
|
|
64178
|
+
} ],
|
|
64179
|
+
"responses" : [ {
|
|
64180
|
+
"code" : {
|
|
64181
|
+
"integer" : {
|
|
64182
|
+
"value" : 200
|
|
64183
|
+
}
|
|
64184
|
+
},
|
|
64185
|
+
"type" : "shipping_rate_estimate",
|
|
64186
|
+
"description" : "Successful response",
|
|
64187
|
+
"attributes" : [ ]
|
|
64188
|
+
}, {
|
|
64189
|
+
"code" : {
|
|
64190
|
+
"integer" : {
|
|
64191
|
+
"value" : 401
|
|
64192
|
+
}
|
|
64193
|
+
},
|
|
64194
|
+
"type" : "unit",
|
|
64195
|
+
"description" : "Authorization failed",
|
|
64196
|
+
"attributes" : [ ]
|
|
64197
|
+
}, {
|
|
64198
|
+
"code" : {
|
|
64199
|
+
"integer" : {
|
|
64200
|
+
"value" : 403
|
|
64201
|
+
}
|
|
64202
|
+
},
|
|
64203
|
+
"type" : "unit",
|
|
64204
|
+
"attributes" : [ ]
|
|
64205
|
+
}, {
|
|
64206
|
+
"code" : {
|
|
64207
|
+
"integer" : {
|
|
64208
|
+
"value" : 422
|
|
64209
|
+
}
|
|
64210
|
+
},
|
|
64211
|
+
"type" : "generic_error",
|
|
64212
|
+
"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.",
|
|
64213
|
+
"attributes" : [ ]
|
|
64214
|
+
}, {
|
|
64215
|
+
"code" : {
|
|
64216
|
+
"integer" : {
|
|
64217
|
+
"value" : 429
|
|
64218
|
+
}
|
|
64219
|
+
},
|
|
64220
|
+
"type" : "unit",
|
|
64221
|
+
"attributes" : [ ]
|
|
64222
|
+
} ],
|
|
64223
|
+
"attributes" : [ {
|
|
64224
|
+
"name" : "non-crud",
|
|
64225
|
+
"value" : { }
|
|
64226
|
+
} ],
|
|
64227
|
+
"description" : "Get shipping rate estimates. Channel-scoped endpoint with a clean response contract.",
|
|
64228
|
+
"body" : {
|
|
64229
|
+
"type" : "shipping_rate_estimate_request",
|
|
64230
|
+
"attributes" : [ ]
|
|
64231
|
+
}
|
|
64232
|
+
} ],
|
|
64233
|
+
"attributes" : [ {
|
|
64234
|
+
"name" : "docs",
|
|
64235
|
+
"value" : {
|
|
64236
|
+
"module" : "logistics"
|
|
64237
|
+
}
|
|
64238
|
+
} ],
|
|
64239
|
+
"path" : "/channel/:channel_id/organization/:organization_id/shipping-rate-estimates",
|
|
64240
|
+
"description" : "Response containing shipping rate estimate results"
|
|
63022
64241
|
}, {
|
|
63023
64242
|
"type" : "surcharge_setting",
|
|
63024
64243
|
"plural" : "surcharge_settings",
|
|
@@ -68223,6 +69442,63 @@
|
|
|
68223
69442
|
"attributes" : [ ]
|
|
68224
69443
|
} ],
|
|
68225
69444
|
"attributes" : [ ]
|
|
69445
|
+
}, {
|
|
69446
|
+
"method" : "PUT",
|
|
69447
|
+
"path" : "/channel/:channel/billing/statements/:id/status",
|
|
69448
|
+
"parameters" : [ {
|
|
69449
|
+
"name" : "channel",
|
|
69450
|
+
"type" : "string",
|
|
69451
|
+
"location" : "Path",
|
|
69452
|
+
"required" : true
|
|
69453
|
+
}, {
|
|
69454
|
+
"name" : "id",
|
|
69455
|
+
"type" : "string",
|
|
69456
|
+
"location" : "Path",
|
|
69457
|
+
"required" : true,
|
|
69458
|
+
"description" : "Filter by one or more IDs of this resource"
|
|
69459
|
+
} ],
|
|
69460
|
+
"responses" : [ {
|
|
69461
|
+
"code" : {
|
|
69462
|
+
"integer" : {
|
|
69463
|
+
"value" : 200
|
|
69464
|
+
}
|
|
69465
|
+
},
|
|
69466
|
+
"type" : "channel_statement",
|
|
69467
|
+
"description" : "Successful response",
|
|
69468
|
+
"attributes" : [ ]
|
|
69469
|
+
}, {
|
|
69470
|
+
"code" : {
|
|
69471
|
+
"integer" : {
|
|
69472
|
+
"value" : 401
|
|
69473
|
+
}
|
|
69474
|
+
},
|
|
69475
|
+
"type" : "unit",
|
|
69476
|
+
"description" : "Authorization failed",
|
|
69477
|
+
"attributes" : [ ]
|
|
69478
|
+
}, {
|
|
69479
|
+
"code" : {
|
|
69480
|
+
"integer" : {
|
|
69481
|
+
"value" : 404
|
|
69482
|
+
}
|
|
69483
|
+
},
|
|
69484
|
+
"type" : "unit",
|
|
69485
|
+
"description" : "Resource was not found",
|
|
69486
|
+
"attributes" : [ ]
|
|
69487
|
+
}, {
|
|
69488
|
+
"code" : {
|
|
69489
|
+
"integer" : {
|
|
69490
|
+
"value" : 422
|
|
69491
|
+
}
|
|
69492
|
+
},
|
|
69493
|
+
"type" : "generic_error",
|
|
69494
|
+
"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.",
|
|
69495
|
+
"attributes" : [ ]
|
|
69496
|
+
} ],
|
|
69497
|
+
"attributes" : [ ],
|
|
69498
|
+
"body" : {
|
|
69499
|
+
"type" : "statement_status_form",
|
|
69500
|
+
"attributes" : [ ]
|
|
69501
|
+
}
|
|
68226
69502
|
} ],
|
|
68227
69503
|
"attributes" : [ {
|
|
68228
69504
|
"name" : "docs",
|
|
@@ -76632,6 +77908,179 @@
|
|
|
76632
77908
|
} ],
|
|
76633
77909
|
"path" : "/:organization/billing/pending/payout/transactions",
|
|
76634
77910
|
"description" : "A transaction that is pending payout."
|
|
77911
|
+
}, {
|
|
77912
|
+
"type" : "organization_tax_registration",
|
|
77913
|
+
"plural" : "organization_tax_registrations",
|
|
77914
|
+
"operations" : [ {
|
|
77915
|
+
"method" : "GET",
|
|
77916
|
+
"path" : "/organizations/:organization_id/tax/registrations",
|
|
77917
|
+
"parameters" : [ {
|
|
77918
|
+
"name" : "organization_id",
|
|
77919
|
+
"type" : "string",
|
|
77920
|
+
"location" : "Path",
|
|
77921
|
+
"required" : true
|
|
77922
|
+
}, {
|
|
77923
|
+
"name" : "tax_code",
|
|
77924
|
+
"type" : "[string]",
|
|
77925
|
+
"location" : "Query",
|
|
77926
|
+
"required" : false,
|
|
77927
|
+
"description" : "Filter by specific tax codes (e.g., CA_GST, CA_QST)",
|
|
77928
|
+
"maximum" : 100
|
|
77929
|
+
} ],
|
|
77930
|
+
"responses" : [ {
|
|
77931
|
+
"code" : {
|
|
77932
|
+
"integer" : {
|
|
77933
|
+
"value" : 200
|
|
77934
|
+
}
|
|
77935
|
+
},
|
|
77936
|
+
"type" : "[organization_tax_registration]",
|
|
77937
|
+
"description" : "Successful response",
|
|
77938
|
+
"attributes" : [ ]
|
|
77939
|
+
}, {
|
|
77940
|
+
"code" : {
|
|
77941
|
+
"integer" : {
|
|
77942
|
+
"value" : 401
|
|
77943
|
+
}
|
|
77944
|
+
},
|
|
77945
|
+
"type" : "unit",
|
|
77946
|
+
"description" : "Authorization failed",
|
|
77947
|
+
"attributes" : [ ]
|
|
77948
|
+
}, {
|
|
77949
|
+
"code" : {
|
|
77950
|
+
"integer" : {
|
|
77951
|
+
"value" : 404
|
|
77952
|
+
}
|
|
77953
|
+
},
|
|
77954
|
+
"type" : "unit",
|
|
77955
|
+
"description" : "Organization not found or no registrations exist",
|
|
77956
|
+
"attributes" : [ ]
|
|
77957
|
+
} ],
|
|
77958
|
+
"attributes" : [ {
|
|
77959
|
+
"name" : "linter",
|
|
77960
|
+
"value" : {
|
|
77961
|
+
"ignore" : [ "get", "versions", "id", "limit", "offset", "sort" ]
|
|
77962
|
+
}
|
|
77963
|
+
} ],
|
|
77964
|
+
"description" : "Retrieve all active tax registrations and self-billing agreement status for an organization."
|
|
77965
|
+
}, {
|
|
77966
|
+
"method" : "PUT",
|
|
77967
|
+
"path" : "/organizations/:organization_id/tax/registrations/:tax_code",
|
|
77968
|
+
"parameters" : [ {
|
|
77969
|
+
"name" : "organization_id",
|
|
77970
|
+
"type" : "string",
|
|
77971
|
+
"location" : "Path",
|
|
77972
|
+
"required" : true
|
|
77973
|
+
}, {
|
|
77974
|
+
"name" : "tax_code",
|
|
77975
|
+
"type" : "string",
|
|
77976
|
+
"location" : "Path",
|
|
77977
|
+
"required" : true
|
|
77978
|
+
} ],
|
|
77979
|
+
"responses" : [ {
|
|
77980
|
+
"code" : {
|
|
77981
|
+
"integer" : {
|
|
77982
|
+
"value" : 200
|
|
77983
|
+
}
|
|
77984
|
+
},
|
|
77985
|
+
"type" : "organization_tax_registration",
|
|
77986
|
+
"description" : "Registration updated successfully",
|
|
77987
|
+
"attributes" : [ ]
|
|
77988
|
+
}, {
|
|
77989
|
+
"code" : {
|
|
77990
|
+
"integer" : {
|
|
77991
|
+
"value" : 201
|
|
77992
|
+
}
|
|
77993
|
+
},
|
|
77994
|
+
"type" : "organization_tax_registration",
|
|
77995
|
+
"description" : "Registration created successfully",
|
|
77996
|
+
"attributes" : [ ]
|
|
77997
|
+
}, {
|
|
77998
|
+
"code" : {
|
|
77999
|
+
"integer" : {
|
|
78000
|
+
"value" : 401
|
|
78001
|
+
}
|
|
78002
|
+
},
|
|
78003
|
+
"type" : "unit",
|
|
78004
|
+
"description" : "Authorization failed",
|
|
78005
|
+
"attributes" : [ ]
|
|
78006
|
+
}, {
|
|
78007
|
+
"code" : {
|
|
78008
|
+
"integer" : {
|
|
78009
|
+
"value" : 404
|
|
78010
|
+
}
|
|
78011
|
+
},
|
|
78012
|
+
"type" : "unit",
|
|
78013
|
+
"description" : "Resource was not found",
|
|
78014
|
+
"attributes" : [ ]
|
|
78015
|
+
}, {
|
|
78016
|
+
"code" : {
|
|
78017
|
+
"integer" : {
|
|
78018
|
+
"value" : 422
|
|
78019
|
+
}
|
|
78020
|
+
},
|
|
78021
|
+
"type" : "generic_error",
|
|
78022
|
+
"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.",
|
|
78023
|
+
"attributes" : [ ]
|
|
78024
|
+
} ],
|
|
78025
|
+
"attributes" : [ ],
|
|
78026
|
+
"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.",
|
|
78027
|
+
"body" : {
|
|
78028
|
+
"type" : "organization_tax_registration_form",
|
|
78029
|
+
"attributes" : [ ]
|
|
78030
|
+
}
|
|
78031
|
+
}, {
|
|
78032
|
+
"method" : "DELETE",
|
|
78033
|
+
"path" : "/organizations/:organization_id/tax/registrations/:tax_code",
|
|
78034
|
+
"parameters" : [ {
|
|
78035
|
+
"name" : "organization_id",
|
|
78036
|
+
"type" : "string",
|
|
78037
|
+
"location" : "Path",
|
|
78038
|
+
"required" : true
|
|
78039
|
+
}, {
|
|
78040
|
+
"name" : "tax_code",
|
|
78041
|
+
"type" : "string",
|
|
78042
|
+
"location" : "Path",
|
|
78043
|
+
"required" : true
|
|
78044
|
+
} ],
|
|
78045
|
+
"responses" : [ {
|
|
78046
|
+
"code" : {
|
|
78047
|
+
"integer" : {
|
|
78048
|
+
"value" : 204
|
|
78049
|
+
}
|
|
78050
|
+
},
|
|
78051
|
+
"type" : "unit",
|
|
78052
|
+
"description" : "Registration deleted successfully",
|
|
78053
|
+
"attributes" : [ ]
|
|
78054
|
+
}, {
|
|
78055
|
+
"code" : {
|
|
78056
|
+
"integer" : {
|
|
78057
|
+
"value" : 401
|
|
78058
|
+
}
|
|
78059
|
+
},
|
|
78060
|
+
"type" : "unit",
|
|
78061
|
+
"description" : "Authorization failed",
|
|
78062
|
+
"attributes" : [ ]
|
|
78063
|
+
}, {
|
|
78064
|
+
"code" : {
|
|
78065
|
+
"integer" : {
|
|
78066
|
+
"value" : 404
|
|
78067
|
+
}
|
|
78068
|
+
},
|
|
78069
|
+
"type" : "unit",
|
|
78070
|
+
"description" : "Resource was not found",
|
|
78071
|
+
"attributes" : [ ]
|
|
78072
|
+
} ],
|
|
78073
|
+
"attributes" : [ ],
|
|
78074
|
+
"description" : "Remove a tax registration for an organization by tax code."
|
|
78075
|
+
} ],
|
|
78076
|
+
"attributes" : [ {
|
|
78077
|
+
"name" : "docs",
|
|
78078
|
+
"value" : {
|
|
78079
|
+
"module" : "general"
|
|
78080
|
+
}
|
|
78081
|
+
} ],
|
|
78082
|
+
"path" : "/organizations/:organization_id/tax/registrations",
|
|
78083
|
+
"description" : "Tax registration and self-billing agreement status."
|
|
76635
78084
|
}, {
|
|
76636
78085
|
"type" : "organization_token",
|
|
76637
78086
|
"plural" : "organization_tokens",
|
|
@@ -78283,7 +79732,7 @@
|
|
|
78283
79732
|
"attributes" : [ ],
|
|
78284
79733
|
"description" : "Get the sellability of product",
|
|
78285
79734
|
"body" : {
|
|
78286
|
-
"type" : "
|
|
79735
|
+
"type" : "sellability_request",
|
|
78287
79736
|
"attributes" : [ ]
|
|
78288
79737
|
}
|
|
78289
79738
|
} ],
|
|
@@ -80791,7 +82240,7 @@
|
|
|
80791
82240
|
"description" : "Identifies a field that contains data that must be handled in a way that is compliant with the PCI standard."
|
|
80792
82241
|
} ],
|
|
80793
82242
|
"apidoc" : {
|
|
80794
|
-
"version" : "0.
|
|
82243
|
+
"version" : "0.21.14"
|
|
80795
82244
|
},
|
|
80796
82245
|
"base_url" : "https://api.flow.io",
|
|
80797
82246
|
"description" : "The Flow Commerce REST API provides full access to the global ecommerce platform."
|