@flowio/api-mock-generator 6.17.109 → 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.
Files changed (3) hide show
  1. package/dist/api.json +2156 -620
  2. package/package.json +2 -2
  3. package/src/api.json +2156 -620
package/dist/api.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "key": "api"
8
8
  },
9
9
  "namespace": "io.flow.v0",
10
- "version": "0.20.63",
10
+ "version": "0.21.14",
11
11
  "info": {
12
12
  "license": {
13
13
  "name": "MIT",
@@ -28,11 +28,11 @@
28
28
  "application": {
29
29
  "key": "channel-internal"
30
30
  },
31
- "version": "0.27.59",
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": [],
35
- "models": ["channel_currency_form", "channel_form", "channel_membership", "channel_membership_form", "channel_membership_put_form", "channel_order_acceptance", "channel_order_acceptance_details", "channel_order_acceptance_failure", "channel_order_acceptance_form", "channel_order_acceptance_reason", "channel_organization_domain", "channel_organization_installation", "channel_organization_installation_post_form", "channel_organization_metadata", "channel_organization_token", "channel_organization_token_body", "flow_channel_organization", "order_edit_summary"],
35
+ "models": ["channel_currency_form", "channel_form", "channel_membership", "channel_membership_form", "channel_membership_put_form", "channel_order_acceptance", "channel_order_acceptance_details", "channel_order_acceptance_failure", "channel_order_acceptance_form", "channel_order_acceptance_reason", "channel_organization_domains", "channel_organization_installation", "channel_organization_installation_post_form", "channel_organization_metadata", "channel_organization_token", "channel_organization_token_body", "flow_channel_organization", "order_edit_summary"],
36
36
  "annotations": []
37
37
  }, {
38
38
  "uri": "https://app.apibuilder.io/flow/apple-pay/latest/service.json",
@@ -43,7 +43,7 @@
43
43
  "application": {
44
44
  "key": "apple-pay"
45
45
  },
46
- "version": "0.4.52",
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.52",
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.52",
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.27.33",
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": []
@@ -1550,9 +1506,6 @@
1550
1506
  }, {
1551
1507
  "name": "fully_harmonized_item_upserted",
1552
1508
  "attributes": []
1553
- }, {
1554
- "name": "label_upserted",
1555
- "attributes": []
1556
1509
  }, {
1557
1510
  "name": "label_deleted_v2",
1558
1511
  "attributes": []
@@ -1619,6 +1572,12 @@
1619
1572
  }, {
1620
1573
  "name": "ecommerce_platform_deleted",
1621
1574
  "attributes": []
1575
+ }, {
1576
+ "name": "tax_registration_upserted",
1577
+ "attributes": []
1578
+ }, {
1579
+ "name": "tax_registration_deleted",
1580
+ "attributes": []
1622
1581
  }, {
1623
1582
  "name": "organization_onboarding_state_upserted",
1624
1583
  "attributes": []
@@ -1760,6 +1719,12 @@
1760
1719
  }, {
1761
1720
  "name": "product_restriction_result_deleted",
1762
1721
  "attributes": []
1722
+ }, {
1723
+ "name": "product_sellability_result_upserted",
1724
+ "attributes": []
1725
+ }, {
1726
+ "name": "product_sellability_result_deleted",
1727
+ "attributes": []
1763
1728
  }, {
1764
1729
  "name": "shopify_localization_setting_upserted",
1765
1730
  "attributes": []
@@ -1769,6 +1734,9 @@
1769
1734
  }, {
1770
1735
  "name": "tracking_label_event_upserted",
1771
1736
  "attributes": []
1737
+ }, {
1738
+ "name": "tracking_label_event_upserted_v2",
1739
+ "attributes": []
1772
1740
  }],
1773
1741
  "attributes": [{
1774
1742
  "name": "docs",
@@ -3779,7 +3747,7 @@
3779
3747
  "attributes": []
3780
3748
  }],
3781
3749
  "attributes": [],
3782
- "description": "Modeled from stripe: https://stripe.com/docs/api/payouts/failures"
3750
+ "description": "Payout status failure code"
3783
3751
  }, {
3784
3752
  "name": "pending_payout_transaction_reason_code",
3785
3753
  "plural": "pending_payout_transaction_reason_codes",
@@ -4291,6 +4259,24 @@
4291
4259
  }],
4292
4260
  "attributes": [],
4293
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."
4294
4280
  }, {
4295
4281
  "name": "return_item_status",
4296
4282
  "plural": "return_item_statuses",
@@ -4575,6 +4561,56 @@
4575
4561
  "description": "commit this request to be associated to the corresponding product_id."
4576
4562
  }],
4577
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."
4578
4614
  }, {
4579
4615
  "name": "shipment_integration_type",
4580
4616
  "plural": "shipment_integration_types",
@@ -4730,6 +4766,23 @@
4730
4766
  "values": [{
4731
4767
  "name": "csv",
4732
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": []
4733
4786
  }],
4734
4787
  "attributes": []
4735
4788
  }, {
@@ -5044,6 +5097,9 @@
5044
5097
  }, {
5045
5098
  "name": "lvg_refund",
5046
5099
  "attributes": []
5100
+ }, {
5101
+ "name": "us_inbound_tax_refund",
5102
+ "attributes": []
5047
5103
  }, {
5048
5104
  "name": "order_cancellation_above_de_min",
5049
5105
  "attributes": []
@@ -5058,6 +5114,20 @@
5058
5114
  "attributes": []
5059
5115
  }],
5060
5116
  "attributes": []
5117
+ }, {
5118
+ "name": "tax_jurisdiction_type",
5119
+ "plural": "tax_jurisdiction_types",
5120
+ "values": [{
5121
+ "name": "country",
5122
+ "attributes": [],
5123
+ "description": "Country-level tax (e.g., Federal GST)"
5124
+ }, {
5125
+ "name": "province",
5126
+ "attributes": [],
5127
+ "description": "Province or state-level tax"
5128
+ }],
5129
+ "attributes": [],
5130
+ "description": "Type of tax jurisdiction for invoices"
5061
5131
  }, {
5062
5132
  "name": "tax_report_type",
5063
5133
  "plural": "tax_report_types",
@@ -5069,6 +5139,36 @@
5069
5139
  "attributes": []
5070
5140
  }],
5071
5141
  "attributes": []
5142
+ }, {
5143
+ "name": "tax_type",
5144
+ "plural": "tax_types",
5145
+ "values": [{
5146
+ "name": "vat",
5147
+ "attributes": [],
5148
+ "description": "Value Added Tax"
5149
+ }, {
5150
+ "name": "gst",
5151
+ "attributes": [],
5152
+ "description": "Goods and Services Tax (Canada Federal)"
5153
+ }, {
5154
+ "name": "hst",
5155
+ "attributes": [],
5156
+ "description": "Harmonized Sales Tax (Canada)"
5157
+ }, {
5158
+ "name": "pst",
5159
+ "attributes": [],
5160
+ "description": "Provincial Sales Tax (Canada)"
5161
+ }, {
5162
+ "name": "qst",
5163
+ "attributes": [],
5164
+ "description": "Quebec Sales Tax (Canada)"
5165
+ }, {
5166
+ "name": "sales_tax",
5167
+ "attributes": [],
5168
+ "description": "General sales tax"
5169
+ }],
5170
+ "attributes": [],
5171
+ "description": "Types of taxes that can be applied to a invoice line"
5072
5172
  }, {
5073
5173
  "name": "tax_verification_result",
5074
5174
  "plural": "tax_verification_results",
@@ -5382,6 +5482,12 @@
5382
5482
  }, {
5383
5483
  "name": "merchant_fee",
5384
5484
  "attributes": []
5485
+ }, {
5486
+ "name": "b2b_tax",
5487
+ "attributes": []
5488
+ }, {
5489
+ "name": "b2b_tax_refund",
5490
+ "attributes": []
5385
5491
  }],
5386
5492
  "attributes": []
5387
5493
  }, {
@@ -5444,6 +5550,9 @@
5444
5550
  }, {
5445
5551
  "name": "ups",
5446
5552
  "attributes": []
5553
+ }, {
5554
+ "name": "fedex",
5555
+ "attributes": []
5447
5556
  }],
5448
5557
  "attributes": []
5449
5558
  }, {
@@ -6382,7 +6491,7 @@
6382
6491
  "annotations": []
6383
6492
  }, {
6384
6493
  "name": "environment",
6385
- "type": "environment",
6494
+ "type": "restriction_environment",
6386
6495
  "required": true,
6387
6496
  "attributes": [],
6388
6497
  "annotations": []
@@ -6852,7 +6961,7 @@
6852
6961
  "description": "The low-fi HS6 code for the product to be used pending full classification and a higher fidelity (HS10) code."
6853
6962
  }, {
6854
6963
  "name": "restricted_regions",
6855
- "type": "[sellablility_region_result]",
6964
+ "type": "[sellability_region_result]",
6856
6965
  "required": true,
6857
6966
  "attributes": [],
6858
6967
  "annotations": [],
@@ -7612,62 +7721,6 @@
7612
7721
  "type": "generate_load",
7613
7722
  "attributes": [],
7614
7723
  "discriminator_value": "generate_load"
7615
- }, {
7616
- "type": "sarvesh_item_upserted",
7617
- "attributes": [],
7618
- "discriminator_value": "sarvesh_item_upserted"
7619
- }, {
7620
- "type": "sarvesh_item_deleted",
7621
- "attributes": [],
7622
- "discriminator_value": "sarvesh_item_deleted"
7623
- }, {
7624
- "type": "hosein_item_upserted",
7625
- "attributes": [],
7626
- "discriminator_value": "hosein_item_upserted"
7627
- }, {
7628
- "type": "hosein_item_deleted",
7629
- "attributes": [],
7630
- "discriminator_value": "hosein_item_deleted"
7631
- }, {
7632
- "type": "niall_item_upserted",
7633
- "attributes": [],
7634
- "discriminator_value": "niall_item_upserted"
7635
- }, {
7636
- "type": "niall_item_deleted",
7637
- "attributes": [],
7638
- "discriminator_value": "niall_item_deleted"
7639
- }, {
7640
- "type": "rohan_item_upserted",
7641
- "attributes": [],
7642
- "discriminator_value": "rohan_item_upserted"
7643
- }, {
7644
- "type": "rohan_item_deleted",
7645
- "attributes": [],
7646
- "discriminator_value": "rohan_item_deleted"
7647
- }, {
7648
- "type": "aldo_item_upserted",
7649
- "attributes": [],
7650
- "discriminator_value": "aldo_item_upserted"
7651
- }, {
7652
- "type": "aldo_item_deleted",
7653
- "attributes": [],
7654
- "discriminator_value": "aldo_item_deleted"
7655
- }, {
7656
- "type": "ansh_item_upserted",
7657
- "attributes": [],
7658
- "discriminator_value": "ansh_item_upserted"
7659
- }, {
7660
- "type": "ansh_item_deleted",
7661
- "attributes": [],
7662
- "discriminator_value": "ansh_item_deleted"
7663
- }, {
7664
- "type": "anirban_item_upserted",
7665
- "attributes": [],
7666
- "discriminator_value": "anirban_item_upserted"
7667
- }, {
7668
- "type": "anirban_item_deleted",
7669
- "attributes": [],
7670
- "discriminator_value": "anirban_item_deleted"
7671
7724
  }, {
7672
7725
  "type": "transaction_upserted",
7673
7726
  "attributes": [],
@@ -8004,10 +8057,6 @@
8004
8057
  "type": "fully_harmonized_item_upserted",
8005
8058
  "attributes": [],
8006
8059
  "discriminator_value": "fully_harmonized_item_upserted"
8007
- }, {
8008
- "type": "label_upserted",
8009
- "attributes": [],
8010
- "discriminator_value": "label_upserted"
8011
8060
  }, {
8012
8061
  "type": "label_deleted_v2",
8013
8062
  "attributes": [],
@@ -8096,6 +8145,14 @@
8096
8145
  "type": "ecommerce_platform_deleted",
8097
8146
  "attributes": [],
8098
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"
8099
8156
  }, {
8100
8157
  "type": "organization_onboarding_state_upserted",
8101
8158
  "attributes": [],
@@ -8285,6 +8342,14 @@
8285
8342
  "type": "product_restriction_result_deleted",
8286
8343
  "attributes": [],
8287
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"
8288
8353
  }, {
8289
8354
  "type": "shopify_localization_setting_upserted",
8290
8355
  "attributes": [],
@@ -8297,6 +8362,10 @@
8297
8362
  "type": "tracking_label_event_upserted",
8298
8363
  "attributes": [],
8299
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"
8300
8369
  }],
8301
8370
  "attributes": [{
8302
8371
  "name": "docs",
@@ -8736,6 +8805,10 @@
8736
8805
  "type": "shopify_merchant_application",
8737
8806
  "attributes": [],
8738
8807
  "discriminator_value": "shopify_merchant_application"
8808
+ }, {
8809
+ "type": "common_merchant_application",
8810
+ "attributes": [],
8811
+ "discriminator_value": "common_merchant_application"
8739
8812
  }],
8740
8813
  "attributes": [],
8741
8814
  "interfaces": [],
@@ -8747,6 +8820,10 @@
8747
8820
  "type": "shopify_merchant_application_form",
8748
8821
  "attributes": [],
8749
8822
  "discriminator_value": "shopify_merchant_application_form"
8823
+ }, {
8824
+ "type": "common_merchant_application_form",
8825
+ "attributes": [],
8826
+ "discriminator_value": "common_merchant_application_form"
8750
8827
  }],
8751
8828
  "attributes": [],
8752
8829
  "interfaces": [],
@@ -8758,6 +8835,10 @@
8758
8835
  "type": "shopify_merchant_application_put_form",
8759
8836
  "attributes": [],
8760
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"
8761
8842
  }],
8762
8843
  "attributes": [],
8763
8844
  "interfaces": [],
@@ -8769,6 +8850,10 @@
8769
8850
  "type": "shopify_merchant_applications_summary",
8770
8851
  "attributes": [],
8771
8852
  "discriminator_value": "shopify_merchant_applications_summary"
8853
+ }, {
8854
+ "type": "common_merchant_applications_summary",
8855
+ "attributes": [],
8856
+ "discriminator_value": "common_merchant_applications_summary"
8772
8857
  }],
8773
8858
  "attributes": [],
8774
8859
  "interfaces": [],
@@ -9525,6 +9610,22 @@
9525
9610
  "attributes": [],
9526
9611
  "interfaces": [],
9527
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"
9528
9629
  }, {
9529
9630
  "name": "sellability_response",
9530
9631
  "plural": "sellability_responses",
@@ -9536,6 +9637,10 @@
9536
9637
  "type": "sellability_error",
9537
9638
  "attributes": [],
9538
9639
  "discriminator_value": "sellability_error"
9640
+ }, {
9641
+ "type": "sellability_screening",
9642
+ "attributes": [],
9643
+ "discriminator_value": "sellability_screening"
9539
9644
  }],
9540
9645
  "attributes": [],
9541
9646
  "interfaces": [],
@@ -11315,55 +11420,6 @@
11315
11420
  "attributes": [],
11316
11421
  "interfaces": [],
11317
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."
11318
- }, {
11319
- "name": "aldo_item_deleted",
11320
- "plural": "aldo_item_deleteds",
11321
- "fields": [{
11322
- "name": "event_id",
11323
- "type": "string",
11324
- "required": true,
11325
- "attributes": [],
11326
- "annotations": []
11327
- }, {
11328
- "name": "timestamp",
11329
- "type": "date-time-iso8601",
11330
- "required": true,
11331
- "attributes": [],
11332
- "annotations": []
11333
- }, {
11334
- "name": "id",
11335
- "type": "string",
11336
- "required": true,
11337
- "attributes": [],
11338
- "annotations": [],
11339
- "description": "Globally unique identifier"
11340
- }],
11341
- "attributes": [],
11342
- "interfaces": []
11343
- }, {
11344
- "name": "aldo_item_upserted",
11345
- "plural": "aldo_item_upserteds",
11346
- "fields": [{
11347
- "name": "event_id",
11348
- "type": "string",
11349
- "required": true,
11350
- "attributes": [],
11351
- "annotations": []
11352
- }, {
11353
- "name": "timestamp",
11354
- "type": "date-time-iso8601",
11355
- "required": true,
11356
- "attributes": [],
11357
- "annotations": []
11358
- }, {
11359
- "name": "item",
11360
- "type": "io.flow.tech.onboarding.playground.v0.models.aldo_item",
11361
- "required": true,
11362
- "attributes": [],
11363
- "annotations": []
11364
- }],
11365
- "attributes": [],
11366
- "interfaces": []
11367
11423
  }, {
11368
11424
  "name": "allocation",
11369
11425
  "plural": "allocations",
@@ -11926,104 +11982,6 @@
11926
11982
  }],
11927
11983
  "attributes": [],
11928
11984
  "interfaces": []
11929
- }, {
11930
- "name": "anirban_item_deleted",
11931
- "plural": "anirban_item_deleteds",
11932
- "fields": [{
11933
- "name": "event_id",
11934
- "type": "string",
11935
- "required": true,
11936
- "attributes": [],
11937
- "annotations": []
11938
- }, {
11939
- "name": "timestamp",
11940
- "type": "date-time-iso8601",
11941
- "required": true,
11942
- "attributes": [],
11943
- "annotations": []
11944
- }, {
11945
- "name": "id",
11946
- "type": "string",
11947
- "required": true,
11948
- "attributes": [],
11949
- "annotations": [],
11950
- "description": "Globally unique identifier"
11951
- }],
11952
- "attributes": [],
11953
- "interfaces": []
11954
- }, {
11955
- "name": "anirban_item_upserted",
11956
- "plural": "anirban_item_upserteds",
11957
- "fields": [{
11958
- "name": "event_id",
11959
- "type": "string",
11960
- "required": true,
11961
- "attributes": [],
11962
- "annotations": []
11963
- }, {
11964
- "name": "timestamp",
11965
- "type": "date-time-iso8601",
11966
- "required": true,
11967
- "attributes": [],
11968
- "annotations": []
11969
- }, {
11970
- "name": "item",
11971
- "type": "io.flow.tech.onboarding.playground.v0.models.anirban_item",
11972
- "required": true,
11973
- "attributes": [],
11974
- "annotations": []
11975
- }],
11976
- "attributes": [],
11977
- "interfaces": []
11978
- }, {
11979
- "name": "ansh_item_deleted",
11980
- "plural": "ansh_item_deleteds",
11981
- "fields": [{
11982
- "name": "event_id",
11983
- "type": "string",
11984
- "required": true,
11985
- "attributes": [],
11986
- "annotations": []
11987
- }, {
11988
- "name": "timestamp",
11989
- "type": "date-time-iso8601",
11990
- "required": true,
11991
- "attributes": [],
11992
- "annotations": []
11993
- }, {
11994
- "name": "id",
11995
- "type": "string",
11996
- "required": true,
11997
- "attributes": [],
11998
- "annotations": [],
11999
- "description": "Globally unique identifier"
12000
- }],
12001
- "attributes": [],
12002
- "interfaces": []
12003
- }, {
12004
- "name": "ansh_item_upserted",
12005
- "plural": "ansh_item_upserteds",
12006
- "fields": [{
12007
- "name": "event_id",
12008
- "type": "string",
12009
- "required": true,
12010
- "attributes": [],
12011
- "annotations": []
12012
- }, {
12013
- "name": "timestamp",
12014
- "type": "date-time-iso8601",
12015
- "required": true,
12016
- "attributes": [],
12017
- "annotations": []
12018
- }, {
12019
- "name": "item",
12020
- "type": "io.flow.tech.onboarding.playground.v0.models.ansh_item",
12021
- "required": true,
12022
- "attributes": [],
12023
- "annotations": []
12024
- }],
12025
- "attributes": [],
12026
- "interfaces": []
12027
11985
  }, {
12028
11986
  "name": "apple_pay_merchant_validation_payload",
12029
11987
  "plural": "apple_pay_merchant_validation_payloads",
@@ -13220,6 +13178,20 @@
13220
13178
  "required": true,
13221
13179
  "attributes": [],
13222
13180
  "annotations": []
13181
+ }, {
13182
+ "name": "tax_lines",
13183
+ "type": "[invoice_tax_line]",
13184
+ "required": false,
13185
+ "attributes": [],
13186
+ "annotations": [],
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"
13223
13195
  }, {
13224
13196
  "name": "documents",
13225
13197
  "type": "[consumer_invoice_document]",
@@ -13239,6 +13211,19 @@
13239
13211
  "attributes": [],
13240
13212
  "annotations": [],
13241
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": []
13242
13227
  }],
13243
13228
  "attributes": [],
13244
13229
  "interfaces": [],
@@ -13388,6 +13373,13 @@
13388
13373
  "attributes": [],
13389
13374
  "annotations": [],
13390
13375
  "description": "The total amount of tax for this invoice"
13376
+ }, {
13377
+ "name": "tax_lines",
13378
+ "type": "[invoice_tax_line]",
13379
+ "required": false,
13380
+ "attributes": [],
13381
+ "annotations": [],
13382
+ "description": "detailed tax breakdown for items & shipping in this invoice"
13391
13383
  }, {
13392
13384
  "name": "lines",
13393
13385
  "type": "[consumer_invoice_line]",
@@ -16849,6 +16841,12 @@
16849
16841
  "required": false,
16850
16842
  "attributes": [],
16851
16843
  "annotations": []
16844
+ }, {
16845
+ "name": "external_order_summary",
16846
+ "type": "external_order_summary",
16847
+ "required": false,
16848
+ "attributes": [],
16849
+ "annotations": []
16852
16850
  }],
16853
16851
  "attributes": [],
16854
16852
  "interfaces": []
@@ -17853,6 +17851,383 @@
17853
17851
  }],
17854
17852
  "attributes": [],
17855
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"
17856
18231
  }, {
17857
18232
  "name": "company",
17858
18233
  "plural": "companies",
@@ -18157,6 +18532,13 @@
18157
18532
  "name": "consumer_invoice_line_discount",
18158
18533
  "plural": "consumer_invoice_line_discounts",
18159
18534
  "fields": [{
18535
+ "name": "line_id",
18536
+ "type": "string",
18537
+ "required": false,
18538
+ "attributes": [],
18539
+ "annotations": [],
18540
+ "description": "Unique identifier for this line, used to correlate with tax lines in B2B invoices"
18541
+ }, {
18160
18542
  "name": "price",
18161
18543
  "type": "price",
18162
18544
  "required": true,
@@ -18184,6 +18566,13 @@
18184
18566
  "name": "consumer_invoice_line_item",
18185
18567
  "plural": "consumer_invoice_line_items",
18186
18568
  "fields": [{
18569
+ "name": "line_id",
18570
+ "type": "string",
18571
+ "required": false,
18572
+ "attributes": [],
18573
+ "annotations": [],
18574
+ "description": "Unique identifier for this line, used to correlate with tax lines in B2B invoices"
18575
+ }, {
18187
18576
  "name": "item",
18188
18577
  "type": "item_reference",
18189
18578
  "required": true,
@@ -18280,6 +18669,13 @@
18280
18669
  "name": "consumer_invoice_line_shipping",
18281
18670
  "plural": "consumer_invoice_line_shippings",
18282
18671
  "fields": [{
18672
+ "name": "line_id",
18673
+ "type": "string",
18674
+ "required": false,
18675
+ "attributes": [],
18676
+ "annotations": [],
18677
+ "description": "Unique identifier for this line, used to correlate with tax lines in B2B invoices"
18678
+ }, {
18283
18679
  "name": "price",
18284
18680
  "type": "price",
18285
18681
  "required": true,
@@ -18343,6 +18739,13 @@
18343
18739
  "name": "consumer_invoice_line_tip",
18344
18740
  "plural": "consumer_invoice_line_tips",
18345
18741
  "fields": [{
18742
+ "name": "line_id",
18743
+ "type": "string",
18744
+ "required": false,
18745
+ "attributes": [],
18746
+ "annotations": [],
18747
+ "description": "Unique identifier for this line, used to correlate with tax lines in B2B invoices"
18748
+ }, {
18346
18749
  "name": "price",
18347
18750
  "type": "price",
18348
18751
  "required": true,
@@ -18844,6 +19247,19 @@
18844
19247
  "required": false,
18845
19248
  "attributes": [],
18846
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": []
18847
19263
  }],
18848
19264
  "attributes": [],
18849
19265
  "interfaces": [],
@@ -22328,7 +22744,17 @@
22328
22744
  "type": "ratecard_region_reference",
22329
22745
  "required": false,
22330
22746
  "attributes": [],
22331
- "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."
22332
22758
  }, {
22333
22759
  "name": "interval_unit",
22334
22760
  "type": "unit_of_measurement",
@@ -23807,6 +24233,25 @@
23807
24233
  "attributes": [],
23808
24234
  "interfaces": [],
23809
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": []
23810
24255
  }, {
23811
24256
  "name": "fee_deduction",
23812
24257
  "plural": "fee_deductions",
@@ -25002,7 +25447,7 @@
25002
25447
  "annotations": []
25003
25448
  }, {
25004
25449
  "name": "environment",
25005
- "type": "environment",
25450
+ "type": "restriction_environment",
25006
25451
  "required": true,
25007
25452
  "attributes": [],
25008
25453
  "annotations": []
@@ -25302,7 +25747,7 @@
25302
25747
  "annotations": []
25303
25748
  }, {
25304
25749
  "name": "environment",
25305
- "type": "environment",
25750
+ "type": "restriction_environment",
25306
25751
  "required": true,
25307
25752
  "attributes": [],
25308
25753
  "annotations": []
@@ -25353,7 +25798,7 @@
25353
25798
  "annotations": []
25354
25799
  }, {
25355
25800
  "name": "environment",
25356
- "type": "environment",
25801
+ "type": "restriction_environment",
25357
25802
  "required": true,
25358
25803
  "attributes": [],
25359
25804
  "annotations": []
@@ -26271,55 +26716,6 @@
26271
26716
  }],
26272
26717
  "attributes": [],
26273
26718
  "interfaces": []
26274
- }, {
26275
- "name": "hosein_item_deleted",
26276
- "plural": "hosein_item_deleteds",
26277
- "fields": [{
26278
- "name": "event_id",
26279
- "type": "string",
26280
- "required": true,
26281
- "attributes": [],
26282
- "annotations": []
26283
- }, {
26284
- "name": "timestamp",
26285
- "type": "date-time-iso8601",
26286
- "required": true,
26287
- "attributes": [],
26288
- "annotations": []
26289
- }, {
26290
- "name": "id",
26291
- "type": "string",
26292
- "required": true,
26293
- "attributes": [],
26294
- "annotations": [],
26295
- "description": "Globally unique identifier"
26296
- }],
26297
- "attributes": [],
26298
- "interfaces": []
26299
- }, {
26300
- "name": "hosein_item_upserted",
26301
- "plural": "hosein_item_upserteds",
26302
- "fields": [{
26303
- "name": "event_id",
26304
- "type": "string",
26305
- "required": true,
26306
- "attributes": [],
26307
- "annotations": []
26308
- }, {
26309
- "name": "timestamp",
26310
- "type": "date-time-iso8601",
26311
- "required": true,
26312
- "attributes": [],
26313
- "annotations": []
26314
- }, {
26315
- "name": "item",
26316
- "type": "io.flow.tech.onboarding.playground.v0.models.hosein_item",
26317
- "required": true,
26318
- "attributes": [],
26319
- "annotations": []
26320
- }],
26321
- "attributes": [],
26322
- "interfaces": []
26323
26719
  }, {
26324
26720
  "name": "hs10",
26325
26721
  "plural": "hs10",
@@ -27382,6 +27778,27 @@
27382
27778
  }],
27383
27779
  "attributes": [],
27384
27780
  "interfaces": []
27781
+ }, {
27782
+ "name": "invoice_tax_line",
27783
+ "plural": "invoice_tax_lines",
27784
+ "fields": [{
27785
+ "name": "line_id",
27786
+ "type": "string",
27787
+ "required": true,
27788
+ "attributes": [],
27789
+ "annotations": [],
27790
+ "description": "References the line_id of the corresponding invoice line (item, shipping, or tip)"
27791
+ }, {
27792
+ "name": "tax_breakdown",
27793
+ "type": "[tax_breakdown]",
27794
+ "required": true,
27795
+ "attributes": [],
27796
+ "annotations": [],
27797
+ "description": "Array of tax components (e.g., GST + QST for Quebec)"
27798
+ }],
27799
+ "attributes": [],
27800
+ "interfaces": [],
27801
+ "description": "Tax line breakdown for invoices, linked to a specific invoice line by line_id"
27385
27802
  }, {
27386
27803
  "name": "issuer_reference",
27387
27804
  "plural": "issuer_references",
@@ -29080,147 +29497,6 @@
29080
29497
  "attributes": [],
29081
29498
  "interfaces": [],
29082
29499
  "description": "Describes the units that are then used consistently throughout all the data in the label invoice request"
29083
- }, {
29084
- "name": "label_upserted",
29085
- "plural": "label_upserteds",
29086
- "fields": [{
29087
- "name": "event_id",
29088
- "type": "string",
29089
- "required": true,
29090
- "attributes": [],
29091
- "annotations": []
29092
- }, {
29093
- "name": "timestamp",
29094
- "type": "date-time-iso8601",
29095
- "required": true,
29096
- "attributes": [],
29097
- "annotations": []
29098
- }, {
29099
- "name": "organization",
29100
- "type": "string",
29101
- "required": true,
29102
- "attributes": [],
29103
- "annotations": [],
29104
- "description": "Refers to your organization's account identifier"
29105
- }, {
29106
- "name": "label_id",
29107
- "type": "string",
29108
- "required": true,
29109
- "attributes": [],
29110
- "annotations": []
29111
- }, {
29112
- "name": "carrier_tracking_number",
29113
- "type": "string",
29114
- "required": true,
29115
- "attributes": [],
29116
- "annotations": []
29117
- }, {
29118
- "name": "commercial_invoice",
29119
- "type": "string",
29120
- "required": true,
29121
- "attributes": [],
29122
- "annotations": []
29123
- }, {
29124
- "name": "flow_tracking_number",
29125
- "type": "string",
29126
- "required": true,
29127
- "attributes": [],
29128
- "annotations": []
29129
- }, {
29130
- "name": "destination",
29131
- "type": "shipping_address",
29132
- "required": true,
29133
- "attributes": [],
29134
- "annotations": ["personal_data", "consumer"]
29135
- }, {
29136
- "name": "origin",
29137
- "type": "shipping_address",
29138
- "required": true,
29139
- "attributes": [],
29140
- "annotations": ["personal_data", "consumer"]
29141
- }, {
29142
- "name": "carrier",
29143
- "type": "string",
29144
- "required": true,
29145
- "attributes": [],
29146
- "annotations": []
29147
- }, {
29148
- "name": "service",
29149
- "type": "string",
29150
- "required": true,
29151
- "attributes": [],
29152
- "annotations": []
29153
- }, {
29154
- "name": "zpl",
29155
- "type": "string",
29156
- "required": false,
29157
- "attributes": [],
29158
- "annotations": ["personal_data", "consumer"]
29159
- }, {
29160
- "name": "pdf",
29161
- "type": "string",
29162
- "required": false,
29163
- "attributes": [],
29164
- "annotations": ["personal_data", "consumer"]
29165
- }, {
29166
- "name": "png",
29167
- "type": "string",
29168
- "required": false,
29169
- "attributes": [],
29170
- "annotations": ["personal_data", "consumer"]
29171
- }, {
29172
- "name": "order",
29173
- "type": "string",
29174
- "required": false,
29175
- "attributes": [],
29176
- "annotations": []
29177
- }, {
29178
- "name": "carrier_tracking_number_url",
29179
- "type": "string",
29180
- "required": false,
29181
- "attributes": [],
29182
- "annotations": []
29183
- }, {
29184
- "name": "flow_tracking_number_url",
29185
- "type": "string",
29186
- "required": false,
29187
- "attributes": [],
29188
- "annotations": []
29189
- }, {
29190
- "name": "center_key",
29191
- "type": "string",
29192
- "required": false,
29193
- "attributes": [],
29194
- "annotations": []
29195
- }, {
29196
- "name": "recipient",
29197
- "type": "shipment_recipient",
29198
- "required": false,
29199
- "attributes": [],
29200
- "annotations": ["personal_data", "consumer"]
29201
- }, {
29202
- "name": "package",
29203
- "type": "shipping_label_package",
29204
- "required": false,
29205
- "attributes": [],
29206
- "annotations": []
29207
- }, {
29208
- "name": "order_identifier",
29209
- "type": "string",
29210
- "required": false,
29211
- "attributes": [],
29212
- "annotations": [],
29213
- "description": "The order identifier this label is associated with. Will be blank if not specified when a label was created."
29214
- }, {
29215
- "name": "fulfillment_key",
29216
- "type": "string",
29217
- "required": false,
29218
- "attributes": [],
29219
- "annotations": [],
29220
- "description": "The key of a fulfillment this label is associated with. Will be blank if not specified when a label was created."
29221
- }],
29222
- "attributes": [],
29223
- "interfaces": []
29224
29500
  }, {
29225
29501
  "name": "label_upserted_v2",
29226
29502
  "plural": "label_upserted_v2s",
@@ -31133,6 +31409,12 @@
31133
31409
  "required": false,
31134
31410
  "attributes": [],
31135
31411
  "annotations": []
31412
+ }, {
31413
+ "name": "description",
31414
+ "type": "string",
31415
+ "required": false,
31416
+ "attributes": [],
31417
+ "annotations": []
31136
31418
  }],
31137
31419
  "attributes": [],
31138
31420
  "interfaces": []
@@ -31330,6 +31612,20 @@
31330
31612
  "annotations": [],
31331
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",
31332
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."
31333
31629
  }],
31334
31630
  "attributes": [],
31335
31631
  "interfaces": []
@@ -31415,6 +31711,62 @@
31415
31711
  }],
31416
31712
  "attributes": [],
31417
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"
31418
31770
  }, {
31419
31771
  "name": "merchant_rejected",
31420
31772
  "plural": "merchant_rejecteds",
@@ -31608,55 +31960,13 @@
31608
31960
  "attributes": [],
31609
31961
  "annotations": [],
31610
31962
  "description": "List of metafield handles that can be set to influence restriction review."
31611
- }],
31612
- "attributes": [],
31613
- "interfaces": []
31614
- }, {
31615
- "name": "niall_item_deleted",
31616
- "plural": "niall_item_deleteds",
31617
- "fields": [{
31618
- "name": "event_id",
31619
- "type": "string",
31620
- "required": true,
31621
- "attributes": [],
31622
- "annotations": []
31623
31963
  }, {
31624
- "name": "timestamp",
31625
- "type": "date-time-iso8601",
31626
- "required": true,
31627
- "attributes": [],
31628
- "annotations": []
31629
- }, {
31630
- "name": "id",
31631
- "type": "string",
31632
- "required": true,
31964
+ "name": "require_msds",
31965
+ "type": "boolean",
31966
+ "required": false,
31633
31967
  "attributes": [],
31634
31968
  "annotations": [],
31635
- "description": "Globally unique identifier"
31636
- }],
31637
- "attributes": [],
31638
- "interfaces": []
31639
- }, {
31640
- "name": "niall_item_upserted",
31641
- "plural": "niall_item_upserteds",
31642
- "fields": [{
31643
- "name": "event_id",
31644
- "type": "string",
31645
- "required": true,
31646
- "attributes": [],
31647
- "annotations": []
31648
- }, {
31649
- "name": "timestamp",
31650
- "type": "date-time-iso8601",
31651
- "required": true,
31652
- "attributes": [],
31653
- "annotations": []
31654
- }, {
31655
- "name": "item",
31656
- "type": "io.flow.tech.onboarding.playground.v0.models.niall_item",
31657
- "required": true,
31658
- "attributes": [],
31659
- "annotations": []
31969
+ "description": "If true, restriction can be lifted after review of MSDS doc"
31660
31970
  }],
31661
31971
  "attributes": [],
31662
31972
  "interfaces": []
@@ -35690,6 +36000,93 @@
35690
36000
  }],
35691
36001
  "attributes": [],
35692
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."
35693
36090
  }, {
35694
36091
  "name": "organization_token",
35695
36092
  "plural": "organization_tokens",
@@ -38913,6 +39310,13 @@
38913
39310
  "attributes": [],
38914
39311
  "annotations": [],
38915
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"
38916
39320
  }],
38917
39321
  "attributes": [],
38918
39322
  "interfaces": []
@@ -41350,7 +41754,7 @@
41350
41754
  "description": "The harmonization HS6 code."
41351
41755
  }, {
41352
41756
  "name": "restricted_regions_by_type",
41353
- "type": "[sellablility_region_result]",
41757
+ "type": "[sellability_region_result]",
41354
41758
  "required": false,
41355
41759
  "attributes": [],
41356
41760
  "annotations": [],
@@ -41462,7 +41866,7 @@
41462
41866
  "description": "The low-fi HS6 code for the product to be used pending full classification and a higher fidelity (HS10) code."
41463
41867
  }, {
41464
41868
  "name": "restricted_regions",
41465
- "type": "[sellablility_region_result]",
41869
+ "type": "[sellability_region_result]",
41466
41870
  "required": true,
41467
41871
  "attributes": [],
41468
41872
  "annotations": [],
@@ -41533,6 +41937,118 @@
41533
41937
  "attributes": [],
41534
41938
  "interfaces": [],
41535
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": []
41536
42052
  }, {
41537
42053
  "name": "product_taxonomy_category",
41538
42054
  "plural": "product_taxonomy_categories",
@@ -42658,6 +43174,12 @@
42658
43174
  "required": false,
42659
43175
  "attributes": [],
42660
43176
  "annotations": []
43177
+ }, {
43178
+ "name": "commercial_invoice_mode",
43179
+ "type": "commercial_invoice_mode",
43180
+ "required": false,
43181
+ "attributes": [],
43182
+ "annotations": []
42661
43183
  }],
42662
43184
  "attributes": [],
42663
43185
  "interfaces": []
@@ -45568,55 +46090,6 @@
45568
46090
  }],
45569
46091
  "attributes": [],
45570
46092
  "interfaces": []
45571
- }, {
45572
- "name": "rohan_item_deleted",
45573
- "plural": "rohan_item_deleteds",
45574
- "fields": [{
45575
- "name": "event_id",
45576
- "type": "string",
45577
- "required": true,
45578
- "attributes": [],
45579
- "annotations": []
45580
- }, {
45581
- "name": "timestamp",
45582
- "type": "date-time-iso8601",
45583
- "required": true,
45584
- "attributes": [],
45585
- "annotations": []
45586
- }, {
45587
- "name": "id",
45588
- "type": "string",
45589
- "required": true,
45590
- "attributes": [],
45591
- "annotations": [],
45592
- "description": "Globally unique identifier"
45593
- }],
45594
- "attributes": [],
45595
- "interfaces": []
45596
- }, {
45597
- "name": "rohan_item_upserted",
45598
- "plural": "rohan_item_upserteds",
45599
- "fields": [{
45600
- "name": "event_id",
45601
- "type": "string",
45602
- "required": true,
45603
- "attributes": [],
45604
- "annotations": []
45605
- }, {
45606
- "name": "timestamp",
45607
- "type": "date-time-iso8601",
45608
- "required": true,
45609
- "attributes": [],
45610
- "annotations": []
45611
- }, {
45612
- "name": "item",
45613
- "type": "io.flow.tech.onboarding.playground.v0.models.rohan_item",
45614
- "required": true,
45615
- "attributes": [],
45616
- "annotations": []
45617
- }],
45618
- "attributes": [],
45619
- "interfaces": []
45620
46093
  }, {
45621
46094
  "name": "romanization",
45622
46095
  "plural": "romanizations",
@@ -45714,55 +46187,6 @@
45714
46187
  }],
45715
46188
  "attributes": [],
45716
46189
  "interfaces": []
45717
- }, {
45718
- "name": "sarvesh_item_deleted",
45719
- "plural": "sarvesh_item_deleteds",
45720
- "fields": [{
45721
- "name": "event_id",
45722
- "type": "string",
45723
- "required": true,
45724
- "attributes": [],
45725
- "annotations": []
45726
- }, {
45727
- "name": "timestamp",
45728
- "type": "date-time-iso8601",
45729
- "required": true,
45730
- "attributes": [],
45731
- "annotations": []
45732
- }, {
45733
- "name": "id",
45734
- "type": "string",
45735
- "required": true,
45736
- "attributes": [],
45737
- "annotations": [],
45738
- "description": "Globally unique identifier"
45739
- }],
45740
- "attributes": [],
45741
- "interfaces": []
45742
- }, {
45743
- "name": "sarvesh_item_upserted",
45744
- "plural": "sarvesh_item_upserteds",
45745
- "fields": [{
45746
- "name": "event_id",
45747
- "type": "string",
45748
- "required": true,
45749
- "attributes": [],
45750
- "annotations": []
45751
- }, {
45752
- "name": "timestamp",
45753
- "type": "date-time-iso8601",
45754
- "required": true,
45755
- "attributes": [],
45756
- "annotations": []
45757
- }, {
45758
- "name": "item",
45759
- "type": "io.flow.tech.onboarding.playground.v0.models.sarvesh_item",
45760
- "required": true,
45761
- "attributes": [],
45762
- "annotations": []
45763
- }],
45764
- "attributes": [],
45765
- "interfaces": []
45766
46190
  }, {
45767
46191
  "name": "schedule",
45768
46192
  "plural": "schedules",
@@ -46007,6 +46431,27 @@
46007
46431
  }],
46008
46432
  "attributes": [],
46009
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."
46010
46455
  }, {
46011
46456
  "name": "sellability_error",
46012
46457
  "plural": "sellability_errors",
@@ -46032,6 +46477,213 @@
46032
46477
  }],
46033
46478
  "interfaces": [],
46034
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."
46035
46687
  }, {
46036
46688
  "name": "sellablility_region_result",
46037
46689
  "plural": "sellablility_region_results",
@@ -46051,7 +46703,10 @@
46051
46703
  }],
46052
46704
  "attributes": [],
46053
46705
  "interfaces": [],
46054
- "description": "The product information we should return to client for sellability result"
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
+ }
46055
46710
  }, {
46056
46711
  "name": "service_reference",
46057
46712
  "plural": "service_references",
@@ -47884,6 +48539,209 @@
47884
48539
  }],
47885
48540
  "attributes": [],
47886
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"
47887
48745
  }, {
47888
48746
  "name": "shop",
47889
48747
  "plural": "shops",
@@ -48873,6 +49731,12 @@
48873
49731
  "required": false,
48874
49732
  "attributes": [],
48875
49733
  "annotations": []
49734
+ }, {
49735
+ "name": "average_order_weight_unit",
49736
+ "type": "unit_of_measurement",
49737
+ "required": false,
49738
+ "attributes": [],
49739
+ "annotations": []
48876
49740
  }, {
48877
49741
  "name": "package_dimensions",
48878
49742
  "type": "[dimension]",
@@ -49072,6 +49936,12 @@
49072
49936
  "required": false,
49073
49937
  "attributes": [],
49074
49938
  "annotations": []
49939
+ }, {
49940
+ "name": "average_order_weight_unit",
49941
+ "type": "unit_of_measurement",
49942
+ "required": false,
49943
+ "attributes": [],
49944
+ "annotations": []
49075
49945
  }, {
49076
49946
  "name": "package_dimensions",
49077
49947
  "type": "[dimension]",
@@ -49723,6 +50593,24 @@
49723
50593
  }],
49724
50594
  "attributes": [],
49725
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": []
49726
50614
  }, {
49727
50615
  "name": "statement_upserted",
49728
50616
  "plural": "statement_upserteds",
@@ -50446,6 +51334,49 @@
50446
51334
  "attributes": [],
50447
51335
  "interfaces": [],
50448
51336
  "description": "Represents a simple model of taxes that apply to a given item / destination."
51337
+ }, {
51338
+ "name": "tax_breakdown",
51339
+ "plural": "tax_breakdowns",
51340
+ "fields": [{
51341
+ "name": "label",
51342
+ "type": "string",
51343
+ "required": true,
51344
+ "attributes": [],
51345
+ "annotations": [],
51346
+ "description": "Tax line label (e.g., 'GST', 'QST', etc.)"
51347
+ }, {
51348
+ "name": "calculated_tax",
51349
+ "type": "money",
51350
+ "required": true,
51351
+ "attributes": [],
51352
+ "annotations": [],
51353
+ "description": "Calculated tax amount"
51354
+ }, {
51355
+ "name": "rate",
51356
+ "type": "decimal",
51357
+ "required": true,
51358
+ "attributes": [],
51359
+ "annotations": [],
51360
+ "description": "Tax rate as decimal (e.g., 0.05 for 5%)",
51361
+ "example": "0.05"
51362
+ }, {
51363
+ "name": "line_total",
51364
+ "type": "money",
51365
+ "required": true,
51366
+ "attributes": [],
51367
+ "annotations": [],
51368
+ "description": "Line item total amount for reporting purposes"
51369
+ }, {
51370
+ "name": "jurisdiction_type",
51371
+ "type": "tax_jurisdiction_type",
51372
+ "required": true,
51373
+ "attributes": [],
51374
+ "annotations": [],
51375
+ "description": "Jurisdiction level (country for federal, province for provincial)"
51376
+ }],
51377
+ "attributes": [],
51378
+ "interfaces": [],
51379
+ "description": "Detailed tax breakdown with jurisdiction and type information"
50449
51380
  }, {
50450
51381
  "name": "tax_duty_calculator_validation_error",
50451
51382
  "plural": "tax_duty_calculator_validation_errors",
@@ -50995,6 +51926,78 @@
50995
51926
  "attributes": [],
50996
51927
  "interfaces": [],
50997
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)."
50998
52001
  }, {
50999
52002
  "name": "tax_registration_form",
51000
52003
  "plural": "tax_registration_forms",
@@ -51014,6 +52017,38 @@
51014
52017
  }],
51015
52018
  "attributes": [],
51016
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"
51017
52052
  }, {
51018
52053
  "name": "tax_report",
51019
52054
  "plural": "tax_reports",
@@ -52327,6 +53362,120 @@
52327
53362
  }],
52328
53363
  "attributes": [],
52329
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": []
52330
53479
  }, {
52331
53480
  "name": "tracking_label_form",
52332
53481
  "plural": "tracking_label_forms",
@@ -53060,6 +54209,84 @@
53060
54209
  "required": true,
53061
54210
  "attributes": [],
53062
54211
  "annotations": []
54212
+ }, {
54213
+ "name": "local_currency",
54214
+ "type": "string",
54215
+ "required": false,
54216
+ "attributes": [],
54217
+ "annotations": []
54218
+ }, {
54219
+ "name": "actual",
54220
+ "type": "transaction_metadata_tax_duty_actual",
54221
+ "required": false,
54222
+ "attributes": [],
54223
+ "annotations": []
54224
+ }, {
54225
+ "name": "estimate",
54226
+ "type": "transaction_metadata_tax_duty_estimate",
54227
+ "required": false,
54228
+ "attributes": [],
54229
+ "annotations": []
54230
+ }, {
54231
+ "name": "delta",
54232
+ "type": "transaction_metadata_tax_duty_delta",
54233
+ "required": false,
54234
+ "attributes": [],
54235
+ "annotations": []
54236
+ }],
54237
+ "attributes": [],
54238
+ "interfaces": []
54239
+ }, {
54240
+ "name": "transaction_metadata_tax_duty_actual",
54241
+ "plural": "transaction_metadata_tax_duty_actuals",
54242
+ "fields": [{
54243
+ "name": "base",
54244
+ "type": "decimal",
54245
+ "required": false,
54246
+ "attributes": [],
54247
+ "annotations": []
54248
+ }, {
54249
+ "name": "local",
54250
+ "type": "decimal",
54251
+ "required": false,
54252
+ "attributes": [],
54253
+ "annotations": []
54254
+ }],
54255
+ "attributes": [],
54256
+ "interfaces": []
54257
+ }, {
54258
+ "name": "transaction_metadata_tax_duty_delta",
54259
+ "plural": "transaction_metadata_tax_duty_deltas",
54260
+ "fields": [{
54261
+ "name": "base",
54262
+ "type": "decimal",
54263
+ "required": false,
54264
+ "attributes": [],
54265
+ "annotations": []
54266
+ }, {
54267
+ "name": "local",
54268
+ "type": "decimal",
54269
+ "required": false,
54270
+ "attributes": [],
54271
+ "annotations": []
54272
+ }],
54273
+ "attributes": [],
54274
+ "interfaces": []
54275
+ }, {
54276
+ "name": "transaction_metadata_tax_duty_estimate",
54277
+ "plural": "transaction_metadata_tax_duty_estimates",
54278
+ "fields": [{
54279
+ "name": "base",
54280
+ "type": "decimal",
54281
+ "required": false,
54282
+ "attributes": [],
54283
+ "annotations": []
54284
+ }, {
54285
+ "name": "local",
54286
+ "type": "decimal",
54287
+ "required": false,
54288
+ "attributes": [],
54289
+ "annotations": []
53063
54290
  }],
53064
54291
  "attributes": [],
53065
54292
  "interfaces": []
@@ -62932,6 +64159,85 @@
62932
64159
  }],
62933
64160
  "path": "/:organization/shipping-notifications",
62934
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"
62935
64241
  }, {
62936
64242
  "type": "surcharge_setting",
62937
64243
  "plural": "surcharge_settings",
@@ -68136,6 +69442,63 @@
68136
69442
  "attributes": []
68137
69443
  }],
68138
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
+ }
68139
69502
  }],
68140
69503
  "attributes": [{
68141
69504
  "name": "docs",
@@ -76545,6 +77908,179 @@
76545
77908
  }],
76546
77909
  "path": "/:organization/billing/pending/payout/transactions",
76547
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."
76548
78084
  }, {
76549
78085
  "type": "organization_token",
76550
78086
  "plural": "organization_tokens",
@@ -78196,7 +79732,7 @@
78196
79732
  "attributes": [],
78197
79733
  "description": "Get the sellability of product",
78198
79734
  "body": {
78199
- "type": "product_sellability_form",
79735
+ "type": "sellability_request",
78200
79736
  "attributes": []
78201
79737
  }
78202
79738
  }],
@@ -80704,7 +82240,7 @@
80704
82240
  "description": "Identifies a field that contains data that must be handled in a way that is compliant with the PCI standard."
80705
82241
  }],
80706
82242
  "apidoc": {
80707
- "version": "0.20.63"
82243
+ "version": "0.21.14"
80708
82244
  },
80709
82245
  "base_url": "https://api.flow.io",
80710
82246
  "description": "The Flow Commerce REST API provides full access to the global ecommerce platform."