@flowio/api-mock-generator 6.17.53 → 6.17.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.json +1148 -103
- package/package.json +2 -2
- package/src/api.json +1148 -103
package/dist/api.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"key": "api"
|
|
11
11
|
},
|
|
12
12
|
"namespace": "io.flow.v0",
|
|
13
|
-
"version": "0.17.
|
|
13
|
+
"version": "0.17.60",
|
|
14
14
|
"info": {
|
|
15
15
|
"license": {
|
|
16
16
|
"name": "MIT",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"application": {
|
|
32
32
|
"key": "apple-pay"
|
|
33
33
|
},
|
|
34
|
-
"version": "0.3.
|
|
34
|
+
"version": "0.3.28",
|
|
35
35
|
"enums": ["apple_pay_contact_field", "apple_pay_line_item_type", "apple_pay_merchant_capability", "apple_pay_shipping_type", "apple_pay_supported_networks"],
|
|
36
36
|
"interfaces": [],
|
|
37
37
|
"unions": [],
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"application": {
|
|
47
47
|
"key": "google-pay"
|
|
48
48
|
},
|
|
49
|
-
"version": "0.3.
|
|
49
|
+
"version": "0.3.28",
|
|
50
50
|
"enums": ["auth_method", "billing_address_format", "card_gateway", "card_network", "payment_method_type", "tokenization_type", "total_price_status"],
|
|
51
51
|
"interfaces": [],
|
|
52
52
|
"unions": ["payment_method_token"],
|
|
@@ -61,12 +61,42 @@
|
|
|
61
61
|
"application": {
|
|
62
62
|
"key": "shopify-external"
|
|
63
63
|
},
|
|
64
|
-
"version": "0.3.
|
|
64
|
+
"version": "0.3.28",
|
|
65
65
|
"enums": ["cancel_reason", "discount_status", "discount_type", "discrepancy_reason", "event", "financial_status_type", "format", "fulfillment_service", "fulfillment_status_type", "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_processing_method_type", "shopify_transaction_error_code", "shopify_transaction_status", "topic", "value_type", "weight_unit"],
|
|
66
66
|
"interfaces": [],
|
|
67
67
|
"unions": [],
|
|
68
68
|
"models": ["collection", "collection_webhook", "count", "metafield", "metafield_form", "option", "price_rule", "price_rule_discount_code", "price_rule_form", "price_rule_greater_than_range", "price_rule_less_than_range", "price_rule_prerequisite_to_entitlement_purchase", "price_rule_prerequisite_to_entitlement_quantity_ratio", "product", "product_delete", "product_image", "product_variant", "request_metafield_form", "request_shopify_gift_card", "request_shopify_refund_form", "request_shopify_transaction_form", "response_collection", "response_metafield", "response_metafields", "response_orders_wrapper", "response_price_rule", "response_price_rule_discount_code", "response_price_rule_discount_codes", "response_price_rules", "response_product", "response_products", "response_shopify_gift_card", "response_shopify_gift_cards", "response_shopify_refund_single", "response_shopify_transaction", "response_shopify_transaction_single", "response_smart_collection", "response_variant", "shop", "shop_response", "shopify_address", "shopify_attribute", "shopify_cart_item_discount", "shopify_client_detail", "shopify_customer", "shopify_customer_address", "shopify_customer_delete", "shopify_customers_response_wrapper", "shopify_discount_application", "shopify_discount_code", "shopify_error", "shopify_external_cart", "shopify_external_cart_item", "shopify_fulfillment", "shopify_fulfillment_wrapper", "shopify_gift_card", "shopify_gift_card_adjustment", "shopify_gift_card_adjustment_form", "shopify_gift_card_adjustment_form_wrapper", "shopify_gift_card_adjustment_response_wrapper", "shopify_gift_card_adjustments_response_wrapper", "shopify_gift_card_form", "shopify_inventory_item", "shopify_inventory_item_delete", "shopify_inventory_level", "shopify_inventory_level_disconnect", "shopify_inventory_level_response_wrapper", "shopify_line_item", "shopify_line_item_form", "shopify_line_level_discount_allocation", "shopify_location", "shopify_location_delete", "shopify_locations_response_wrapper", "shopify_order", "shopify_order_count", "shopify_order_customer", "shopify_order_wrapper", "shopify_payment_detail", "shopify_property", "shopify_refund", "shopify_refund_form", "shopify_refund_line_item", "shopify_refund_line_item_form", "shopify_shipping_line", "shopify_tax_line", "shopify_transaction", "shopify_transaction_form", "shopify_transaction_gift_card_receipt", "shopify_webhook_customers_redact", "shopify_webhook_customers_redact_customer", "shopify_webhook_order", "shopify_webhook_order_cancelled", "shopify_webhook_order_line_item", "shopify_webhook_shop_redact", "smart_collection", "webhook", "webhook_form", "webhook_form_wrapper", "webhook_response_list", "webhook_response_single"],
|
|
69
69
|
"annotations": []
|
|
70
|
+
}, {
|
|
71
|
+
"uri": "https://app.apibuilder.io/flow/billing-true-up/latest/service.json",
|
|
72
|
+
"namespace": "io.flow.billing.true.up.v0",
|
|
73
|
+
"organization": {
|
|
74
|
+
"key": "flow"
|
|
75
|
+
},
|
|
76
|
+
"application": {
|
|
77
|
+
"key": "billing-true-up"
|
|
78
|
+
},
|
|
79
|
+
"version": "0.19.64",
|
|
80
|
+
"enums": ["true_up_surcharge_type", "weight_selection"],
|
|
81
|
+
"interfaces": [],
|
|
82
|
+
"unions": ["label_surcharge_detail"],
|
|
83
|
+
"models": ["label_base", "label_destination", "label_invoice_request", "label_metadata", "label_surcharge", "label_surcharge_detail_flat", "label_surcharge_detail_per_weight_unit", "label_surcharge_detail_percentage", "label_units", "metadata_proposition", "metadata_ratecard", "metadata_weights", "shipping_method_reference", "true_up_label_summary", "weights_dead", "weights_dimensional"],
|
|
84
|
+
"annotations": []
|
|
85
|
+
}, {
|
|
86
|
+
"uri": "https://app.apibuilder.io/flow/ben-test-internal/latest/service.json",
|
|
87
|
+
"namespace": "io.flow.ben.test.internal.v0",
|
|
88
|
+
"organization": {
|
|
89
|
+
"key": "flow"
|
|
90
|
+
},
|
|
91
|
+
"application": {
|
|
92
|
+
"key": "ben-test-internal"
|
|
93
|
+
},
|
|
94
|
+
"version": "0.19.58",
|
|
95
|
+
"enums": [],
|
|
96
|
+
"interfaces": ["generate_load"],
|
|
97
|
+
"unions": ["generate_load"],
|
|
98
|
+
"models": ["generate_load_multiple_orgs", "generate_load_single_org", "test", "test_form"],
|
|
99
|
+
"annotations": []
|
|
70
100
|
}],
|
|
71
101
|
"enums": [{
|
|
72
102
|
"name": "abandoned_order_promotion_status",
|
|
@@ -1197,6 +1227,9 @@
|
|
|
1197
1227
|
"values": [{
|
|
1198
1228
|
"name": "test_upserted",
|
|
1199
1229
|
"attributes": []
|
|
1230
|
+
}, {
|
|
1231
|
+
"name": "generate_load",
|
|
1232
|
+
"attributes": []
|
|
1200
1233
|
}, {
|
|
1201
1234
|
"name": "transaction_upserted",
|
|
1202
1235
|
"attributes": []
|
|
@@ -3303,6 +3336,19 @@
|
|
|
3303
3336
|
"attributes": []
|
|
3304
3337
|
}],
|
|
3305
3338
|
"attributes": []
|
|
3339
|
+
}, {
|
|
3340
|
+
"name": "package_dimensions_source",
|
|
3341
|
+
"plural": "package_dimensions_sources",
|
|
3342
|
+
"values": [{
|
|
3343
|
+
"name": "provided",
|
|
3344
|
+
"attributes": [],
|
|
3345
|
+
"description": "Package dimensions provided by caller to API"
|
|
3346
|
+
}, {
|
|
3347
|
+
"name": "dimensions_estimated",
|
|
3348
|
+
"attributes": [],
|
|
3349
|
+
"description": "Dimension estimates were used to assume package dimensions"
|
|
3350
|
+
}],
|
|
3351
|
+
"attributes": []
|
|
3306
3352
|
}, {
|
|
3307
3353
|
"name": "payment_action_type",
|
|
3308
3354
|
"plural": "payment_action_types",
|
|
@@ -3731,6 +3777,24 @@
|
|
|
3731
3777
|
}],
|
|
3732
3778
|
"attributes": [],
|
|
3733
3779
|
"description": "Local terminology for postal codes"
|
|
3780
|
+
}, {
|
|
3781
|
+
"name": "preferred_service_selection_strategy",
|
|
3782
|
+
"plural": "preferred_service_selection_strategies",
|
|
3783
|
+
"values": [{
|
|
3784
|
+
"name": "calculated_rate",
|
|
3785
|
+
"attributes": [],
|
|
3786
|
+
"description": "The shipping line code was a known carrier service code e.g. P = dhl-express-worldwide, OLT = dhl-parcel-international-direct"
|
|
3787
|
+
}, {
|
|
3788
|
+
"name": "flat_rate",
|
|
3789
|
+
"attributes": [],
|
|
3790
|
+
"description": "We detected that the shipping lines code and the delivered duty were a match for a known code/delivered duty pair used to imply flat rate shipping for a service"
|
|
3791
|
+
}, {
|
|
3792
|
+
"name": "custom_rate",
|
|
3793
|
+
"attributes": [],
|
|
3794
|
+
"description": "Some other value was used so we used the fallback service id"
|
|
3795
|
+
}],
|
|
3796
|
+
"attributes": [],
|
|
3797
|
+
"description": "Describes how we selected the preferred service from the incoming shipping lines data"
|
|
3734
3798
|
}, {
|
|
3735
3799
|
"name": "price_accuracy",
|
|
3736
3800
|
"plural": "price_accuracies",
|
|
@@ -4396,6 +4460,20 @@
|
|
|
4396
4460
|
"attributes": []
|
|
4397
4461
|
}],
|
|
4398
4462
|
"attributes": []
|
|
4463
|
+
}, {
|
|
4464
|
+
"name": "stored_method_usage_step",
|
|
4465
|
+
"plural": "stored_method_usage_steps",
|
|
4466
|
+
"values": [{
|
|
4467
|
+
"name": "initial",
|
|
4468
|
+
"attributes": [],
|
|
4469
|
+
"description": "The first transaction in a sequence such as performing a checkout with a card that you might save later."
|
|
4470
|
+
}, {
|
|
4471
|
+
"name": "subsequent",
|
|
4472
|
+
"attributes": [],
|
|
4473
|
+
"description": "A checkout transaction using stored payment method information e.g. a tokenized card or a card vaulted on an external platform."
|
|
4474
|
+
}],
|
|
4475
|
+
"attributes": [],
|
|
4476
|
+
"description": "For payment methods that can be stored, this is the step in storage process that we used when communicating to the PSP."
|
|
4399
4477
|
}, {
|
|
4400
4478
|
"name": "strategy",
|
|
4401
4479
|
"plural": "strategies",
|
|
@@ -4811,6 +4889,29 @@
|
|
|
4811
4889
|
"attributes": []
|
|
4812
4890
|
}],
|
|
4813
4891
|
"attributes": []
|
|
4892
|
+
}, {
|
|
4893
|
+
"name": "transaction_payout_pending_reason",
|
|
4894
|
+
"plural": "transaction_payout_pending_reasons",
|
|
4895
|
+
"values": [{
|
|
4896
|
+
"name": "waiting_for_full_refund",
|
|
4897
|
+
"attributes": []
|
|
4898
|
+
}, {
|
|
4899
|
+
"name": "waiting_for_fulfillment",
|
|
4900
|
+
"attributes": []
|
|
4901
|
+
}, {
|
|
4902
|
+
"name": "waiting_for_in_transit",
|
|
4903
|
+
"attributes": []
|
|
4904
|
+
}, {
|
|
4905
|
+
"name": "waiting_for_next_payout_date",
|
|
4906
|
+
"attributes": []
|
|
4907
|
+
}, {
|
|
4908
|
+
"name": "external_fulfillment_missing_tracking_info",
|
|
4909
|
+
"attributes": []
|
|
4910
|
+
}, {
|
|
4911
|
+
"name": "waiting_for_positive_account_balance",
|
|
4912
|
+
"attributes": []
|
|
4913
|
+
}],
|
|
4914
|
+
"attributes": []
|
|
4814
4915
|
}, {
|
|
4815
4916
|
"name": "transaction_source",
|
|
4816
4917
|
"plural": "transaction_sources",
|
|
@@ -4873,6 +4974,31 @@
|
|
|
4873
4974
|
"attributes": []
|
|
4874
4975
|
}],
|
|
4875
4976
|
"attributes": []
|
|
4977
|
+
}, {
|
|
4978
|
+
"name": "unit_of_length",
|
|
4979
|
+
"plural": "unit_of_lengths",
|
|
4980
|
+
"values": [{
|
|
4981
|
+
"name": "millimeter",
|
|
4982
|
+
"attributes": [],
|
|
4983
|
+
"description": "Equivalent to MILLI(METRE)."
|
|
4984
|
+
}, {
|
|
4985
|
+
"name": "centimeter",
|
|
4986
|
+
"attributes": [],
|
|
4987
|
+
"description": "Equivalent to CENTI(METRE)."
|
|
4988
|
+
}, {
|
|
4989
|
+
"name": "inch",
|
|
4990
|
+
"attributes": [],
|
|
4991
|
+
"description": "A unit of length equal to 0.0254 m (standard name in)."
|
|
4992
|
+
}, {
|
|
4993
|
+
"name": "foot",
|
|
4994
|
+
"attributes": [],
|
|
4995
|
+
"description": "A unit of length equal to 0.3048 m (standard name ft)."
|
|
4996
|
+
}, {
|
|
4997
|
+
"name": "meter",
|
|
4998
|
+
"attributes": [],
|
|
4999
|
+
"description": "The base unit for length quantities (m)."
|
|
5000
|
+
}],
|
|
5001
|
+
"attributes": []
|
|
4876
5002
|
}, {
|
|
4877
5003
|
"name": "unit_of_measurement",
|
|
4878
5004
|
"plural": "unit_of_measurements",
|
|
@@ -4947,6 +5073,40 @@
|
|
|
4947
5073
|
}],
|
|
4948
5074
|
"attributes": [],
|
|
4949
5075
|
"description": "Defines the units of time that we support"
|
|
5076
|
+
}, {
|
|
5077
|
+
"name": "unit_of_volume",
|
|
5078
|
+
"plural": "unit_of_volumes",
|
|
5079
|
+
"values": [{
|
|
5080
|
+
"name": "cubic_inch",
|
|
5081
|
+
"attributes": [],
|
|
5082
|
+
"description": "A unit of volume equal to one cubic inch (in³)."
|
|
5083
|
+
}, {
|
|
5084
|
+
"name": "cubic_meter",
|
|
5085
|
+
"attributes": [],
|
|
5086
|
+
"description": "The metric unit for volume quantities (m³)."
|
|
5087
|
+
}],
|
|
5088
|
+
"attributes": []
|
|
5089
|
+
}, {
|
|
5090
|
+
"name": "unit_of_weight",
|
|
5091
|
+
"plural": "unit_of_weights",
|
|
5092
|
+
"values": [{
|
|
5093
|
+
"name": "gram",
|
|
5094
|
+
"attributes": [],
|
|
5095
|
+
"description": "A unit of mass equal to 1 / 1000 kilogram (standard name g)."
|
|
5096
|
+
}, {
|
|
5097
|
+
"name": "kilogram",
|
|
5098
|
+
"attributes": [],
|
|
5099
|
+
"description": "The base unit for mass quantities (kg)."
|
|
5100
|
+
}, {
|
|
5101
|
+
"name": "ounce",
|
|
5102
|
+
"attributes": [],
|
|
5103
|
+
"description": "A unit of mass equal to 1 / 16 POUND (standard name oz)."
|
|
5104
|
+
}, {
|
|
5105
|
+
"name": "pound",
|
|
5106
|
+
"attributes": [],
|
|
5107
|
+
"description": "A unit of mass equal to 453.59237 grams (avoirdupois pound, standard name lb)."
|
|
5108
|
+
}],
|
|
5109
|
+
"attributes": []
|
|
4950
5110
|
}, {
|
|
4951
5111
|
"name": "update_policy",
|
|
4952
5112
|
"plural": "update_policies",
|
|
@@ -5027,6 +5187,9 @@
|
|
|
5027
5187
|
}, {
|
|
5028
5188
|
"name": "failure",
|
|
5029
5189
|
"attributes": []
|
|
5190
|
+
}, {
|
|
5191
|
+
"name": "ignored",
|
|
5192
|
+
"attributes": []
|
|
5030
5193
|
}],
|
|
5031
5194
|
"attributes": []
|
|
5032
5195
|
}, {
|
|
@@ -5325,6 +5488,13 @@
|
|
|
5325
5488
|
"attributes": [],
|
|
5326
5489
|
"annotations": [],
|
|
5327
5490
|
"description": "The amount/currency of the authorization in base currency. Added in Summer 2018 and always present since then."
|
|
5491
|
+
}, {
|
|
5492
|
+
"name": "authorized_at",
|
|
5493
|
+
"type": "date-time-iso8601",
|
|
5494
|
+
"required": false,
|
|
5495
|
+
"attributes": [],
|
|
5496
|
+
"annotations": [],
|
|
5497
|
+
"description": "Indicates when the authorization was successfully authorized by the payment provider"
|
|
5328
5498
|
}],
|
|
5329
5499
|
"attributes": []
|
|
5330
5500
|
}, {
|
|
@@ -5645,6 +5815,12 @@
|
|
|
5645
5815
|
"attributes": [],
|
|
5646
5816
|
"annotations": [],
|
|
5647
5817
|
"description": "Globally unique identifier"
|
|
5818
|
+
}, {
|
|
5819
|
+
"name": "metadata",
|
|
5820
|
+
"type": "transaction_metadata",
|
|
5821
|
+
"required": false,
|
|
5822
|
+
"attributes": [],
|
|
5823
|
+
"annotations": []
|
|
5648
5824
|
}, {
|
|
5649
5825
|
"name": "order",
|
|
5650
5826
|
"type": "billing_channel_order_summary",
|
|
@@ -6099,6 +6275,30 @@
|
|
|
6099
6275
|
"annotations": []
|
|
6100
6276
|
}],
|
|
6101
6277
|
"attributes": []
|
|
6278
|
+
}, {
|
|
6279
|
+
"name": "transaction_payout",
|
|
6280
|
+
"plural": "transaction_payouts",
|
|
6281
|
+
"fields": [{
|
|
6282
|
+
"name": "transaction",
|
|
6283
|
+
"type": "transaction_reference",
|
|
6284
|
+
"required": true,
|
|
6285
|
+
"attributes": [],
|
|
6286
|
+
"annotations": []
|
|
6287
|
+
}, {
|
|
6288
|
+
"name": "waiting_for",
|
|
6289
|
+
"type": "transaction_payout_pending_reason",
|
|
6290
|
+
"required": false,
|
|
6291
|
+
"attributes": [],
|
|
6292
|
+
"annotations": []
|
|
6293
|
+
}, {
|
|
6294
|
+
"name": "payout",
|
|
6295
|
+
"type": "payout_reference",
|
|
6296
|
+
"required": false,
|
|
6297
|
+
"attributes": [],
|
|
6298
|
+
"annotations": []
|
|
6299
|
+
}],
|
|
6300
|
+
"attributes": [],
|
|
6301
|
+
"description": "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
|
|
6102
6302
|
}],
|
|
6103
6303
|
"unions": [{
|
|
6104
6304
|
"name": "abandoned_order_promotion_details",
|
|
@@ -6670,6 +6870,10 @@
|
|
|
6670
6870
|
"type": "test_upserted",
|
|
6671
6871
|
"attributes": [],
|
|
6672
6872
|
"discriminator_value": "test_upserted"
|
|
6873
|
+
}, {
|
|
6874
|
+
"type": "generate_load",
|
|
6875
|
+
"attributes": [],
|
|
6876
|
+
"discriminator_value": "generate_load"
|
|
6673
6877
|
}, {
|
|
6674
6878
|
"type": "transaction_upserted",
|
|
6675
6879
|
"attributes": [],
|
|
@@ -7928,6 +8132,10 @@
|
|
|
7928
8132
|
"type": "merchant_activated",
|
|
7929
8133
|
"attributes": [],
|
|
7930
8134
|
"discriminator_value": "merchant_activated"
|
|
8135
|
+
}, {
|
|
8136
|
+
"type": "merchant_deactivated",
|
|
8137
|
+
"attributes": [],
|
|
8138
|
+
"discriminator_value": "merchant_deactivated"
|
|
7931
8139
|
}],
|
|
7932
8140
|
"attributes": [],
|
|
7933
8141
|
"interfaces": [],
|
|
@@ -8497,9 +8705,9 @@
|
|
|
8497
8705
|
"attributes": [],
|
|
8498
8706
|
"discriminator_value": "fuel_surcharge_ratecard_fee"
|
|
8499
8707
|
}, {
|
|
8500
|
-
"type": "
|
|
8708
|
+
"type": "oversize_piece_surcharge_ratecard_fee",
|
|
8501
8709
|
"attributes": [],
|
|
8502
|
-
"discriminator_value": "
|
|
8710
|
+
"discriminator_value": "oversize_piece_surcharge_ratecard_fee"
|
|
8503
8711
|
}, {
|
|
8504
8712
|
"type": "return_package_ratecard_fee",
|
|
8505
8713
|
"attributes": [],
|
|
@@ -8656,6 +8864,10 @@
|
|
|
8656
8864
|
"type": "duties_taxes_paid_surcharge_service_fee",
|
|
8657
8865
|
"attributes": [],
|
|
8658
8866
|
"discriminator_value": "duties_taxes_paid_surcharge_service_fee"
|
|
8867
|
+
}, {
|
|
8868
|
+
"type": "oversize_piece_surcharge_service_fee",
|
|
8869
|
+
"attributes": [],
|
|
8870
|
+
"discriminator_value": "oversize_piece_surcharge_service_fee"
|
|
8659
8871
|
}],
|
|
8660
8872
|
"attributes": [],
|
|
8661
8873
|
"interfaces": [],
|
|
@@ -8929,6 +9141,18 @@
|
|
|
8929
9141
|
"attributes": [],
|
|
8930
9142
|
"interfaces": [],
|
|
8931
9143
|
"discriminator": "type"
|
|
9144
|
+
}, {
|
|
9145
|
+
"name": "transaction_metadata",
|
|
9146
|
+
"plural": "transaction_metadata",
|
|
9147
|
+
"types": [{
|
|
9148
|
+
"type": "transaction_metadata_shipping_label",
|
|
9149
|
+
"attributes": [],
|
|
9150
|
+
"default": false,
|
|
9151
|
+
"discriminator_value": "shipping_label"
|
|
9152
|
+
}],
|
|
9153
|
+
"attributes": [],
|
|
9154
|
+
"interfaces": [],
|
|
9155
|
+
"discriminator": "discriminator"
|
|
8932
9156
|
}],
|
|
8933
9157
|
"models": [{
|
|
8934
9158
|
"name": "abandoned_order_email_settings",
|
|
@@ -13411,6 +13635,20 @@
|
|
|
13411
13635
|
"attributes": [],
|
|
13412
13636
|
"annotations": [],
|
|
13413
13637
|
"description": "Details about which payment processor was used for this authorization"
|
|
13638
|
+
}, {
|
|
13639
|
+
"name": "stored_method_usage_step",
|
|
13640
|
+
"type": "stored_method_usage_step",
|
|
13641
|
+
"required": false,
|
|
13642
|
+
"attributes": [],
|
|
13643
|
+
"annotations": [],
|
|
13644
|
+
"description": "For payment methods that can be stored, this is the step in storage process that we used when communicating to the PSP."
|
|
13645
|
+
}, {
|
|
13646
|
+
"name": "authorized_at",
|
|
13647
|
+
"type": "date-time-iso8601",
|
|
13648
|
+
"required": false,
|
|
13649
|
+
"attributes": [],
|
|
13650
|
+
"annotations": [],
|
|
13651
|
+
"description": "Indicates when the authorization was successfully authorized by the payment provider"
|
|
13414
13652
|
}],
|
|
13415
13653
|
"attributes": [],
|
|
13416
13654
|
"interfaces": ["authorization"],
|
|
@@ -15811,6 +16049,12 @@
|
|
|
15811
16049
|
"attributes": [],
|
|
15812
16050
|
"annotations": [],
|
|
15813
16051
|
"description": "Globally unique identifier"
|
|
16052
|
+
}, {
|
|
16053
|
+
"name": "metadata",
|
|
16054
|
+
"type": "transaction_metadata",
|
|
16055
|
+
"required": false,
|
|
16056
|
+
"attributes": [],
|
|
16057
|
+
"annotations": []
|
|
15814
16058
|
}, {
|
|
15815
16059
|
"name": "order",
|
|
15816
16060
|
"type": "billing_channel_order_summary",
|
|
@@ -15962,6 +16206,31 @@
|
|
|
15962
16206
|
}],
|
|
15963
16207
|
"attributes": [],
|
|
15964
16208
|
"interfaces": []
|
|
16209
|
+
}, {
|
|
16210
|
+
"name": "channel_transaction_payout",
|
|
16211
|
+
"plural": "channel_transaction_payouts",
|
|
16212
|
+
"fields": [{
|
|
16213
|
+
"name": "transaction",
|
|
16214
|
+
"type": "transaction_reference",
|
|
16215
|
+
"required": true,
|
|
16216
|
+
"attributes": [],
|
|
16217
|
+
"annotations": []
|
|
16218
|
+
}, {
|
|
16219
|
+
"name": "waiting_for",
|
|
16220
|
+
"type": "transaction_payout_pending_reason",
|
|
16221
|
+
"required": false,
|
|
16222
|
+
"attributes": [],
|
|
16223
|
+
"annotations": []
|
|
16224
|
+
}, {
|
|
16225
|
+
"name": "payout",
|
|
16226
|
+
"type": "payout_reference",
|
|
16227
|
+
"required": false,
|
|
16228
|
+
"attributes": [],
|
|
16229
|
+
"annotations": []
|
|
16230
|
+
}],
|
|
16231
|
+
"attributes": [],
|
|
16232
|
+
"interfaces": ["transaction_payout"],
|
|
16233
|
+
"description": "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
|
|
15965
16234
|
}, {
|
|
15966
16235
|
"name": "channel_transaction_upserted",
|
|
15967
16236
|
"plural": "channel_transaction_upserteds",
|
|
@@ -17383,6 +17652,30 @@
|
|
|
17383
17652
|
"attributes": [],
|
|
17384
17653
|
"interfaces": [],
|
|
17385
17654
|
"description": "Provides country level default settings for currency, language, etc."
|
|
17655
|
+
}, {
|
|
17656
|
+
"name": "country_of_origin",
|
|
17657
|
+
"plural": "country_of_origins",
|
|
17658
|
+
"fields": [{
|
|
17659
|
+
"name": "country",
|
|
17660
|
+
"type": "country",
|
|
17661
|
+
"required": true,
|
|
17662
|
+
"attributes": [],
|
|
17663
|
+
"annotations": []
|
|
17664
|
+
}],
|
|
17665
|
+
"attributes": [],
|
|
17666
|
+
"interfaces": []
|
|
17667
|
+
}, {
|
|
17668
|
+
"name": "country_of_origin_form",
|
|
17669
|
+
"plural": "country_of_origin_forms",
|
|
17670
|
+
"fields": [{
|
|
17671
|
+
"name": "country",
|
|
17672
|
+
"type": "string",
|
|
17673
|
+
"required": true,
|
|
17674
|
+
"attributes": [],
|
|
17675
|
+
"annotations": []
|
|
17676
|
+
}],
|
|
17677
|
+
"attributes": [],
|
|
17678
|
+
"interfaces": []
|
|
17386
17679
|
}, {
|
|
17387
17680
|
"name": "country_picker",
|
|
17388
17681
|
"plural": "country_pickers",
|
|
@@ -18838,6 +19131,18 @@
|
|
|
18838
19131
|
}],
|
|
18839
19132
|
"attributes": [],
|
|
18840
19133
|
"interfaces": []
|
|
19134
|
+
}, {
|
|
19135
|
+
"name": "deactivation_put_form",
|
|
19136
|
+
"plural": "deactivation_put_forms",
|
|
19137
|
+
"fields": [{
|
|
19138
|
+
"name": "reason",
|
|
19139
|
+
"type": "string",
|
|
19140
|
+
"required": true,
|
|
19141
|
+
"attributes": [],
|
|
19142
|
+
"annotations": []
|
|
19143
|
+
}],
|
|
19144
|
+
"attributes": [],
|
|
19145
|
+
"interfaces": []
|
|
18841
19146
|
}, {
|
|
18842
19147
|
"name": "default_bank_account_form",
|
|
18843
19148
|
"plural": "default_bank_account_forms",
|
|
@@ -19560,6 +19865,13 @@
|
|
|
19560
19865
|
"attributes": [],
|
|
19561
19866
|
"annotations": [],
|
|
19562
19867
|
"description": "Tells us who the recipient of the package is. This will determine information passed on to carriers to make sure the correct label and accounts are used"
|
|
19868
|
+
}, {
|
|
19869
|
+
"name": "package_dimensions_source",
|
|
19870
|
+
"type": "package_dimensions_source",
|
|
19871
|
+
"required": false,
|
|
19872
|
+
"attributes": [],
|
|
19873
|
+
"annotations": [],
|
|
19874
|
+
"description": "indicates which party estimated the package"
|
|
19563
19875
|
}],
|
|
19564
19876
|
"attributes": [],
|
|
19565
19877
|
"interfaces": []
|
|
@@ -23894,6 +24206,44 @@
|
|
|
23894
24206
|
"attributes": [],
|
|
23895
24207
|
"interfaces": [],
|
|
23896
24208
|
"description": "Event indicating insertion or changes to the details of a fully harmonized item. Will be triggered upon any change to the item being harmonized, its duties or taxes. If two changes occur within minutes of each other, it is possible only one upserted event will be produced, aggregating both changes."
|
|
24209
|
+
}, {
|
|
24210
|
+
"name": "generate_load",
|
|
24211
|
+
"plural": "generate_loads",
|
|
24212
|
+
"fields": [{
|
|
24213
|
+
"name": "event_id",
|
|
24214
|
+
"type": "string",
|
|
24215
|
+
"required": true,
|
|
24216
|
+
"attributes": [],
|
|
24217
|
+
"annotations": []
|
|
24218
|
+
}, {
|
|
24219
|
+
"name": "timestamp",
|
|
24220
|
+
"type": "date-time-iso8601",
|
|
24221
|
+
"required": true,
|
|
24222
|
+
"attributes": [],
|
|
24223
|
+
"annotations": []
|
|
24224
|
+
}, {
|
|
24225
|
+
"name": "organization",
|
|
24226
|
+
"type": "string",
|
|
24227
|
+
"required": true,
|
|
24228
|
+
"attributes": [],
|
|
24229
|
+
"annotations": [],
|
|
24230
|
+
"description": "Refers to your organization's account identifier"
|
|
24231
|
+
}, {
|
|
24232
|
+
"name": "test_name",
|
|
24233
|
+
"type": "string",
|
|
24234
|
+
"required": true,
|
|
24235
|
+
"attributes": [],
|
|
24236
|
+
"annotations": []
|
|
24237
|
+
}, {
|
|
24238
|
+
"name": "num_tests",
|
|
24239
|
+
"type": "integer",
|
|
24240
|
+
"required": true,
|
|
24241
|
+
"attributes": [],
|
|
24242
|
+
"annotations": [],
|
|
24243
|
+
"default": "1"
|
|
24244
|
+
}],
|
|
24245
|
+
"attributes": [],
|
|
24246
|
+
"interfaces": []
|
|
23897
24247
|
}, {
|
|
23898
24248
|
"name": "generic_error",
|
|
23899
24249
|
"plural": "generic_errors",
|
|
@@ -27548,6 +27898,12 @@
|
|
|
27548
27898
|
"attributes": [],
|
|
27549
27899
|
"annotations": [],
|
|
27550
27900
|
"description": "Globally unique identifier"
|
|
27901
|
+
}, {
|
|
27902
|
+
"name": "organization_id",
|
|
27903
|
+
"type": "string",
|
|
27904
|
+
"required": true,
|
|
27905
|
+
"attributes": [],
|
|
27906
|
+
"annotations": []
|
|
27551
27907
|
}, {
|
|
27552
27908
|
"name": "primary_entity",
|
|
27553
27909
|
"type": "entity",
|
|
@@ -27840,6 +28196,13 @@
|
|
|
27840
28196
|
"required": false,
|
|
27841
28197
|
"attributes": [],
|
|
27842
28198
|
"annotations": []
|
|
28199
|
+
}, {
|
|
28200
|
+
"name": "rejected",
|
|
28201
|
+
"type": "label_tracking_summary_update",
|
|
28202
|
+
"required": false,
|
|
28203
|
+
"attributes": [],
|
|
28204
|
+
"annotations": [],
|
|
28205
|
+
"description": "If present, records an event indicating rejection by carrier. This indicates this shipment will not be crossing the border or delivered to the consumer and will likely be returned to origin."
|
|
27843
28206
|
}],
|
|
27844
28207
|
"attributes": [],
|
|
27845
28208
|
"interfaces": []
|
|
@@ -29722,6 +30085,19 @@
|
|
|
29722
30085
|
}],
|
|
29723
30086
|
"attributes": [],
|
|
29724
30087
|
"interfaces": []
|
|
30088
|
+
}, {
|
|
30089
|
+
"name": "merchant_deactivated",
|
|
30090
|
+
"plural": "merchant_deactivateds",
|
|
30091
|
+
"fields": [{
|
|
30092
|
+
"name": "reason",
|
|
30093
|
+
"type": "string",
|
|
30094
|
+
"required": true,
|
|
30095
|
+
"attributes": [],
|
|
30096
|
+
"annotations": []
|
|
30097
|
+
}],
|
|
30098
|
+
"attributes": [],
|
|
30099
|
+
"interfaces": [],
|
|
30100
|
+
"description": "The merchant is deactivated by partner"
|
|
29725
30101
|
}, {
|
|
29726
30102
|
"name": "merchant_gift_card_balance",
|
|
29727
30103
|
"plural": "merchant_gift_card_balances",
|
|
@@ -30755,6 +31131,13 @@
|
|
|
30755
31131
|
"attributes": [],
|
|
30756
31132
|
"annotations": [],
|
|
30757
31133
|
"description": "Payment confirmation details received from the payment processor"
|
|
31134
|
+
}, {
|
|
31135
|
+
"name": "authorized_at",
|
|
31136
|
+
"type": "date-time-iso8601",
|
|
31137
|
+
"required": false,
|
|
31138
|
+
"attributes": [],
|
|
31139
|
+
"annotations": [],
|
|
31140
|
+
"description": "Indicates when the authorization was successfully authorized by the payment provider"
|
|
30758
31141
|
}],
|
|
30759
31142
|
"attributes": [],
|
|
30760
31143
|
"interfaces": ["authorization"]
|
|
@@ -30852,13 +31235,6 @@
|
|
|
30852
31235
|
"name": "operations_contact",
|
|
30853
31236
|
"plural": "operations_contacts",
|
|
30854
31237
|
"fields": [{
|
|
30855
|
-
"name": "full_name",
|
|
30856
|
-
"type": "string",
|
|
30857
|
-
"required": false,
|
|
30858
|
-
"attributes": [],
|
|
30859
|
-
"annotations": ["personal_data"],
|
|
30860
|
-
"description": "Personal information of point-of-contact"
|
|
30861
|
-
}, {
|
|
30862
31238
|
"name": "company",
|
|
30863
31239
|
"type": "string",
|
|
30864
31240
|
"required": false,
|
|
@@ -34881,6 +35257,12 @@
|
|
|
34881
35257
|
"required": false,
|
|
34882
35258
|
"attributes": [],
|
|
34883
35259
|
"annotations": []
|
|
35260
|
+
}, {
|
|
35261
|
+
"name": "onboarding_started_at",
|
|
35262
|
+
"type": "date-time-iso8601",
|
|
35263
|
+
"required": false,
|
|
35264
|
+
"attributes": [],
|
|
35265
|
+
"annotations": []
|
|
34884
35266
|
}],
|
|
34885
35267
|
"attributes": [],
|
|
34886
35268
|
"interfaces": []
|
|
@@ -35540,6 +35922,31 @@
|
|
|
35540
35922
|
}],
|
|
35541
35923
|
"attributes": [],
|
|
35542
35924
|
"interfaces": []
|
|
35925
|
+
}, {
|
|
35926
|
+
"name": "organization_transaction_payout",
|
|
35927
|
+
"plural": "organization_transaction_payouts",
|
|
35928
|
+
"fields": [{
|
|
35929
|
+
"name": "transaction",
|
|
35930
|
+
"type": "transaction_reference",
|
|
35931
|
+
"required": true,
|
|
35932
|
+
"attributes": [],
|
|
35933
|
+
"annotations": []
|
|
35934
|
+
}, {
|
|
35935
|
+
"name": "waiting_for",
|
|
35936
|
+
"type": "transaction_payout_pending_reason",
|
|
35937
|
+
"required": false,
|
|
35938
|
+
"attributes": [],
|
|
35939
|
+
"annotations": []
|
|
35940
|
+
}, {
|
|
35941
|
+
"name": "payout",
|
|
35942
|
+
"type": "payout_reference",
|
|
35943
|
+
"required": false,
|
|
35944
|
+
"attributes": [],
|
|
35945
|
+
"annotations": []
|
|
35946
|
+
}],
|
|
35947
|
+
"attributes": [],
|
|
35948
|
+
"interfaces": ["transaction_payout"],
|
|
35949
|
+
"description": "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
|
|
35543
35950
|
}, {
|
|
35544
35951
|
"name": "organization_transaction_upserted",
|
|
35545
35952
|
"plural": "organization_transaction_upserteds",
|
|
@@ -35760,34 +36167,100 @@
|
|
|
35760
36167
|
"attributes": [],
|
|
35761
36168
|
"interfaces": []
|
|
35762
36169
|
}, {
|
|
35763
|
-
"name": "
|
|
35764
|
-
"plural": "
|
|
36170
|
+
"name": "oversize_piece_surcharge_ratecard_fee",
|
|
36171
|
+
"plural": "oversize_piece_surcharge_ratecard_fees",
|
|
35765
36172
|
"fields": [{
|
|
36173
|
+
"name": "dimensional_threshold",
|
|
36174
|
+
"type": "decimal",
|
|
36175
|
+
"required": false,
|
|
36176
|
+
"attributes": [],
|
|
36177
|
+
"annotations": []
|
|
36178
|
+
}, {
|
|
36179
|
+
"name": "dimensional_unit",
|
|
36180
|
+
"type": "unit_of_measurement",
|
|
36181
|
+
"required": false,
|
|
36182
|
+
"attributes": [],
|
|
36183
|
+
"annotations": []
|
|
36184
|
+
}, {
|
|
35766
36185
|
"name": "weight_threshold",
|
|
35767
36186
|
"type": "decimal",
|
|
35768
|
-
"required":
|
|
36187
|
+
"required": false,
|
|
35769
36188
|
"attributes": [],
|
|
35770
36189
|
"annotations": []
|
|
35771
36190
|
}, {
|
|
35772
36191
|
"name": "weight_unit",
|
|
35773
36192
|
"type": "unit_of_measurement",
|
|
36193
|
+
"required": false,
|
|
36194
|
+
"attributes": [],
|
|
36195
|
+
"annotations": []
|
|
36196
|
+
}, {
|
|
36197
|
+
"name": "amount",
|
|
36198
|
+
"type": "money",
|
|
35774
36199
|
"required": true,
|
|
35775
36200
|
"attributes": [],
|
|
36201
|
+
"annotations": [],
|
|
36202
|
+
"description": "surcharge amount"
|
|
36203
|
+
}],
|
|
36204
|
+
"attributes": [],
|
|
36205
|
+
"interfaces": []
|
|
36206
|
+
}, {
|
|
36207
|
+
"name": "oversize_piece_surcharge_service_fee",
|
|
36208
|
+
"plural": "oversize_piece_surcharge_service_fees",
|
|
36209
|
+
"fields": [{
|
|
36210
|
+
"name": "dimensional_threshold",
|
|
36211
|
+
"type": "decimal",
|
|
36212
|
+
"required": false,
|
|
36213
|
+
"attributes": [],
|
|
35776
36214
|
"annotations": []
|
|
35777
36215
|
}, {
|
|
35778
|
-
"name": "
|
|
35779
|
-
"type": "
|
|
36216
|
+
"name": "dimensional_unit",
|
|
36217
|
+
"type": "unit_of_measurement",
|
|
35780
36218
|
"required": false,
|
|
35781
36219
|
"attributes": [],
|
|
35782
|
-
"annotations": []
|
|
35783
|
-
"description": "margin to charge"
|
|
36220
|
+
"annotations": []
|
|
35784
36221
|
}, {
|
|
35785
|
-
"name": "
|
|
35786
|
-
"type": "
|
|
36222
|
+
"name": "weight_threshold",
|
|
36223
|
+
"type": "decimal",
|
|
36224
|
+
"required": false,
|
|
36225
|
+
"attributes": [],
|
|
36226
|
+
"annotations": []
|
|
36227
|
+
}, {
|
|
36228
|
+
"name": "weight_unit",
|
|
36229
|
+
"type": "unit_of_measurement",
|
|
35787
36230
|
"required": false,
|
|
35788
36231
|
"attributes": [],
|
|
36232
|
+
"annotations": []
|
|
36233
|
+
}, {
|
|
36234
|
+
"name": "amount",
|
|
36235
|
+
"type": "money",
|
|
36236
|
+
"required": true,
|
|
36237
|
+
"attributes": [],
|
|
35789
36238
|
"annotations": [],
|
|
35790
|
-
"description": "
|
|
36239
|
+
"description": "surcharge amount"
|
|
36240
|
+
}],
|
|
36241
|
+
"attributes": [],
|
|
36242
|
+
"interfaces": []
|
|
36243
|
+
}, {
|
|
36244
|
+
"name": "package_dimensions",
|
|
36245
|
+
"plural": "package_dimensionses",
|
|
36246
|
+
"fields": [{
|
|
36247
|
+
"name": "dimensions",
|
|
36248
|
+
"type": "[dimension]",
|
|
36249
|
+
"required": true,
|
|
36250
|
+
"attributes": [],
|
|
36251
|
+
"annotations": []
|
|
36252
|
+
}],
|
|
36253
|
+
"attributes": [],
|
|
36254
|
+
"interfaces": []
|
|
36255
|
+
}, {
|
|
36256
|
+
"name": "package_dimensions_form",
|
|
36257
|
+
"plural": "package_dimensions_forms",
|
|
36258
|
+
"fields": [{
|
|
36259
|
+
"name": "dimensions",
|
|
36260
|
+
"type": "[dimension]",
|
|
36261
|
+
"required": true,
|
|
36262
|
+
"attributes": [],
|
|
36263
|
+
"annotations": []
|
|
35791
36264
|
}],
|
|
35792
36265
|
"attributes": [],
|
|
35793
36266
|
"interfaces": []
|
|
@@ -38539,6 +39012,19 @@
|
|
|
38539
39012
|
}],
|
|
38540
39013
|
"attributes": [],
|
|
38541
39014
|
"interfaces": []
|
|
39015
|
+
}, {
|
|
39016
|
+
"name": "payout_reference",
|
|
39017
|
+
"plural": "payout_references",
|
|
39018
|
+
"fields": [{
|
|
39019
|
+
"name": "id",
|
|
39020
|
+
"type": "string",
|
|
39021
|
+
"required": true,
|
|
39022
|
+
"attributes": [],
|
|
39023
|
+
"annotations": [],
|
|
39024
|
+
"description": "Globally unique identifier"
|
|
39025
|
+
}],
|
|
39026
|
+
"attributes": [],
|
|
39027
|
+
"interfaces": []
|
|
38542
39028
|
}, {
|
|
38543
39029
|
"name": "payout_status_failed",
|
|
38544
39030
|
"plural": "payout_status_faileds",
|
|
@@ -38591,6 +39077,12 @@
|
|
|
38591
39077
|
"attributes": [],
|
|
38592
39078
|
"annotations": [],
|
|
38593
39079
|
"description": "Globally unique identifier"
|
|
39080
|
+
}, {
|
|
39081
|
+
"name": "metadata",
|
|
39082
|
+
"type": "transaction_metadata",
|
|
39083
|
+
"required": false,
|
|
39084
|
+
"attributes": [],
|
|
39085
|
+
"annotations": []
|
|
38594
39086
|
}, {
|
|
38595
39087
|
"name": "order",
|
|
38596
39088
|
"type": "billing_channel_order_summary",
|
|
@@ -39093,10 +39585,37 @@
|
|
|
39093
39585
|
"attributes": [],
|
|
39094
39586
|
"annotations": [],
|
|
39095
39587
|
"description": "When Flow is merchant of record, identify which Flow entity is responsible for this delivery."
|
|
39588
|
+
}, {
|
|
39589
|
+
"name": "preferred_service",
|
|
39590
|
+
"type": "physical_delivery_preferred_service",
|
|
39591
|
+
"required": false,
|
|
39592
|
+
"attributes": [],
|
|
39593
|
+
"annotations": []
|
|
39096
39594
|
}],
|
|
39097
39595
|
"attributes": [],
|
|
39098
39596
|
"interfaces": [],
|
|
39099
39597
|
"description": "Represents a collection of items, the available delivery option tier for that collection of items, and metadata about those options"
|
|
39598
|
+
}, {
|
|
39599
|
+
"name": "physical_delivery_preferred_service",
|
|
39600
|
+
"plural": "physical_delivery_preferred_services",
|
|
39601
|
+
"fields": [{
|
|
39602
|
+
"name": "id",
|
|
39603
|
+
"type": "string",
|
|
39604
|
+
"required": true,
|
|
39605
|
+
"attributes": [],
|
|
39606
|
+
"annotations": [],
|
|
39607
|
+
"description": "Globally unique identifier",
|
|
39608
|
+
"example": "dhl-express-worldwide"
|
|
39609
|
+
}, {
|
|
39610
|
+
"name": "selection_stratey",
|
|
39611
|
+
"type": "preferred_service_selection_strategy",
|
|
39612
|
+
"required": true,
|
|
39613
|
+
"attributes": [],
|
|
39614
|
+
"annotations": []
|
|
39615
|
+
}],
|
|
39616
|
+
"attributes": [],
|
|
39617
|
+
"interfaces": [],
|
|
39618
|
+
"description": "The service the merchant would prefer us to use to ship this order if no service id is provided along with a label request. In some scenarios the preferred service might not be usable, which should result in an error."
|
|
39100
39619
|
}, {
|
|
39101
39620
|
"name": "post_payment_redirect_urls",
|
|
39102
39621
|
"plural": "post_payment_redirect_urlses",
|
|
@@ -41134,6 +41653,13 @@
|
|
|
41134
41653
|
"attributes": [],
|
|
41135
41654
|
"annotations": [],
|
|
41136
41655
|
"description": "Client's unique identifier for this object"
|
|
41656
|
+
}, {
|
|
41657
|
+
"name": "rate_level_key",
|
|
41658
|
+
"type": "string",
|
|
41659
|
+
"required": false,
|
|
41660
|
+
"attributes": [],
|
|
41661
|
+
"annotations": [],
|
|
41662
|
+
"description": "derived from interal rate_level_key enum"
|
|
41137
41663
|
}, {
|
|
41138
41664
|
"name": "direction",
|
|
41139
41665
|
"type": "direction",
|
|
@@ -41178,6 +41704,28 @@
|
|
|
41178
41704
|
"attributes": [],
|
|
41179
41705
|
"annotations": [],
|
|
41180
41706
|
"description": "Describes who owns this ratecard and is responsible for paying the carrier."
|
|
41707
|
+
}, {
|
|
41708
|
+
"name": "glbe_shipping_method_id",
|
|
41709
|
+
"type": "string",
|
|
41710
|
+
"required": false,
|
|
41711
|
+
"attributes": [],
|
|
41712
|
+
"annotations": [],
|
|
41713
|
+
"description": "The Global-e shipping method id represented by this ratecard, if this is a Global-e ratecard"
|
|
41714
|
+
}, {
|
|
41715
|
+
"name": "glbe_proposition_name",
|
|
41716
|
+
"type": "string",
|
|
41717
|
+
"required": false,
|
|
41718
|
+
"attributes": [],
|
|
41719
|
+
"annotations": [],
|
|
41720
|
+
"description": "The Global-e proposition represented by this ratecard, if this is a Global-e ratecard"
|
|
41721
|
+
}, {
|
|
41722
|
+
"name": "channel_revenue_share_percentage",
|
|
41723
|
+
"type": "decimal",
|
|
41724
|
+
"required": false,
|
|
41725
|
+
"attributes": [],
|
|
41726
|
+
"annotations": [],
|
|
41727
|
+
"description": "Percentage of revenue a channel should receive from shipments made on this ratecard. Omitted when none.",
|
|
41728
|
+
"example": ".05"
|
|
41181
41729
|
}],
|
|
41182
41730
|
"attributes": [],
|
|
41183
41731
|
"interfaces": [],
|
|
@@ -41576,6 +42124,34 @@
|
|
|
41576
42124
|
"attributes": [],
|
|
41577
42125
|
"annotations": [],
|
|
41578
42126
|
"description": "The ratecard id from which the rate was derived"
|
|
42127
|
+
}, {
|
|
42128
|
+
"name": "glbe_shipping_method_id",
|
|
42129
|
+
"type": "string",
|
|
42130
|
+
"required": false,
|
|
42131
|
+
"attributes": [],
|
|
42132
|
+
"annotations": [],
|
|
42133
|
+
"description": "derived from ratecard"
|
|
42134
|
+
}, {
|
|
42135
|
+
"name": "glbe_proposition_name",
|
|
42136
|
+
"type": "string",
|
|
42137
|
+
"required": false,
|
|
42138
|
+
"attributes": [],
|
|
42139
|
+
"annotations": [],
|
|
42140
|
+
"description": "derived from ratecard"
|
|
42141
|
+
}, {
|
|
42142
|
+
"name": "channel_revenue_share_percentage",
|
|
42143
|
+
"type": "decimal",
|
|
42144
|
+
"required": false,
|
|
42145
|
+
"attributes": [],
|
|
42146
|
+
"annotations": [],
|
|
42147
|
+
"description": "derived from ratecard"
|
|
42148
|
+
}, {
|
|
42149
|
+
"name": "rate_level_key",
|
|
42150
|
+
"type": "string",
|
|
42151
|
+
"required": false,
|
|
42152
|
+
"attributes": [],
|
|
42153
|
+
"annotations": [],
|
|
42154
|
+
"description": "derived from ratecard"
|
|
41579
42155
|
}, {
|
|
41580
42156
|
"name": "line_items",
|
|
41581
42157
|
"type": "[line_item_form]",
|
|
@@ -41626,6 +42202,12 @@
|
|
|
41626
42202
|
"attributes": [],
|
|
41627
42203
|
"annotations": [],
|
|
41628
42204
|
"description": "Client's unique identifier for this object"
|
|
42205
|
+
}, {
|
|
42206
|
+
"name": "rate_level_key",
|
|
42207
|
+
"type": "string",
|
|
42208
|
+
"required": false,
|
|
42209
|
+
"attributes": [],
|
|
42210
|
+
"annotations": []
|
|
41629
42211
|
}, {
|
|
41630
42212
|
"name": "ratecard_owner",
|
|
41631
42213
|
"type": "ratecard_owner",
|
|
@@ -41634,6 +42216,35 @@
|
|
|
41634
42216
|
"annotations": [],
|
|
41635
42217
|
"description": "Describes who owns this ratecard and is responsible for paying the carrier.",
|
|
41636
42218
|
"default": "flow"
|
|
42219
|
+
}, {
|
|
42220
|
+
"name": "glbe_shipping_method_id",
|
|
42221
|
+
"type": "string",
|
|
42222
|
+
"required": false,
|
|
42223
|
+
"attributes": [],
|
|
42224
|
+
"annotations": [],
|
|
42225
|
+
"description": "The Global-e shipping method id represented by this ratecard, if this is a Global-e ratecard"
|
|
42226
|
+
}, {
|
|
42227
|
+
"name": "glbe_proposition_name",
|
|
42228
|
+
"type": "string",
|
|
42229
|
+
"required": false,
|
|
42230
|
+
"attributes": [],
|
|
42231
|
+
"annotations": [],
|
|
42232
|
+
"description": "The Global-e proposition represented by this ratecard, if this is a Global-e ratecard"
|
|
42233
|
+
}, {
|
|
42234
|
+
"name": "channel_revenue_share_percentage",
|
|
42235
|
+
"type": "decimal",
|
|
42236
|
+
"required": false,
|
|
42237
|
+
"attributes": [],
|
|
42238
|
+
"annotations": [],
|
|
42239
|
+
"description": "Percentage of revenue a channel should receive from shipments made on this ratecard. Omitted when none.",
|
|
42240
|
+
"example": ".05"
|
|
42241
|
+
}, {
|
|
42242
|
+
"name": "data",
|
|
42243
|
+
"type": "map[string]",
|
|
42244
|
+
"required": false,
|
|
42245
|
+
"attributes": [],
|
|
42246
|
+
"annotations": [],
|
|
42247
|
+
"description": "A set of key/value pairs that you can attach to the ratecard."
|
|
41637
42248
|
}],
|
|
41638
42249
|
"attributes": [],
|
|
41639
42250
|
"interfaces": []
|
|
@@ -45739,6 +46350,25 @@
|
|
|
45739
46350
|
"deprecation": {
|
|
45740
46351
|
"description": "Moving to hop.cost - this field will be removed"
|
|
45741
46352
|
}
|
|
46353
|
+
}, {
|
|
46354
|
+
"name": "delivered_duty",
|
|
46355
|
+
"type": "delivered_duty",
|
|
46356
|
+
"required": false,
|
|
46357
|
+
"attributes": [],
|
|
46358
|
+
"annotations": [],
|
|
46359
|
+
"description": "Determines if a shipment should be DDP. If DDP, note that in some cases if a customer is shipping to a country where DDP is not available, information may still come back as DDU. If not provided, Flow will set a base default based on the country"
|
|
46360
|
+
}, {
|
|
46361
|
+
"name": "taxes_owed",
|
|
46362
|
+
"type": "money",
|
|
46363
|
+
"required": false,
|
|
46364
|
+
"attributes": [],
|
|
46365
|
+
"annotations": []
|
|
46366
|
+
}, {
|
|
46367
|
+
"name": "duties_owed",
|
|
46368
|
+
"type": "money",
|
|
46369
|
+
"required": false,
|
|
46370
|
+
"attributes": [],
|
|
46371
|
+
"annotations": []
|
|
45742
46372
|
}, {
|
|
45743
46373
|
"name": "destination",
|
|
45744
46374
|
"type": "shipping_address",
|
|
@@ -45816,6 +46446,12 @@
|
|
|
45816
46446
|
"attributes": [],
|
|
45817
46447
|
"annotations": [],
|
|
45818
46448
|
"description": "Package to be shipped, including dimensions and items included"
|
|
46449
|
+
}, {
|
|
46450
|
+
"name": "package_dimension_source",
|
|
46451
|
+
"type": "package_dimensions_source",
|
|
46452
|
+
"required": false,
|
|
46453
|
+
"attributes": [],
|
|
46454
|
+
"annotations": []
|
|
45819
46455
|
}, {
|
|
45820
46456
|
"name": "order_identifier",
|
|
45821
46457
|
"type": "string",
|
|
@@ -45922,6 +46558,31 @@
|
|
|
45922
46558
|
"attributes": [],
|
|
45923
46559
|
"interfaces": [],
|
|
45924
46560
|
"description": "Output data or downloadable links for shipping label documents such as labels or commercial invoices"
|
|
46561
|
+
}, {
|
|
46562
|
+
"name": "shipping_label_hop_cost_itemized_estimate",
|
|
46563
|
+
"plural": "shipping_label_hop_cost_itemized_estimates",
|
|
46564
|
+
"fields": [{
|
|
46565
|
+
"name": "units",
|
|
46566
|
+
"type": "io.flow.billing.true.up.v0.models.label_units",
|
|
46567
|
+
"required": true,
|
|
46568
|
+
"attributes": [],
|
|
46569
|
+
"annotations": []
|
|
46570
|
+
}, {
|
|
46571
|
+
"name": "base",
|
|
46572
|
+
"type": "io.flow.billing.true.up.v0.models.label_base",
|
|
46573
|
+
"required": true,
|
|
46574
|
+
"attributes": [],
|
|
46575
|
+
"annotations": []
|
|
46576
|
+
}, {
|
|
46577
|
+
"name": "surcharges",
|
|
46578
|
+
"type": "[io.flow.billing.true.up.v0.models.label_surcharge]",
|
|
46579
|
+
"required": true,
|
|
46580
|
+
"attributes": [],
|
|
46581
|
+
"annotations": []
|
|
46582
|
+
}],
|
|
46583
|
+
"attributes": [],
|
|
46584
|
+
"interfaces": [],
|
|
46585
|
+
"description": "Represents an itemized breakdown of the estimates for a shipping label"
|
|
45925
46586
|
}, {
|
|
45926
46587
|
"name": "shipping_label_hop_summary",
|
|
45927
46588
|
"plural": "shipping_label_hop_summaries",
|
|
@@ -45938,6 +46599,13 @@
|
|
|
45938
46599
|
"attributes": [],
|
|
45939
46600
|
"annotations": [],
|
|
45940
46601
|
"description": "Estimated shipping cost to be charged based on available ratecard"
|
|
46602
|
+
}, {
|
|
46603
|
+
"name": "itemized_estimate",
|
|
46604
|
+
"type": "shipping_label_hop_cost_itemized_estimate",
|
|
46605
|
+
"required": false,
|
|
46606
|
+
"attributes": [],
|
|
46607
|
+
"annotations": [],
|
|
46608
|
+
"description": "A detailed breakdown of the cost of this hop"
|
|
45941
46609
|
}],
|
|
45942
46610
|
"attributes": [],
|
|
45943
46611
|
"interfaces": []
|
|
@@ -45970,6 +46638,13 @@
|
|
|
45970
46638
|
"attributes": [],
|
|
45971
46639
|
"annotations": [],
|
|
45972
46640
|
"description": "Packaging dimensions for the shipment using the requested shipping label"
|
|
46641
|
+
}, {
|
|
46642
|
+
"name": "volumetric_weight",
|
|
46643
|
+
"type": "decimal",
|
|
46644
|
+
"required": false,
|
|
46645
|
+
"attributes": [],
|
|
46646
|
+
"annotations": [],
|
|
46647
|
+
"description": "The volumetric weight of the dimensions presented"
|
|
45973
46648
|
}, {
|
|
45974
46649
|
"name": "items",
|
|
45975
46650
|
"type": "[line_item_form]",
|
|
@@ -46005,6 +46680,41 @@
|
|
|
46005
46680
|
"required": true,
|
|
46006
46681
|
"attributes": [],
|
|
46007
46682
|
"annotations": []
|
|
46683
|
+
}, {
|
|
46684
|
+
"name": "rate_level_key",
|
|
46685
|
+
"type": "string",
|
|
46686
|
+
"required": false,
|
|
46687
|
+
"attributes": [],
|
|
46688
|
+
"annotations": []
|
|
46689
|
+
}, {
|
|
46690
|
+
"name": "glbe_shipping_method_id",
|
|
46691
|
+
"type": "string",
|
|
46692
|
+
"required": false,
|
|
46693
|
+
"attributes": [],
|
|
46694
|
+
"annotations": [],
|
|
46695
|
+
"description": "The Global-e shipping method id represented by this ratecard, if this is a Global-e ratecard"
|
|
46696
|
+
}, {
|
|
46697
|
+
"name": "glbe_proposition_name",
|
|
46698
|
+
"type": "string",
|
|
46699
|
+
"required": false,
|
|
46700
|
+
"attributes": [],
|
|
46701
|
+
"annotations": [],
|
|
46702
|
+
"description": "The Global-e proposition represented by this ratecard, if this is a Global-e ratecard"
|
|
46703
|
+
}, {
|
|
46704
|
+
"name": "channel_revenue_share_percentage",
|
|
46705
|
+
"type": "decimal",
|
|
46706
|
+
"required": false,
|
|
46707
|
+
"attributes": [],
|
|
46708
|
+
"annotations": [],
|
|
46709
|
+
"description": "Percentage of revenue a channel should receive from shipments made on this ratecard. Omitted when none.",
|
|
46710
|
+
"example": ".05"
|
|
46711
|
+
}, {
|
|
46712
|
+
"name": "shopify_grc_gid",
|
|
46713
|
+
"type": "string",
|
|
46714
|
+
"required": false,
|
|
46715
|
+
"attributes": [],
|
|
46716
|
+
"annotations": [],
|
|
46717
|
+
"description": "The Shopify ratecard used to calculate this rate. Will only be provided if the rate estimate is sourced from Shopify."
|
|
46008
46718
|
}],
|
|
46009
46719
|
"attributes": [],
|
|
46010
46720
|
"interfaces": []
|
|
@@ -47373,13 +48083,6 @@
|
|
|
47373
48083
|
"attributes": [],
|
|
47374
48084
|
"annotations": [],
|
|
47375
48085
|
"description": "Indirect Tax Information"
|
|
47376
|
-
}, {
|
|
47377
|
-
"name": "parent_company",
|
|
47378
|
-
"type": "merchant_info",
|
|
47379
|
-
"required": false,
|
|
47380
|
-
"attributes": [],
|
|
47381
|
-
"annotations": [],
|
|
47382
|
-
"description": "If company is a subsidiary, please indicate the name of the parent company and its ultimate parent company (if applicable), and their country of incorporation"
|
|
47383
48086
|
}, {
|
|
47384
48087
|
"name": "beneficiary",
|
|
47385
48088
|
"type": "string",
|
|
@@ -47436,13 +48139,6 @@
|
|
|
47436
48139
|
"required": false,
|
|
47437
48140
|
"attributes": [],
|
|
47438
48141
|
"annotations": []
|
|
47439
|
-
}, {
|
|
47440
|
-
"name": "trade_sectors",
|
|
47441
|
-
"type": "[onboarding_trade_sector]",
|
|
47442
|
-
"required": false,
|
|
47443
|
-
"attributes": [],
|
|
47444
|
-
"annotations": [],
|
|
47445
|
-
"description": "Trade Sector – Please select all relevant commodity types"
|
|
47446
48142
|
}, {
|
|
47447
48143
|
"name": "other_trade_sector",
|
|
47448
48144
|
"type": "string",
|
|
@@ -47454,6 +48150,15 @@
|
|
|
47454
48150
|
"type": "[third_party_logistics_partner]",
|
|
47455
48151
|
"required": false,
|
|
47456
48152
|
"attributes": [],
|
|
48153
|
+
"annotations": [],
|
|
48154
|
+
"deprecation": {
|
|
48155
|
+
"description": "Use center_contact"
|
|
48156
|
+
}
|
|
48157
|
+
}, {
|
|
48158
|
+
"name": "center_contact",
|
|
48159
|
+
"type": "operations_contact",
|
|
48160
|
+
"required": false,
|
|
48161
|
+
"attributes": [],
|
|
47457
48162
|
"annotations": []
|
|
47458
48163
|
}, {
|
|
47459
48164
|
"name": "average_order_weight",
|
|
@@ -47474,12 +48179,6 @@
|
|
|
47474
48179
|
"attributes": [],
|
|
47475
48180
|
"annotations": [],
|
|
47476
48181
|
"description": "Monthly Average Volume & Transactions (#)"
|
|
47477
|
-
}, {
|
|
47478
|
-
"name": "dangerous_goods",
|
|
47479
|
-
"type": "boolean",
|
|
47480
|
-
"required": false,
|
|
47481
|
-
"attributes": [],
|
|
47482
|
-
"annotations": []
|
|
47483
48182
|
}, {
|
|
47484
48183
|
"name": "default_country_of_origin",
|
|
47485
48184
|
"type": "string",
|
|
@@ -47521,12 +48220,6 @@
|
|
|
47521
48220
|
"required": false,
|
|
47522
48221
|
"attributes": [],
|
|
47523
48222
|
"annotations": []
|
|
47524
|
-
}, {
|
|
47525
|
-
"name": "logistics_format",
|
|
47526
|
-
"type": "logistics_format",
|
|
47527
|
-
"required": false,
|
|
47528
|
-
"attributes": [],
|
|
47529
|
-
"annotations": []
|
|
47530
48223
|
}, {
|
|
47531
48224
|
"name": "shop",
|
|
47532
48225
|
"type": "shop",
|
|
@@ -47538,18 +48231,33 @@
|
|
|
47538
48231
|
"type": "money",
|
|
47539
48232
|
"required": false,
|
|
47540
48233
|
"attributes": [],
|
|
47541
|
-
"annotations": []
|
|
48234
|
+
"annotations": [],
|
|
48235
|
+
"description": "Cross border GMV for previous year"
|
|
47542
48236
|
}, {
|
|
47543
48237
|
"name": "last_month_xborder_gmv",
|
|
47544
48238
|
"type": "money",
|
|
47545
48239
|
"required": false,
|
|
47546
48240
|
"attributes": [],
|
|
47547
|
-
"annotations": []
|
|
48241
|
+
"annotations": [],
|
|
48242
|
+
"description": "Cross border GMV for previous month"
|
|
47548
48243
|
}, {
|
|
47549
48244
|
"name": "average_order_value",
|
|
47550
48245
|
"type": "money",
|
|
47551
48246
|
"required": false,
|
|
47552
48247
|
"attributes": [],
|
|
48248
|
+
"annotations": [],
|
|
48249
|
+
"description": "Cross border average order value"
|
|
48250
|
+
}, {
|
|
48251
|
+
"name": "glbe_merchant_guid",
|
|
48252
|
+
"type": "string",
|
|
48253
|
+
"required": false,
|
|
48254
|
+
"attributes": [],
|
|
48255
|
+
"annotations": []
|
|
48256
|
+
}, {
|
|
48257
|
+
"name": "mcc_codes",
|
|
48258
|
+
"type": "[long]",
|
|
48259
|
+
"required": false,
|
|
48260
|
+
"attributes": [],
|
|
47553
48261
|
"annotations": []
|
|
47554
48262
|
}],
|
|
47555
48263
|
"attributes": [],
|
|
@@ -47571,13 +48279,6 @@
|
|
|
47571
48279
|
"attributes": [],
|
|
47572
48280
|
"annotations": [],
|
|
47573
48281
|
"description": "Indirect Tax Information"
|
|
47574
|
-
}, {
|
|
47575
|
-
"name": "parent_company",
|
|
47576
|
-
"type": "merchant_info",
|
|
47577
|
-
"required": false,
|
|
47578
|
-
"attributes": [],
|
|
47579
|
-
"annotations": [],
|
|
47580
|
-
"description": "If company is a subsidiary, please indicate the name of the parent company and its ultimate parent company (if applicable), and their country & state/province/jurisdiction of incorporation"
|
|
47581
48282
|
}, {
|
|
47582
48283
|
"name": "beneficiary",
|
|
47583
48284
|
"type": "string",
|
|
@@ -47637,13 +48338,6 @@
|
|
|
47637
48338
|
"required": false,
|
|
47638
48339
|
"attributes": [],
|
|
47639
48340
|
"annotations": []
|
|
47640
|
-
}, {
|
|
47641
|
-
"name": "trade_sectors",
|
|
47642
|
-
"type": "[onboarding_trade_sector]",
|
|
47643
|
-
"required": false,
|
|
47644
|
-
"attributes": [],
|
|
47645
|
-
"annotations": [],
|
|
47646
|
-
"description": "Trade Sector – Please select all relevant commodity types"
|
|
47647
48341
|
}, {
|
|
47648
48342
|
"name": "other_trade_sector",
|
|
47649
48343
|
"type": "string",
|
|
@@ -47655,6 +48349,15 @@
|
|
|
47655
48349
|
"type": "[third_party_logistics_partner]",
|
|
47656
48350
|
"required": false,
|
|
47657
48351
|
"attributes": [],
|
|
48352
|
+
"annotations": [],
|
|
48353
|
+
"deprecation": {
|
|
48354
|
+
"description": "Use center_contact"
|
|
48355
|
+
}
|
|
48356
|
+
}, {
|
|
48357
|
+
"name": "center_contact",
|
|
48358
|
+
"type": "operations_contact",
|
|
48359
|
+
"required": false,
|
|
48360
|
+
"attributes": [],
|
|
47658
48361
|
"annotations": []
|
|
47659
48362
|
}, {
|
|
47660
48363
|
"name": "average_order_weight",
|
|
@@ -47674,7 +48377,7 @@
|
|
|
47674
48377
|
"required": false,
|
|
47675
48378
|
"attributes": [],
|
|
47676
48379
|
"annotations": [],
|
|
47677
|
-
"description": "Monthly
|
|
48380
|
+
"description": "Monthly average value of domestic transactions"
|
|
47678
48381
|
}, {
|
|
47679
48382
|
"name": "monthly_average_volume_currency",
|
|
47680
48383
|
"type": "string",
|
|
@@ -47688,13 +48391,7 @@
|
|
|
47688
48391
|
"required": false,
|
|
47689
48392
|
"attributes": [],
|
|
47690
48393
|
"annotations": [],
|
|
47691
|
-
"description": "Monthly
|
|
47692
|
-
}, {
|
|
47693
|
-
"name": "dangerous_goods",
|
|
47694
|
-
"type": "boolean",
|
|
47695
|
-
"required": false,
|
|
47696
|
-
"attributes": [],
|
|
47697
|
-
"annotations": []
|
|
48394
|
+
"description": "Monthly average count of domestic transactions"
|
|
47698
48395
|
}, {
|
|
47699
48396
|
"name": "default_country_of_origin",
|
|
47700
48397
|
"type": "string",
|
|
@@ -47715,12 +48412,6 @@
|
|
|
47715
48412
|
"required": true,
|
|
47716
48413
|
"attributes": [],
|
|
47717
48414
|
"annotations": []
|
|
47718
|
-
}, {
|
|
47719
|
-
"name": "logistics_format",
|
|
47720
|
-
"type": "logistics_format",
|
|
47721
|
-
"required": false,
|
|
47722
|
-
"attributes": [],
|
|
47723
|
-
"annotations": []
|
|
47724
48415
|
}, {
|
|
47725
48416
|
"name": "shop",
|
|
47726
48417
|
"type": "shop",
|
|
@@ -47732,18 +48423,27 @@
|
|
|
47732
48423
|
"type": "money",
|
|
47733
48424
|
"required": false,
|
|
47734
48425
|
"attributes": [],
|
|
47735
|
-
"annotations": []
|
|
48426
|
+
"annotations": [],
|
|
48427
|
+
"description": "Cross border GMV for previous year"
|
|
47736
48428
|
}, {
|
|
47737
48429
|
"name": "last_month_xborder_gmv",
|
|
47738
48430
|
"type": "money",
|
|
47739
48431
|
"required": false,
|
|
47740
48432
|
"attributes": [],
|
|
47741
|
-
"annotations": []
|
|
48433
|
+
"annotations": [],
|
|
48434
|
+
"description": "Cross border GMV for previous month"
|
|
47742
48435
|
}, {
|
|
47743
48436
|
"name": "average_order_value",
|
|
47744
48437
|
"type": "money",
|
|
47745
48438
|
"required": false,
|
|
47746
48439
|
"attributes": [],
|
|
48440
|
+
"annotations": [],
|
|
48441
|
+
"description": "Cross border average order value"
|
|
48442
|
+
}, {
|
|
48443
|
+
"name": "mcc_codes",
|
|
48444
|
+
"type": "[long]",
|
|
48445
|
+
"required": false,
|
|
48446
|
+
"attributes": [],
|
|
47747
48447
|
"annotations": []
|
|
47748
48448
|
}],
|
|
47749
48449
|
"attributes": [],
|
|
@@ -50005,19 +50705,6 @@
|
|
|
50005
50705
|
}],
|
|
50006
50706
|
"attributes": [],
|
|
50007
50707
|
"interfaces": []
|
|
50008
|
-
}, {
|
|
50009
|
-
"name": "test",
|
|
50010
|
-
"plural": "tests",
|
|
50011
|
-
"fields": [{
|
|
50012
|
-
"name": "id",
|
|
50013
|
-
"type": "string",
|
|
50014
|
-
"required": true,
|
|
50015
|
-
"attributes": [],
|
|
50016
|
-
"annotations": [],
|
|
50017
|
-
"description": "Globally unique identifier"
|
|
50018
|
-
}],
|
|
50019
|
-
"attributes": [],
|
|
50020
|
-
"interfaces": []
|
|
50021
50708
|
}, {
|
|
50022
50709
|
"name": "test_upserted",
|
|
50023
50710
|
"plural": "test_upserteds",
|
|
@@ -50033,16 +50720,9 @@
|
|
|
50033
50720
|
"required": true,
|
|
50034
50721
|
"attributes": [],
|
|
50035
50722
|
"annotations": []
|
|
50036
|
-
}, {
|
|
50037
|
-
"name": "organization",
|
|
50038
|
-
"type": "string",
|
|
50039
|
-
"required": true,
|
|
50040
|
-
"attributes": [],
|
|
50041
|
-
"annotations": [],
|
|
50042
|
-
"description": "Refers to your organization's account identifier"
|
|
50043
50723
|
}, {
|
|
50044
50724
|
"name": "test",
|
|
50045
|
-
"type": "test",
|
|
50725
|
+
"type": "io.flow.ben.test.internal.v0.models.test",
|
|
50046
50726
|
"required": true,
|
|
50047
50727
|
"attributes": [],
|
|
50048
50728
|
"annotations": []
|
|
@@ -51589,6 +52269,12 @@
|
|
|
51589
52269
|
"attributes": [],
|
|
51590
52270
|
"annotations": [],
|
|
51591
52271
|
"description": "Globally unique identifier"
|
|
52272
|
+
}, {
|
|
52273
|
+
"name": "metadata",
|
|
52274
|
+
"type": "transaction_metadata",
|
|
52275
|
+
"required": false,
|
|
52276
|
+
"attributes": [],
|
|
52277
|
+
"annotations": []
|
|
51592
52278
|
}, {
|
|
51593
52279
|
"name": "order",
|
|
51594
52280
|
"type": "billing_channel_order_summary",
|
|
@@ -51703,6 +52389,18 @@
|
|
|
51703
52389
|
}],
|
|
51704
52390
|
"attributes": [],
|
|
51705
52391
|
"interfaces": []
|
|
52392
|
+
}, {
|
|
52393
|
+
"name": "transaction_metadata_shipping_label",
|
|
52394
|
+
"plural": "transaction_metadata_shipping_labels",
|
|
52395
|
+
"fields": [{
|
|
52396
|
+
"name": "request_method",
|
|
52397
|
+
"type": "label_request_method",
|
|
52398
|
+
"required": false,
|
|
52399
|
+
"attributes": [],
|
|
52400
|
+
"annotations": []
|
|
52401
|
+
}],
|
|
52402
|
+
"attributes": [],
|
|
52403
|
+
"interfaces": []
|
|
51706
52404
|
}, {
|
|
51707
52405
|
"name": "transaction_network_details_card",
|
|
51708
52406
|
"plural": "transaction_network_details_cards",
|
|
@@ -51724,6 +52422,19 @@
|
|
|
51724
52422
|
}],
|
|
51725
52423
|
"attributes": [],
|
|
51726
52424
|
"interfaces": []
|
|
52425
|
+
}, {
|
|
52426
|
+
"name": "transaction_reference",
|
|
52427
|
+
"plural": "transaction_references",
|
|
52428
|
+
"fields": [{
|
|
52429
|
+
"name": "id",
|
|
52430
|
+
"type": "string",
|
|
52431
|
+
"required": true,
|
|
52432
|
+
"attributes": [],
|
|
52433
|
+
"annotations": [],
|
|
52434
|
+
"description": "Globally unique identifier"
|
|
52435
|
+
}],
|
|
52436
|
+
"attributes": [],
|
|
52437
|
+
"interfaces": []
|
|
51727
52438
|
}, {
|
|
51728
52439
|
"name": "transaction_upserted",
|
|
51729
52440
|
"plural": "transaction_upserteds",
|
|
@@ -72176,6 +72887,12 @@
|
|
|
72176
72887
|
"location": "Path",
|
|
72177
72888
|
"required": true,
|
|
72178
72889
|
"description": "Refers to your organization's account identifier"
|
|
72890
|
+
}, {
|
|
72891
|
+
"name": "target_datetime",
|
|
72892
|
+
"type": "date-time-iso8601",
|
|
72893
|
+
"location": "Query",
|
|
72894
|
+
"required": false,
|
|
72895
|
+
"description": "The datetime on which to base an estimate"
|
|
72179
72896
|
}, {
|
|
72180
72897
|
"name": "context",
|
|
72181
72898
|
"type": "string",
|
|
@@ -74452,7 +75169,14 @@
|
|
|
74452
75169
|
"name": "include_pdf_data",
|
|
74453
75170
|
"type": "boolean",
|
|
74454
75171
|
"location": "Query",
|
|
74455
|
-
"required": false
|
|
75172
|
+
"required": false,
|
|
75173
|
+
"description": "Includes the base 64 encoded pdf content in the response"
|
|
75174
|
+
}, {
|
|
75175
|
+
"name": "suppress_paperless_waybill",
|
|
75176
|
+
"type": "boolean",
|
|
75177
|
+
"location": "Query",
|
|
75178
|
+
"required": false,
|
|
75179
|
+
"description": "Supresses the waybill page of a label if the label is paperless"
|
|
74456
75180
|
}],
|
|
74457
75181
|
"responses": [{
|
|
74458
75182
|
"code": {
|
|
@@ -80934,6 +81658,77 @@
|
|
|
80934
81658
|
}
|
|
80935
81659
|
}],
|
|
80936
81660
|
"path": "/channel/:channel/billing/transactions"
|
|
81661
|
+
}, {
|
|
81662
|
+
"type": "channel_transaction_payout",
|
|
81663
|
+
"plural": "channel_transaction_payouts",
|
|
81664
|
+
"operations": [{
|
|
81665
|
+
"method": "GET",
|
|
81666
|
+
"path": "/channel/:channel/billing/transaction/payouts",
|
|
81667
|
+
"parameters": [{
|
|
81668
|
+
"name": "channel",
|
|
81669
|
+
"type": "string",
|
|
81670
|
+
"location": "Path",
|
|
81671
|
+
"required": true
|
|
81672
|
+
}, {
|
|
81673
|
+
"name": "transaction_id",
|
|
81674
|
+
"type": "[string]",
|
|
81675
|
+
"location": "Query",
|
|
81676
|
+
"required": true,
|
|
81677
|
+
"minimum": 1,
|
|
81678
|
+
"maximum": 100
|
|
81679
|
+
}],
|
|
81680
|
+
"responses": [{
|
|
81681
|
+
"code": {
|
|
81682
|
+
"integer": {
|
|
81683
|
+
"value": 200
|
|
81684
|
+
}
|
|
81685
|
+
},
|
|
81686
|
+
"type": "[channel_transaction_payout]",
|
|
81687
|
+
"description": "Successful response",
|
|
81688
|
+
"attributes": []
|
|
81689
|
+
}, {
|
|
81690
|
+
"code": {
|
|
81691
|
+
"integer": {
|
|
81692
|
+
"value": 401
|
|
81693
|
+
}
|
|
81694
|
+
},
|
|
81695
|
+
"type": "unit",
|
|
81696
|
+
"description": "Authorization failed",
|
|
81697
|
+
"attributes": []
|
|
81698
|
+
}, {
|
|
81699
|
+
"code": {
|
|
81700
|
+
"integer": {
|
|
81701
|
+
"value": 404
|
|
81702
|
+
}
|
|
81703
|
+
},
|
|
81704
|
+
"type": "unit",
|
|
81705
|
+
"description": "Resource was not found",
|
|
81706
|
+
"attributes": []
|
|
81707
|
+
}, {
|
|
81708
|
+
"code": {
|
|
81709
|
+
"integer": {
|
|
81710
|
+
"value": 422
|
|
81711
|
+
}
|
|
81712
|
+
},
|
|
81713
|
+
"type": "generic_error",
|
|
81714
|
+
"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.",
|
|
81715
|
+
"attributes": []
|
|
81716
|
+
}],
|
|
81717
|
+
"attributes": [{
|
|
81718
|
+
"name": "linter",
|
|
81719
|
+
"value": {
|
|
81720
|
+
"ignore": ["get", "versions"]
|
|
81721
|
+
}
|
|
81722
|
+
}]
|
|
81723
|
+
}],
|
|
81724
|
+
"attributes": [{
|
|
81725
|
+
"name": "docs",
|
|
81726
|
+
"value": {
|
|
81727
|
+
"module": "general"
|
|
81728
|
+
}
|
|
81729
|
+
}],
|
|
81730
|
+
"path": "/channel/:channel/billing/transaction/payouts",
|
|
81731
|
+
"description": "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
|
|
80937
81732
|
}, {
|
|
80938
81733
|
"type": "channel_vies_registration",
|
|
80939
81734
|
"plural": "channel_vies_registrations",
|
|
@@ -81878,6 +82673,69 @@
|
|
|
81878
82673
|
}
|
|
81879
82674
|
}],
|
|
81880
82675
|
"path": "/consumer/invoice/document"
|
|
82676
|
+
}, {
|
|
82677
|
+
"type": "country_of_origin",
|
|
82678
|
+
"plural": "country_of_origins",
|
|
82679
|
+
"operations": [{
|
|
82680
|
+
"method": "PUT",
|
|
82681
|
+
"path": "/:organization/shopify/merchant/config/country/of/origin",
|
|
82682
|
+
"parameters": [{
|
|
82683
|
+
"name": "organization",
|
|
82684
|
+
"type": "string",
|
|
82685
|
+
"location": "Path",
|
|
82686
|
+
"required": true,
|
|
82687
|
+
"description": "Refers to your organization's account identifier"
|
|
82688
|
+
}],
|
|
82689
|
+
"responses": [{
|
|
82690
|
+
"code": {
|
|
82691
|
+
"integer": {
|
|
82692
|
+
"value": 200
|
|
82693
|
+
}
|
|
82694
|
+
},
|
|
82695
|
+
"type": "country_of_origin",
|
|
82696
|
+
"description": "Successful response",
|
|
82697
|
+
"attributes": []
|
|
82698
|
+
}, {
|
|
82699
|
+
"code": {
|
|
82700
|
+
"integer": {
|
|
82701
|
+
"value": 401
|
|
82702
|
+
}
|
|
82703
|
+
},
|
|
82704
|
+
"type": "unit",
|
|
82705
|
+
"description": "Authorization failed",
|
|
82706
|
+
"attributes": []
|
|
82707
|
+
}, {
|
|
82708
|
+
"code": {
|
|
82709
|
+
"integer": {
|
|
82710
|
+
"value": 404
|
|
82711
|
+
}
|
|
82712
|
+
},
|
|
82713
|
+
"type": "unit",
|
|
82714
|
+
"description": "Resource was not found",
|
|
82715
|
+
"attributes": []
|
|
82716
|
+
}, {
|
|
82717
|
+
"code": {
|
|
82718
|
+
"integer": {
|
|
82719
|
+
"value": 422
|
|
82720
|
+
}
|
|
82721
|
+
},
|
|
82722
|
+
"type": "generic_error",
|
|
82723
|
+
"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.",
|
|
82724
|
+
"attributes": []
|
|
82725
|
+
}],
|
|
82726
|
+
"attributes": [],
|
|
82727
|
+
"body": {
|
|
82728
|
+
"type": "country_of_origin_form",
|
|
82729
|
+
"attributes": []
|
|
82730
|
+
}
|
|
82731
|
+
}],
|
|
82732
|
+
"attributes": [{
|
|
82733
|
+
"name": "docs",
|
|
82734
|
+
"value": {
|
|
82735
|
+
"module": "general"
|
|
82736
|
+
}
|
|
82737
|
+
}],
|
|
82738
|
+
"path": "/:organization/shopify/merchant/config/country/of/origin"
|
|
81881
82739
|
}, {
|
|
81882
82740
|
"type": "country_picker",
|
|
81883
82741
|
"plural": "country_pickers",
|
|
@@ -89324,6 +90182,58 @@
|
|
|
89324
90182
|
"type": "activation_put_form",
|
|
89325
90183
|
"attributes": []
|
|
89326
90184
|
}
|
|
90185
|
+
}, {
|
|
90186
|
+
"method": "PUT",
|
|
90187
|
+
"path": "/:organization/onboarding/state/deactivation",
|
|
90188
|
+
"parameters": [{
|
|
90189
|
+
"name": "organization",
|
|
90190
|
+
"type": "string",
|
|
90191
|
+
"location": "Path",
|
|
90192
|
+
"required": true,
|
|
90193
|
+
"description": "Refers to your organization's account identifier"
|
|
90194
|
+
}],
|
|
90195
|
+
"responses": [{
|
|
90196
|
+
"code": {
|
|
90197
|
+
"integer": {
|
|
90198
|
+
"value": 201
|
|
90199
|
+
}
|
|
90200
|
+
},
|
|
90201
|
+
"type": "organization_onboarding_state",
|
|
90202
|
+
"description": "Operation succeeded and the resource was created",
|
|
90203
|
+
"attributes": []
|
|
90204
|
+
}, {
|
|
90205
|
+
"code": {
|
|
90206
|
+
"integer": {
|
|
90207
|
+
"value": 401
|
|
90208
|
+
}
|
|
90209
|
+
},
|
|
90210
|
+
"type": "unit",
|
|
90211
|
+
"description": "Authorization failed",
|
|
90212
|
+
"attributes": []
|
|
90213
|
+
}, {
|
|
90214
|
+
"code": {
|
|
90215
|
+
"integer": {
|
|
90216
|
+
"value": 404
|
|
90217
|
+
}
|
|
90218
|
+
},
|
|
90219
|
+
"type": "unit",
|
|
90220
|
+
"description": "Resource was not found",
|
|
90221
|
+
"attributes": []
|
|
90222
|
+
}, {
|
|
90223
|
+
"code": {
|
|
90224
|
+
"integer": {
|
|
90225
|
+
"value": 422
|
|
90226
|
+
}
|
|
90227
|
+
},
|
|
90228
|
+
"type": "generic_error",
|
|
90229
|
+
"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.",
|
|
90230
|
+
"attributes": []
|
|
90231
|
+
}],
|
|
90232
|
+
"attributes": [],
|
|
90233
|
+
"body": {
|
|
90234
|
+
"type": "deactivation_put_form",
|
|
90235
|
+
"attributes": []
|
|
90236
|
+
}
|
|
89327
90237
|
}],
|
|
89328
90238
|
"attributes": [{
|
|
89329
90239
|
"name": "docs",
|
|
@@ -89682,6 +90592,141 @@
|
|
|
89682
90592
|
}
|
|
89683
90593
|
}],
|
|
89684
90594
|
"path": "/tokens/channel/organization"
|
|
90595
|
+
}, {
|
|
90596
|
+
"type": "organization_transaction_payout",
|
|
90597
|
+
"plural": "organization_transaction_payouts",
|
|
90598
|
+
"operations": [{
|
|
90599
|
+
"method": "GET",
|
|
90600
|
+
"path": "/:organization/billing/transaction/payouts",
|
|
90601
|
+
"parameters": [{
|
|
90602
|
+
"name": "organization",
|
|
90603
|
+
"type": "string",
|
|
90604
|
+
"location": "Path",
|
|
90605
|
+
"required": true,
|
|
90606
|
+
"description": "Refers to your organization's account identifier"
|
|
90607
|
+
}, {
|
|
90608
|
+
"name": "transaction_id",
|
|
90609
|
+
"type": "[string]",
|
|
90610
|
+
"location": "Query",
|
|
90611
|
+
"required": true,
|
|
90612
|
+
"minimum": 1,
|
|
90613
|
+
"maximum": 100
|
|
90614
|
+
}],
|
|
90615
|
+
"responses": [{
|
|
90616
|
+
"code": {
|
|
90617
|
+
"integer": {
|
|
90618
|
+
"value": 200
|
|
90619
|
+
}
|
|
90620
|
+
},
|
|
90621
|
+
"type": "[organization_transaction_payout]",
|
|
90622
|
+
"description": "Successful response",
|
|
90623
|
+
"attributes": []
|
|
90624
|
+
}, {
|
|
90625
|
+
"code": {
|
|
90626
|
+
"integer": {
|
|
90627
|
+
"value": 401
|
|
90628
|
+
}
|
|
90629
|
+
},
|
|
90630
|
+
"type": "unit",
|
|
90631
|
+
"description": "Authorization failed",
|
|
90632
|
+
"attributes": []
|
|
90633
|
+
}, {
|
|
90634
|
+
"code": {
|
|
90635
|
+
"integer": {
|
|
90636
|
+
"value": 404
|
|
90637
|
+
}
|
|
90638
|
+
},
|
|
90639
|
+
"type": "unit",
|
|
90640
|
+
"description": "Resource was not found",
|
|
90641
|
+
"attributes": []
|
|
90642
|
+
}, {
|
|
90643
|
+
"code": {
|
|
90644
|
+
"integer": {
|
|
90645
|
+
"value": 422
|
|
90646
|
+
}
|
|
90647
|
+
},
|
|
90648
|
+
"type": "generic_error",
|
|
90649
|
+
"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.",
|
|
90650
|
+
"attributes": []
|
|
90651
|
+
}],
|
|
90652
|
+
"attributes": [{
|
|
90653
|
+
"name": "linter",
|
|
90654
|
+
"value": {
|
|
90655
|
+
"ignore": ["get", "versions"]
|
|
90656
|
+
}
|
|
90657
|
+
}]
|
|
90658
|
+
}],
|
|
90659
|
+
"attributes": [{
|
|
90660
|
+
"name": "docs",
|
|
90661
|
+
"value": {
|
|
90662
|
+
"module": "general"
|
|
90663
|
+
}
|
|
90664
|
+
}],
|
|
90665
|
+
"path": "/:organization/billing/transaction/payouts",
|
|
90666
|
+
"description": "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
|
|
90667
|
+
}, {
|
|
90668
|
+
"type": "package_dimensions",
|
|
90669
|
+
"plural": "package_dimensionses",
|
|
90670
|
+
"operations": [{
|
|
90671
|
+
"method": "PUT",
|
|
90672
|
+
"path": "/:organization/shopify/merchant/config/package/dimensions/default",
|
|
90673
|
+
"parameters": [{
|
|
90674
|
+
"name": "organization",
|
|
90675
|
+
"type": "string",
|
|
90676
|
+
"location": "Path",
|
|
90677
|
+
"required": true,
|
|
90678
|
+
"description": "Refers to your organization's account identifier"
|
|
90679
|
+
}],
|
|
90680
|
+
"responses": [{
|
|
90681
|
+
"code": {
|
|
90682
|
+
"integer": {
|
|
90683
|
+
"value": 200
|
|
90684
|
+
}
|
|
90685
|
+
},
|
|
90686
|
+
"type": "package_dimensions",
|
|
90687
|
+
"description": "Successful response",
|
|
90688
|
+
"attributes": []
|
|
90689
|
+
}, {
|
|
90690
|
+
"code": {
|
|
90691
|
+
"integer": {
|
|
90692
|
+
"value": 401
|
|
90693
|
+
}
|
|
90694
|
+
},
|
|
90695
|
+
"type": "unit",
|
|
90696
|
+
"description": "Authorization failed",
|
|
90697
|
+
"attributes": []
|
|
90698
|
+
}, {
|
|
90699
|
+
"code": {
|
|
90700
|
+
"integer": {
|
|
90701
|
+
"value": 404
|
|
90702
|
+
}
|
|
90703
|
+
},
|
|
90704
|
+
"type": "unit",
|
|
90705
|
+
"description": "Resource was not found",
|
|
90706
|
+
"attributes": []
|
|
90707
|
+
}, {
|
|
90708
|
+
"code": {
|
|
90709
|
+
"integer": {
|
|
90710
|
+
"value": 422
|
|
90711
|
+
}
|
|
90712
|
+
},
|
|
90713
|
+
"type": "generic_error",
|
|
90714
|
+
"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.",
|
|
90715
|
+
"attributes": []
|
|
90716
|
+
}],
|
|
90717
|
+
"attributes": [],
|
|
90718
|
+
"body": {
|
|
90719
|
+
"type": "package_dimensions_form",
|
|
90720
|
+
"attributes": []
|
|
90721
|
+
}
|
|
90722
|
+
}],
|
|
90723
|
+
"attributes": [{
|
|
90724
|
+
"name": "docs",
|
|
90725
|
+
"value": {
|
|
90726
|
+
"module": "general"
|
|
90727
|
+
}
|
|
90728
|
+
}],
|
|
90729
|
+
"path": "/:organization/shopify/merchant/config/package/dimensions/default"
|
|
89685
90730
|
}, {
|
|
89686
90731
|
"type": "partner_token",
|
|
89687
90732
|
"plural": "partner_tokens",
|