@flowio/api-mock-generator 6.17.58 → 6.17.60
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 +908 -78
- package/package.json +2 -2
- package/src/api.json +908 -78
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.84",
|
|
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.32",
|
|
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.32",
|
|
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,27 +61,12 @@
|
|
|
61
61
|
"application": {
|
|
62
62
|
"key": "shopify-external"
|
|
63
63
|
},
|
|
64
|
-
"version": "0.3.
|
|
64
|
+
"version": "0.3.32",
|
|
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.99",
|
|
80
|
-
"enums": ["true_up_surcharge_type"],
|
|
81
|
-
"interfaces": ["carrier_charge_form"],
|
|
82
|
-
"unions": ["carrier_charge_form", "label_surcharge_detail"],
|
|
83
|
-
"models": ["carrier_charge_file", "carrier_charge_file_form", "carrier_charge_file_result", "carrier_charge_form_label", "carrier_charge_form_return_to_origin", "carrier_charge_units", "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_surcharge_form", "label_surcharge_single_form", "label_units", "metadata_proposition", "metadata_ratecard", "metadata_weights", "shipping_method_reference", "true_up_label_summary", "weights_dead", "weights_dimensional"],
|
|
84
|
-
"annotations": []
|
|
85
70
|
}, {
|
|
86
71
|
"uri": "https://app.apibuilder.io/flow/ben-test-internal/latest/service.json",
|
|
87
72
|
"namespace": "io.flow.ben.test.internal.v0",
|
|
@@ -91,7 +76,7 @@
|
|
|
91
76
|
"application": {
|
|
92
77
|
"key": "ben-test-internal"
|
|
93
78
|
},
|
|
94
|
-
"version": "0.
|
|
79
|
+
"version": "0.20.35",
|
|
95
80
|
"enums": [],
|
|
96
81
|
"interfaces": ["generate_load"],
|
|
97
82
|
"unions": ["generate_load"],
|
|
@@ -3760,7 +3745,7 @@
|
|
|
3760
3745
|
"name": "waiting_for_next_payout_date",
|
|
3761
3746
|
"attributes": []
|
|
3762
3747
|
}, {
|
|
3763
|
-
"name": "
|
|
3748
|
+
"name": "waiting_for_tracking_info",
|
|
3764
3749
|
"attributes": []
|
|
3765
3750
|
}, {
|
|
3766
3751
|
"name": "waiting_for_positive_account_balance",
|
|
@@ -6112,6 +6097,40 @@
|
|
|
6112
6097
|
"annotations": []
|
|
6113
6098
|
}],
|
|
6114
6099
|
"attributes": []
|
|
6100
|
+
}, {
|
|
6101
|
+
"name": "payment_processor_transaction_details",
|
|
6102
|
+
"plural": "payment_processor_transaction_detailses",
|
|
6103
|
+
"fields": [{
|
|
6104
|
+
"name": "transaction_identifier",
|
|
6105
|
+
"type": "string",
|
|
6106
|
+
"required": false,
|
|
6107
|
+
"attributes": [],
|
|
6108
|
+
"annotations": [],
|
|
6109
|
+
"description": "The most specific PSP identifier for an authorization attempt / result"
|
|
6110
|
+
}, {
|
|
6111
|
+
"name": "method_type",
|
|
6112
|
+
"type": "string",
|
|
6113
|
+
"required": false,
|
|
6114
|
+
"attributes": [],
|
|
6115
|
+
"annotations": [],
|
|
6116
|
+
"description": "The PSP's identification of the payment method subtype, e.g. card brand or method method within a wallet"
|
|
6117
|
+
}, {
|
|
6118
|
+
"name": "result_status",
|
|
6119
|
+
"type": "string",
|
|
6120
|
+
"required": false,
|
|
6121
|
+
"attributes": [],
|
|
6122
|
+
"annotations": [],
|
|
6123
|
+
"description": "The transaction's raw result status"
|
|
6124
|
+
}, {
|
|
6125
|
+
"name": "reason_code",
|
|
6126
|
+
"type": "string",
|
|
6127
|
+
"required": false,
|
|
6128
|
+
"attributes": [],
|
|
6129
|
+
"annotations": [],
|
|
6130
|
+
"description": "The transaction's raw reason code"
|
|
6131
|
+
}],
|
|
6132
|
+
"attributes": [],
|
|
6133
|
+
"description": "PSP specific raw values for common transaction elements"
|
|
6115
6134
|
}, {
|
|
6116
6135
|
"name": "payout",
|
|
6117
6136
|
"plural": "payouts",
|
|
@@ -6206,6 +6225,24 @@
|
|
|
6206
6225
|
"required": false,
|
|
6207
6226
|
"attributes": [],
|
|
6208
6227
|
"annotations": []
|
|
6228
|
+
}, {
|
|
6229
|
+
"name": "created_at",
|
|
6230
|
+
"type": "date-time-iso8601",
|
|
6231
|
+
"required": true,
|
|
6232
|
+
"attributes": [],
|
|
6233
|
+
"annotations": []
|
|
6234
|
+
}, {
|
|
6235
|
+
"name": "updated_at",
|
|
6236
|
+
"type": "date-time-iso8601",
|
|
6237
|
+
"required": true,
|
|
6238
|
+
"attributes": [],
|
|
6239
|
+
"annotations": []
|
|
6240
|
+
}, {
|
|
6241
|
+
"name": "deleted_at",
|
|
6242
|
+
"type": "date-time-iso8601",
|
|
6243
|
+
"required": false,
|
|
6244
|
+
"attributes": [],
|
|
6245
|
+
"annotations": []
|
|
6209
6246
|
}],
|
|
6210
6247
|
"attributes": [],
|
|
6211
6248
|
"description": "A transaction that is pending payout."
|
|
@@ -8009,6 +8046,22 @@
|
|
|
8009
8046
|
"attributes": [],
|
|
8010
8047
|
"interfaces": [],
|
|
8011
8048
|
"discriminator": "discriminator"
|
|
8049
|
+
}, {
|
|
8050
|
+
"name": "fuel_surcharge_rate",
|
|
8051
|
+
"plural": "fuel_surcharge_rates",
|
|
8052
|
+
"types": [{
|
|
8053
|
+
"type": "fuel_surcharge_percent",
|
|
8054
|
+
"attributes": [],
|
|
8055
|
+
"discriminator_value": "fuel_surcharge_percent"
|
|
8056
|
+
}, {
|
|
8057
|
+
"type": "fuel_surcharge_by_weight",
|
|
8058
|
+
"attributes": [],
|
|
8059
|
+
"discriminator_value": "fuel_surcharge_by_weight"
|
|
8060
|
+
}],
|
|
8061
|
+
"attributes": [],
|
|
8062
|
+
"interfaces": [],
|
|
8063
|
+
"discriminator": "discriminator",
|
|
8064
|
+
"description": "for exposing ratecard fuel surcharge"
|
|
8012
8065
|
}, {
|
|
8013
8066
|
"name": "gateway_authentication_data",
|
|
8014
8067
|
"plural": "gateway_authentication_data",
|
|
@@ -8104,6 +8157,25 @@
|
|
|
8104
8157
|
"attributes": [],
|
|
8105
8158
|
"interfaces": [],
|
|
8106
8159
|
"discriminator": "discriminator"
|
|
8160
|
+
}, {
|
|
8161
|
+
"name": "label_surcharge_detail",
|
|
8162
|
+
"plural": "label_surcharge_details",
|
|
8163
|
+
"types": [{
|
|
8164
|
+
"type": "label_surcharge_detail_flat",
|
|
8165
|
+
"attributes": [],
|
|
8166
|
+
"discriminator_value": "flat"
|
|
8167
|
+
}, {
|
|
8168
|
+
"type": "label_surcharge_detail_percentage",
|
|
8169
|
+
"attributes": [],
|
|
8170
|
+
"discriminator_value": "percentage"
|
|
8171
|
+
}, {
|
|
8172
|
+
"type": "label_surcharge_detail_per_weight_unit",
|
|
8173
|
+
"attributes": [],
|
|
8174
|
+
"discriminator_value": "per_weight_unit"
|
|
8175
|
+
}],
|
|
8176
|
+
"attributes": [],
|
|
8177
|
+
"interfaces": [],
|
|
8178
|
+
"discriminator": "discriminator"
|
|
8107
8179
|
}, {
|
|
8108
8180
|
"name": "localized_price",
|
|
8109
8181
|
"plural": "localized_prices",
|
|
@@ -8625,6 +8697,17 @@
|
|
|
8625
8697
|
"attributes": [],
|
|
8626
8698
|
"interfaces": [],
|
|
8627
8699
|
"discriminator": "discriminator"
|
|
8700
|
+
}, {
|
|
8701
|
+
"name": "payment_processor_transaction_details",
|
|
8702
|
+
"plural": "payment_processor_transaction_detailses",
|
|
8703
|
+
"types": [{
|
|
8704
|
+
"type": "payment_processor_transaction_details_card",
|
|
8705
|
+
"attributes": [],
|
|
8706
|
+
"discriminator_value": "card"
|
|
8707
|
+
}],
|
|
8708
|
+
"attributes": [],
|
|
8709
|
+
"interfaces": ["payment_processor_transaction_details"],
|
|
8710
|
+
"discriminator": "discriminator"
|
|
8628
8711
|
}, {
|
|
8629
8712
|
"name": "payment_source",
|
|
8630
8713
|
"plural": "payment_sources",
|
|
@@ -9242,6 +9325,11 @@
|
|
|
9242
9325
|
"attributes": [],
|
|
9243
9326
|
"default": false,
|
|
9244
9327
|
"discriminator_value": "trueup"
|
|
9328
|
+
}, {
|
|
9329
|
+
"type": "transaction_metadata_manual",
|
|
9330
|
+
"attributes": [],
|
|
9331
|
+
"default": false,
|
|
9332
|
+
"discriminator_value": "manual"
|
|
9245
9333
|
}],
|
|
9246
9334
|
"attributes": [],
|
|
9247
9335
|
"interfaces": [],
|
|
@@ -15507,6 +15595,61 @@
|
|
|
15507
15595
|
}],
|
|
15508
15596
|
"attributes": [],
|
|
15509
15597
|
"interfaces": []
|
|
15598
|
+
}, {
|
|
15599
|
+
"name": "channel_currency_pair",
|
|
15600
|
+
"plural": "channel_currency_pairs",
|
|
15601
|
+
"fields": [{
|
|
15602
|
+
"name": "id",
|
|
15603
|
+
"type": "string",
|
|
15604
|
+
"required": true,
|
|
15605
|
+
"attributes": [],
|
|
15606
|
+
"annotations": [],
|
|
15607
|
+
"description": "Unique identifier for this currency pair"
|
|
15608
|
+
}, {
|
|
15609
|
+
"name": "base",
|
|
15610
|
+
"type": "string",
|
|
15611
|
+
"required": true,
|
|
15612
|
+
"attributes": [],
|
|
15613
|
+
"annotations": [],
|
|
15614
|
+
"description": "The base currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies"
|
|
15615
|
+
}, {
|
|
15616
|
+
"name": "target",
|
|
15617
|
+
"type": "string",
|
|
15618
|
+
"required": true,
|
|
15619
|
+
"attributes": [],
|
|
15620
|
+
"annotations": [],
|
|
15621
|
+
"description": "The target currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies"
|
|
15622
|
+
}, {
|
|
15623
|
+
"name": "rate",
|
|
15624
|
+
"type": "channel_currency_rate",
|
|
15625
|
+
"required": true,
|
|
15626
|
+
"attributes": [],
|
|
15627
|
+
"annotations": []
|
|
15628
|
+
}],
|
|
15629
|
+
"attributes": [],
|
|
15630
|
+
"interfaces": [],
|
|
15631
|
+
"description": "Represents an organization-specific currency conversion rate at a point in time."
|
|
15632
|
+
}, {
|
|
15633
|
+
"name": "channel_currency_rate",
|
|
15634
|
+
"plural": "channel_currency_rates",
|
|
15635
|
+
"fields": [{
|
|
15636
|
+
"name": "id",
|
|
15637
|
+
"type": "string",
|
|
15638
|
+
"required": true,
|
|
15639
|
+
"attributes": [],
|
|
15640
|
+
"annotations": [],
|
|
15641
|
+
"description": "A global rate id that uniquely identifies this specific FX rate for this currency pair. Knowing this version id is sufficient to lookup exactly what FX rate was used at a point in time."
|
|
15642
|
+
}, {
|
|
15643
|
+
"name": "value",
|
|
15644
|
+
"type": "decimal",
|
|
15645
|
+
"required": true,
|
|
15646
|
+
"attributes": [],
|
|
15647
|
+
"annotations": [],
|
|
15648
|
+
"description": "The actual conversion rate from the base currency to target currency including any applicable margins."
|
|
15649
|
+
}],
|
|
15650
|
+
"attributes": [],
|
|
15651
|
+
"interfaces": [],
|
|
15652
|
+
"description": "A globally unique rate for a specific currency pair that uniquely identifies this specific FX rate for this currency pair. Knowing this version id is sufficient to lookup exactly what FX rate was used at a point in time."
|
|
15510
15653
|
}, {
|
|
15511
15654
|
"name": "channel_currency_upserted",
|
|
15512
15655
|
"plural": "channel_currency_upserteds",
|
|
@@ -15922,6 +16065,24 @@
|
|
|
15922
16065
|
"required": false,
|
|
15923
16066
|
"attributes": [],
|
|
15924
16067
|
"annotations": []
|
|
16068
|
+
}, {
|
|
16069
|
+
"name": "created_at",
|
|
16070
|
+
"type": "date-time-iso8601",
|
|
16071
|
+
"required": true,
|
|
16072
|
+
"attributes": [],
|
|
16073
|
+
"annotations": []
|
|
16074
|
+
}, {
|
|
16075
|
+
"name": "updated_at",
|
|
16076
|
+
"type": "date-time-iso8601",
|
|
16077
|
+
"required": true,
|
|
16078
|
+
"attributes": [],
|
|
16079
|
+
"annotations": []
|
|
16080
|
+
}, {
|
|
16081
|
+
"name": "deleted_at",
|
|
16082
|
+
"type": "date-time-iso8601",
|
|
16083
|
+
"required": false,
|
|
16084
|
+
"attributes": [],
|
|
16085
|
+
"annotations": []
|
|
15925
16086
|
}],
|
|
15926
16087
|
"attributes": [],
|
|
15927
16088
|
"interfaces": ["pending_payout_transaction"],
|
|
@@ -19298,6 +19459,18 @@
|
|
|
19298
19459
|
}],
|
|
19299
19460
|
"attributes": [],
|
|
19300
19461
|
"interfaces": []
|
|
19462
|
+
}, {
|
|
19463
|
+
"name": "dead_weight",
|
|
19464
|
+
"plural": "dead_weights",
|
|
19465
|
+
"fields": [{
|
|
19466
|
+
"name": "weight",
|
|
19467
|
+
"type": "decimal",
|
|
19468
|
+
"required": true,
|
|
19469
|
+
"attributes": [],
|
|
19470
|
+
"annotations": []
|
|
19471
|
+
}],
|
|
19472
|
+
"attributes": [],
|
|
19473
|
+
"interfaces": []
|
|
19301
19474
|
}, {
|
|
19302
19475
|
"name": "default_bank_account_form",
|
|
19303
19476
|
"plural": "default_bank_account_forms",
|
|
@@ -20517,6 +20690,37 @@
|
|
|
20517
20690
|
}],
|
|
20518
20691
|
"attributes": [],
|
|
20519
20692
|
"interfaces": []
|
|
20693
|
+
}, {
|
|
20694
|
+
"name": "dimensional_weight",
|
|
20695
|
+
"plural": "dimensional_weights",
|
|
20696
|
+
"fields": [{
|
|
20697
|
+
"name": "weight",
|
|
20698
|
+
"type": "decimal",
|
|
20699
|
+
"required": true,
|
|
20700
|
+
"attributes": [],
|
|
20701
|
+
"annotations": [],
|
|
20702
|
+
"description": "The calculated dimensional weight"
|
|
20703
|
+
}, {
|
|
20704
|
+
"name": "length",
|
|
20705
|
+
"type": "decimal",
|
|
20706
|
+
"required": false,
|
|
20707
|
+
"attributes": [],
|
|
20708
|
+
"annotations": []
|
|
20709
|
+
}, {
|
|
20710
|
+
"name": "width",
|
|
20711
|
+
"type": "decimal",
|
|
20712
|
+
"required": false,
|
|
20713
|
+
"attributes": [],
|
|
20714
|
+
"annotations": []
|
|
20715
|
+
}, {
|
|
20716
|
+
"name": "height",
|
|
20717
|
+
"type": "decimal",
|
|
20718
|
+
"required": false,
|
|
20719
|
+
"attributes": [],
|
|
20720
|
+
"annotations": []
|
|
20721
|
+
}],
|
|
20722
|
+
"attributes": [],
|
|
20723
|
+
"interfaces": []
|
|
20520
20724
|
}, {
|
|
20521
20725
|
"name": "dimensions",
|
|
20522
20726
|
"plural": "dimensionses",
|
|
@@ -24060,6 +24264,36 @@
|
|
|
24060
24264
|
}],
|
|
24061
24265
|
"attributes": [],
|
|
24062
24266
|
"interfaces": []
|
|
24267
|
+
}, {
|
|
24268
|
+
"name": "fuel_surcharge_by_weight",
|
|
24269
|
+
"plural": "fuel_surcharge_by_weights",
|
|
24270
|
+
"fields": [{
|
|
24271
|
+
"name": "amount",
|
|
24272
|
+
"type": "decimal",
|
|
24273
|
+
"required": true,
|
|
24274
|
+
"attributes": [],
|
|
24275
|
+
"annotations": []
|
|
24276
|
+
}, {
|
|
24277
|
+
"name": "weight_unit",
|
|
24278
|
+
"type": "unit_of_measurement",
|
|
24279
|
+
"required": true,
|
|
24280
|
+
"attributes": [],
|
|
24281
|
+
"annotations": []
|
|
24282
|
+
}],
|
|
24283
|
+
"attributes": [],
|
|
24284
|
+
"interfaces": []
|
|
24285
|
+
}, {
|
|
24286
|
+
"name": "fuel_surcharge_percent",
|
|
24287
|
+
"plural": "fuel_surcharge_percents",
|
|
24288
|
+
"fields": [{
|
|
24289
|
+
"name": "percent",
|
|
24290
|
+
"type": "decimal",
|
|
24291
|
+
"required": true,
|
|
24292
|
+
"attributes": [],
|
|
24293
|
+
"annotations": []
|
|
24294
|
+
}],
|
|
24295
|
+
"attributes": [],
|
|
24296
|
+
"interfaces": []
|
|
24063
24297
|
}, {
|
|
24064
24298
|
"name": "fuel_surcharge_ratecard_fee",
|
|
24065
24299
|
"plural": "fuel_surcharge_ratecard_fees",
|
|
@@ -24069,6 +24303,12 @@
|
|
|
24069
24303
|
"required": true,
|
|
24070
24304
|
"attributes": [],
|
|
24071
24305
|
"annotations": []
|
|
24306
|
+
}, {
|
|
24307
|
+
"name": "fuel_surcharge_rate",
|
|
24308
|
+
"type": "fuel_surcharge_rate",
|
|
24309
|
+
"required": false,
|
|
24310
|
+
"attributes": [],
|
|
24311
|
+
"annotations": []
|
|
24072
24312
|
}],
|
|
24073
24313
|
"attributes": [],
|
|
24074
24314
|
"interfaces": []
|
|
@@ -25231,6 +25471,13 @@
|
|
|
25231
25471
|
"attributes": [],
|
|
25232
25472
|
"annotations": [],
|
|
25233
25473
|
"description": "Fees applicable for this estimate"
|
|
25474
|
+
}, {
|
|
25475
|
+
"name": "weight_break",
|
|
25476
|
+
"type": "decimal",
|
|
25477
|
+
"required": false,
|
|
25478
|
+
"attributes": [],
|
|
25479
|
+
"annotations": [],
|
|
25480
|
+
"description": "weight from the rate used to calculate cost"
|
|
25234
25481
|
}, {
|
|
25235
25482
|
"name": "total",
|
|
25236
25483
|
"type": "double",
|
|
@@ -28159,6 +28406,27 @@
|
|
|
28159
28406
|
}],
|
|
28160
28407
|
"attributes": [],
|
|
28161
28408
|
"interfaces": []
|
|
28409
|
+
}, {
|
|
28410
|
+
"name": "label_base",
|
|
28411
|
+
"plural": "label_bases",
|
|
28412
|
+
"fields": [{
|
|
28413
|
+
"name": "amount",
|
|
28414
|
+
"type": "decimal",
|
|
28415
|
+
"required": true,
|
|
28416
|
+
"attributes": [],
|
|
28417
|
+
"annotations": [],
|
|
28418
|
+
"description": "The base rate card charge (based on weight, before fees)"
|
|
28419
|
+
}, {
|
|
28420
|
+
"name": "weight",
|
|
28421
|
+
"type": "decimal",
|
|
28422
|
+
"required": true,
|
|
28423
|
+
"attributes": [],
|
|
28424
|
+
"annotations": [],
|
|
28425
|
+
"description": "The actual weight used for ratecard lookup",
|
|
28426
|
+
"minimum": 0
|
|
28427
|
+
}],
|
|
28428
|
+
"attributes": [],
|
|
28429
|
+
"interfaces": []
|
|
28162
28430
|
}, {
|
|
28163
28431
|
"name": "label_deleted_v2",
|
|
28164
28432
|
"plural": "label_deleted_v2s",
|
|
@@ -28291,6 +28559,67 @@
|
|
|
28291
28559
|
}],
|
|
28292
28560
|
"attributes": [],
|
|
28293
28561
|
"interfaces": []
|
|
28562
|
+
}, {
|
|
28563
|
+
"name": "label_surcharge",
|
|
28564
|
+
"plural": "label_surcharges",
|
|
28565
|
+
"fields": [{
|
|
28566
|
+
"name": "amount",
|
|
28567
|
+
"type": "decimal",
|
|
28568
|
+
"required": true,
|
|
28569
|
+
"attributes": [],
|
|
28570
|
+
"annotations": []
|
|
28571
|
+
}, {
|
|
28572
|
+
"name": "type",
|
|
28573
|
+
"type": "trueup_surcharge_type",
|
|
28574
|
+
"required": true,
|
|
28575
|
+
"attributes": [],
|
|
28576
|
+
"annotations": []
|
|
28577
|
+
}, {
|
|
28578
|
+
"name": "detail",
|
|
28579
|
+
"type": "label_surcharge_detail",
|
|
28580
|
+
"required": true,
|
|
28581
|
+
"attributes": [],
|
|
28582
|
+
"annotations": []
|
|
28583
|
+
}],
|
|
28584
|
+
"attributes": [],
|
|
28585
|
+
"interfaces": []
|
|
28586
|
+
}, {
|
|
28587
|
+
"name": "label_surcharge_detail_flat",
|
|
28588
|
+
"plural": "label_surcharge_detail_flats",
|
|
28589
|
+
"fields": [{
|
|
28590
|
+
"name": "placeholder",
|
|
28591
|
+
"type": "string",
|
|
28592
|
+
"required": false,
|
|
28593
|
+
"attributes": [],
|
|
28594
|
+
"annotations": []
|
|
28595
|
+
}],
|
|
28596
|
+
"attributes": [],
|
|
28597
|
+
"interfaces": []
|
|
28598
|
+
}, {
|
|
28599
|
+
"name": "label_surcharge_detail_per_weight_unit",
|
|
28600
|
+
"plural": "label_surcharge_detail_per_weight_units",
|
|
28601
|
+
"fields": [{
|
|
28602
|
+
"name": "fee",
|
|
28603
|
+
"type": "decimal",
|
|
28604
|
+
"required": true,
|
|
28605
|
+
"attributes": [],
|
|
28606
|
+
"annotations": [],
|
|
28607
|
+
"description": "eg. $0.04 / pound - the fee would be .04"
|
|
28608
|
+
}],
|
|
28609
|
+
"attributes": [],
|
|
28610
|
+
"interfaces": []
|
|
28611
|
+
}, {
|
|
28612
|
+
"name": "label_surcharge_detail_percentage",
|
|
28613
|
+
"plural": "label_surcharge_detail_percentages",
|
|
28614
|
+
"fields": [{
|
|
28615
|
+
"name": "percentage",
|
|
28616
|
+
"type": "decimal",
|
|
28617
|
+
"required": true,
|
|
28618
|
+
"attributes": [],
|
|
28619
|
+
"annotations": []
|
|
28620
|
+
}],
|
|
28621
|
+
"attributes": [],
|
|
28622
|
+
"interfaces": []
|
|
28294
28623
|
}, {
|
|
28295
28624
|
"name": "label_tracking_carrier_service",
|
|
28296
28625
|
"plural": "label_tracking_carrier_services",
|
|
@@ -28387,6 +28716,34 @@
|
|
|
28387
28716
|
}],
|
|
28388
28717
|
"attributes": [],
|
|
28389
28718
|
"interfaces": []
|
|
28719
|
+
}, {
|
|
28720
|
+
"name": "label_units",
|
|
28721
|
+
"plural": "label_units",
|
|
28722
|
+
"fields": [{
|
|
28723
|
+
"name": "currency",
|
|
28724
|
+
"type": "string",
|
|
28725
|
+
"required": true,
|
|
28726
|
+
"attributes": [],
|
|
28727
|
+
"annotations": [],
|
|
28728
|
+
"example": "USD"
|
|
28729
|
+
}, {
|
|
28730
|
+
"name": "weight",
|
|
28731
|
+
"type": "unit_of_weight",
|
|
28732
|
+
"required": true,
|
|
28733
|
+
"attributes": [],
|
|
28734
|
+
"annotations": [],
|
|
28735
|
+
"example": "pound"
|
|
28736
|
+
}, {
|
|
28737
|
+
"name": "length",
|
|
28738
|
+
"type": "unit_of_length",
|
|
28739
|
+
"required": true,
|
|
28740
|
+
"attributes": [],
|
|
28741
|
+
"annotations": [],
|
|
28742
|
+
"example": "pound"
|
|
28743
|
+
}],
|
|
28744
|
+
"attributes": [],
|
|
28745
|
+
"interfaces": [],
|
|
28746
|
+
"description": "Describes the units that are then used consistently throughout all the data in the label invoice request"
|
|
28390
28747
|
}, {
|
|
28391
28748
|
"name": "label_upserted",
|
|
28392
28749
|
"plural": "label_upserteds",
|
|
@@ -35643,6 +36000,24 @@
|
|
|
35643
36000
|
"required": false,
|
|
35644
36001
|
"attributes": [],
|
|
35645
36002
|
"annotations": []
|
|
36003
|
+
}, {
|
|
36004
|
+
"name": "created_at",
|
|
36005
|
+
"type": "date-time-iso8601",
|
|
36006
|
+
"required": true,
|
|
36007
|
+
"attributes": [],
|
|
36008
|
+
"annotations": []
|
|
36009
|
+
}, {
|
|
36010
|
+
"name": "updated_at",
|
|
36011
|
+
"type": "date-time-iso8601",
|
|
36012
|
+
"required": true,
|
|
36013
|
+
"attributes": [],
|
|
36014
|
+
"annotations": []
|
|
36015
|
+
}, {
|
|
36016
|
+
"name": "deleted_at",
|
|
36017
|
+
"type": "date-time-iso8601",
|
|
36018
|
+
"required": false,
|
|
36019
|
+
"attributes": [],
|
|
36020
|
+
"annotations": []
|
|
35646
36021
|
}],
|
|
35647
36022
|
"attributes": [],
|
|
35648
36023
|
"interfaces": ["pending_payout_transaction"],
|
|
@@ -38417,6 +38792,13 @@
|
|
|
38417
38792
|
"attributes": [],
|
|
38418
38793
|
"annotations": [],
|
|
38419
38794
|
"description": "Information about the payment processor account that was used for the operation"
|
|
38795
|
+
}, {
|
|
38796
|
+
"name": "transaction_details",
|
|
38797
|
+
"type": "payment_processor_transaction_details",
|
|
38798
|
+
"required": false,
|
|
38799
|
+
"attributes": [],
|
|
38800
|
+
"annotations": [],
|
|
38801
|
+
"description": "Raw values from the PSP for common transaction data elements"
|
|
38420
38802
|
}],
|
|
38421
38803
|
"attributes": [],
|
|
38422
38804
|
"interfaces": [],
|
|
@@ -38511,6 +38893,62 @@
|
|
|
38511
38893
|
}],
|
|
38512
38894
|
"attributes": [],
|
|
38513
38895
|
"interfaces": []
|
|
38896
|
+
}, {
|
|
38897
|
+
"name": "payment_processor_transaction_details_card",
|
|
38898
|
+
"plural": "payment_processor_transaction_details_cards",
|
|
38899
|
+
"fields": [{
|
|
38900
|
+
"name": "transaction_identifier",
|
|
38901
|
+
"type": "string",
|
|
38902
|
+
"required": false,
|
|
38903
|
+
"attributes": [],
|
|
38904
|
+
"annotations": [],
|
|
38905
|
+
"description": "The most specific PSP identifier for an authorization attempt / result"
|
|
38906
|
+
}, {
|
|
38907
|
+
"name": "method_type",
|
|
38908
|
+
"type": "string",
|
|
38909
|
+
"required": false,
|
|
38910
|
+
"attributes": [],
|
|
38911
|
+
"annotations": [],
|
|
38912
|
+
"description": "The PSP's identification of the payment method subtype, e.g. card brand or payment method within a wallet"
|
|
38913
|
+
}, {
|
|
38914
|
+
"name": "result_status",
|
|
38915
|
+
"type": "string",
|
|
38916
|
+
"required": false,
|
|
38917
|
+
"attributes": [],
|
|
38918
|
+
"annotations": [],
|
|
38919
|
+
"description": "The transaction's raw result status"
|
|
38920
|
+
}, {
|
|
38921
|
+
"name": "reason_code",
|
|
38922
|
+
"type": "string",
|
|
38923
|
+
"required": false,
|
|
38924
|
+
"attributes": [],
|
|
38925
|
+
"annotations": [],
|
|
38926
|
+
"description": "The transaction's raw reason code"
|
|
38927
|
+
}, {
|
|
38928
|
+
"name": "avs_result_code",
|
|
38929
|
+
"type": "string",
|
|
38930
|
+
"required": false,
|
|
38931
|
+
"attributes": [],
|
|
38932
|
+
"annotations": [],
|
|
38933
|
+
"description": "The transaction's raw avs code"
|
|
38934
|
+
}, {
|
|
38935
|
+
"name": "cvv_result_code",
|
|
38936
|
+
"type": "string",
|
|
38937
|
+
"required": false,
|
|
38938
|
+
"attributes": [],
|
|
38939
|
+
"annotations": [],
|
|
38940
|
+
"description": "The transaction's raw cvv code"
|
|
38941
|
+
}, {
|
|
38942
|
+
"name": "threeds_result_code",
|
|
38943
|
+
"type": "string",
|
|
38944
|
+
"required": false,
|
|
38945
|
+
"attributes": [],
|
|
38946
|
+
"annotations": [],
|
|
38947
|
+
"description": "The transaction's raw 3ds code"
|
|
38948
|
+
}],
|
|
38949
|
+
"attributes": [],
|
|
38950
|
+
"interfaces": ["payment_processor_transaction_details"],
|
|
38951
|
+
"description": "Data elements gathered from the PSP's authorization messages. Format will differ by PSP."
|
|
38514
38952
|
}, {
|
|
38515
38953
|
"name": "payment_reference",
|
|
38516
38954
|
"plural": "payment_references",
|
|
@@ -46824,19 +47262,19 @@
|
|
|
46824
47262
|
"plural": "shipping_label_hop_cost_itemized_estimates",
|
|
46825
47263
|
"fields": [{
|
|
46826
47264
|
"name": "units",
|
|
46827
|
-
"type": "
|
|
47265
|
+
"type": "label_units",
|
|
46828
47266
|
"required": true,
|
|
46829
47267
|
"attributes": [],
|
|
46830
47268
|
"annotations": []
|
|
46831
47269
|
}, {
|
|
46832
47270
|
"name": "base",
|
|
46833
|
-
"type": "
|
|
47271
|
+
"type": "label_base",
|
|
46834
47272
|
"required": true,
|
|
46835
47273
|
"attributes": [],
|
|
46836
47274
|
"annotations": []
|
|
46837
47275
|
}, {
|
|
46838
47276
|
"name": "surcharges",
|
|
46839
|
-
"type": "[
|
|
47277
|
+
"type": "[label_surcharge]",
|
|
46840
47278
|
"required": true,
|
|
46841
47279
|
"attributes": [],
|
|
46842
47280
|
"annotations": []
|
|
@@ -46886,6 +47324,12 @@
|
|
|
46886
47324
|
"required": true,
|
|
46887
47325
|
"attributes": [],
|
|
46888
47326
|
"annotations": []
|
|
47327
|
+
}, {
|
|
47328
|
+
"name": "weight_break",
|
|
47329
|
+
"type": "decimal",
|
|
47330
|
+
"required": false,
|
|
47331
|
+
"attributes": [],
|
|
47332
|
+
"annotations": []
|
|
46889
47333
|
}],
|
|
46890
47334
|
"attributes": [],
|
|
46891
47335
|
"interfaces": []
|
|
@@ -52705,6 +53149,37 @@
|
|
|
52705
53149
|
}],
|
|
52706
53150
|
"attributes": [],
|
|
52707
53151
|
"interfaces": []
|
|
53152
|
+
}, {
|
|
53153
|
+
"name": "transaction_metadata_manual",
|
|
53154
|
+
"plural": "transaction_metadata_manuals",
|
|
53155
|
+
"fields": [{
|
|
53156
|
+
"name": "original",
|
|
53157
|
+
"type": "transaction_metadata_original_transaction",
|
|
53158
|
+
"required": false,
|
|
53159
|
+
"attributes": [],
|
|
53160
|
+
"annotations": []
|
|
53161
|
+
}, {
|
|
53162
|
+
"name": "url",
|
|
53163
|
+
"type": "string",
|
|
53164
|
+
"required": false,
|
|
53165
|
+
"attributes": [],
|
|
53166
|
+
"annotations": []
|
|
53167
|
+
}],
|
|
53168
|
+
"attributes": [],
|
|
53169
|
+
"interfaces": []
|
|
53170
|
+
}, {
|
|
53171
|
+
"name": "transaction_metadata_original_transaction",
|
|
53172
|
+
"plural": "transaction_metadata_original_transactions",
|
|
53173
|
+
"fields": [{
|
|
53174
|
+
"name": "id",
|
|
53175
|
+
"type": "string",
|
|
53176
|
+
"required": true,
|
|
53177
|
+
"attributes": [],
|
|
53178
|
+
"annotations": [],
|
|
53179
|
+
"description": "Globally unique identifier"
|
|
53180
|
+
}],
|
|
53181
|
+
"attributes": [],
|
|
53182
|
+
"interfaces": []
|
|
52708
53183
|
}, {
|
|
52709
53184
|
"name": "transaction_metadata_shipping_label",
|
|
52710
53185
|
"plural": "transaction_metadata_shipping_labels",
|
|
@@ -52714,6 +53189,31 @@
|
|
|
52714
53189
|
"required": false,
|
|
52715
53190
|
"attributes": [],
|
|
52716
53191
|
"annotations": []
|
|
53192
|
+
}, {
|
|
53193
|
+
"name": "carrier",
|
|
53194
|
+
"type": "transaction_metadata_shipping_label_carrier",
|
|
53195
|
+
"required": true,
|
|
53196
|
+
"attributes": [],
|
|
53197
|
+
"annotations": []
|
|
53198
|
+
}],
|
|
53199
|
+
"attributes": [],
|
|
53200
|
+
"interfaces": []
|
|
53201
|
+
}, {
|
|
53202
|
+
"name": "transaction_metadata_shipping_label_carrier",
|
|
53203
|
+
"plural": "transaction_metadata_shipping_label_carriers",
|
|
53204
|
+
"fields": [{
|
|
53205
|
+
"name": "id",
|
|
53206
|
+
"type": "string",
|
|
53207
|
+
"required": true,
|
|
53208
|
+
"attributes": [],
|
|
53209
|
+
"annotations": [],
|
|
53210
|
+
"description": "The carrier id of this label. See https://api.flow.io/reference/carriers"
|
|
53211
|
+
}, {
|
|
53212
|
+
"name": "tracking_number",
|
|
53213
|
+
"type": "string",
|
|
53214
|
+
"required": true,
|
|
53215
|
+
"attributes": [],
|
|
53216
|
+
"annotations": []
|
|
52717
53217
|
}],
|
|
52718
53218
|
"attributes": [],
|
|
52719
53219
|
"interfaces": []
|
|
@@ -52722,7 +53222,7 @@
|
|
|
52722
53222
|
"plural": "transaction_metadata_trueups",
|
|
52723
53223
|
"fields": [{
|
|
52724
53224
|
"name": "original",
|
|
52725
|
-
"type": "
|
|
53225
|
+
"type": "transaction_metadata_original_transaction",
|
|
52726
53226
|
"required": true,
|
|
52727
53227
|
"attributes": [],
|
|
52728
53228
|
"annotations": []
|
|
@@ -52774,19 +53274,18 @@
|
|
|
52774
53274
|
"required": true,
|
|
52775
53275
|
"attributes": [],
|
|
52776
53276
|
"annotations": []
|
|
52777
|
-
}
|
|
52778
|
-
|
|
52779
|
-
|
|
52780
|
-
|
|
52781
|
-
"name": "transaction_metadata_trueup_original_transaction",
|
|
52782
|
-
"plural": "transaction_metadata_trueup_original_transactions",
|
|
52783
|
-
"fields": [{
|
|
52784
|
-
"name": "id",
|
|
52785
|
-
"type": "string",
|
|
52786
|
-
"required": true,
|
|
53277
|
+
}, {
|
|
53278
|
+
"name": "dead",
|
|
53279
|
+
"type": "dead_weight",
|
|
53280
|
+
"required": false,
|
|
52787
53281
|
"attributes": [],
|
|
52788
|
-
"annotations": []
|
|
52789
|
-
|
|
53282
|
+
"annotations": []
|
|
53283
|
+
}, {
|
|
53284
|
+
"name": "dimensional",
|
|
53285
|
+
"type": "dimensional_weight",
|
|
53286
|
+
"required": false,
|
|
53287
|
+
"attributes": [],
|
|
53288
|
+
"annotations": []
|
|
52790
53289
|
}],
|
|
52791
53290
|
"attributes": [],
|
|
52792
53291
|
"interfaces": []
|
|
@@ -72697,6 +73196,62 @@
|
|
|
72697
73196
|
"type": "bridge_manifest_form",
|
|
72698
73197
|
"attributes": []
|
|
72699
73198
|
}
|
|
73199
|
+
}, {
|
|
73200
|
+
"method": "GET",
|
|
73201
|
+
"path": "/:organization/manifests/centers/:center_key/services/:service/outstanding",
|
|
73202
|
+
"parameters": [{
|
|
73203
|
+
"name": "organization",
|
|
73204
|
+
"type": "string",
|
|
73205
|
+
"location": "Path",
|
|
73206
|
+
"required": true,
|
|
73207
|
+
"description": "Refers to your organization's account identifier"
|
|
73208
|
+
}, {
|
|
73209
|
+
"name": "center_key",
|
|
73210
|
+
"type": "string",
|
|
73211
|
+
"location": "Path",
|
|
73212
|
+
"required": true,
|
|
73213
|
+
"example": "12345678912"
|
|
73214
|
+
}, {
|
|
73215
|
+
"name": "service",
|
|
73216
|
+
"type": "string",
|
|
73217
|
+
"location": "Path",
|
|
73218
|
+
"required": true,
|
|
73219
|
+
"example": "dhl-express-worldwide"
|
|
73220
|
+
}],
|
|
73221
|
+
"responses": [{
|
|
73222
|
+
"code": {
|
|
73223
|
+
"integer": {
|
|
73224
|
+
"value": 302
|
|
73225
|
+
}
|
|
73226
|
+
},
|
|
73227
|
+
"type": "string",
|
|
73228
|
+
"attributes": []
|
|
73229
|
+
}, {
|
|
73230
|
+
"code": {
|
|
73231
|
+
"integer": {
|
|
73232
|
+
"value": 404
|
|
73233
|
+
}
|
|
73234
|
+
},
|
|
73235
|
+
"type": "unit",
|
|
73236
|
+
"description": "Resource was not found",
|
|
73237
|
+
"attributes": []
|
|
73238
|
+
}, {
|
|
73239
|
+
"code": {
|
|
73240
|
+
"integer": {
|
|
73241
|
+
"value": 422
|
|
73242
|
+
}
|
|
73243
|
+
},
|
|
73244
|
+
"type": "generic_error",
|
|
73245
|
+
"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.",
|
|
73246
|
+
"attributes": []
|
|
73247
|
+
}],
|
|
73248
|
+
"attributes": [{
|
|
73249
|
+
"name": "linter",
|
|
73250
|
+
"value": {
|
|
73251
|
+
"ignore": ["response_codes"]
|
|
73252
|
+
}
|
|
73253
|
+
}],
|
|
73254
|
+
"description": "Generates a new manifest with all outstanding labels for a given center and redirects to a downloadable PDF of carrier-generated manifest or bill of lading (BOL). If no outstanding labels, this will generate a 422 error."
|
|
72700
73255
|
}, {
|
|
72701
73256
|
"method": "GET",
|
|
72702
73257
|
"path": "/:organization/manifests/services/:service/outstanding",
|
|
@@ -80788,7 +81343,111 @@
|
|
|
80788
81343
|
"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.",
|
|
80789
81344
|
"attributes": []
|
|
80790
81345
|
}],
|
|
80791
|
-
"attributes": []
|
|
81346
|
+
"attributes": []
|
|
81347
|
+
}],
|
|
81348
|
+
"attributes": [{
|
|
81349
|
+
"name": "docs",
|
|
81350
|
+
"value": {
|
|
81351
|
+
"module": "general"
|
|
81352
|
+
}
|
|
81353
|
+
}],
|
|
81354
|
+
"path": "/channel/:channel/bank/accounts"
|
|
81355
|
+
}, {
|
|
81356
|
+
"type": "channel_currency_pair",
|
|
81357
|
+
"plural": "channel_currency_pairs",
|
|
81358
|
+
"operations": [{
|
|
81359
|
+
"method": "GET",
|
|
81360
|
+
"path": "/channel/:channel_id/currency/pairs",
|
|
81361
|
+
"parameters": [{
|
|
81362
|
+
"name": "channel_id",
|
|
81363
|
+
"type": "string",
|
|
81364
|
+
"location": "Path",
|
|
81365
|
+
"required": true
|
|
81366
|
+
}, {
|
|
81367
|
+
"name": "id",
|
|
81368
|
+
"type": "[string]",
|
|
81369
|
+
"location": "Query",
|
|
81370
|
+
"required": false,
|
|
81371
|
+
"description": "Filter by one or more IDs of this resource",
|
|
81372
|
+
"maximum": 100
|
|
81373
|
+
}, {
|
|
81374
|
+
"name": "limit",
|
|
81375
|
+
"type": "long",
|
|
81376
|
+
"location": "Query",
|
|
81377
|
+
"required": true,
|
|
81378
|
+
"description": "The maximum number of results to return",
|
|
81379
|
+
"default": "25",
|
|
81380
|
+
"minimum": 1,
|
|
81381
|
+
"maximum": 1000
|
|
81382
|
+
}, {
|
|
81383
|
+
"name": "offset",
|
|
81384
|
+
"type": "long",
|
|
81385
|
+
"location": "Query",
|
|
81386
|
+
"required": true,
|
|
81387
|
+
"description": "The number of results to skip before returning results",
|
|
81388
|
+
"default": "0",
|
|
81389
|
+
"minimum": 0
|
|
81390
|
+
}, {
|
|
81391
|
+
"name": "sort",
|
|
81392
|
+
"type": "string",
|
|
81393
|
+
"location": "Query",
|
|
81394
|
+
"required": true,
|
|
81395
|
+
"default": "id"
|
|
81396
|
+
}],
|
|
81397
|
+
"responses": [{
|
|
81398
|
+
"code": {
|
|
81399
|
+
"integer": {
|
|
81400
|
+
"value": 200
|
|
81401
|
+
}
|
|
81402
|
+
},
|
|
81403
|
+
"type": "[channel_currency_pair]",
|
|
81404
|
+
"description": "Successful response",
|
|
81405
|
+
"attributes": []
|
|
81406
|
+
}, {
|
|
81407
|
+
"code": {
|
|
81408
|
+
"integer": {
|
|
81409
|
+
"value": 401
|
|
81410
|
+
}
|
|
81411
|
+
},
|
|
81412
|
+
"type": "unit",
|
|
81413
|
+
"description": "Authorization failed",
|
|
81414
|
+
"attributes": []
|
|
81415
|
+
}, {
|
|
81416
|
+
"code": {
|
|
81417
|
+
"integer": {
|
|
81418
|
+
"value": 404
|
|
81419
|
+
}
|
|
81420
|
+
},
|
|
81421
|
+
"type": "unit",
|
|
81422
|
+
"description": "Resource was not found",
|
|
81423
|
+
"attributes": []
|
|
81424
|
+
}, {
|
|
81425
|
+
"code": {
|
|
81426
|
+
"integer": {
|
|
81427
|
+
"value": 422
|
|
81428
|
+
}
|
|
81429
|
+
},
|
|
81430
|
+
"type": "generic_error",
|
|
81431
|
+
"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.",
|
|
81432
|
+
"attributes": []
|
|
81433
|
+
}],
|
|
81434
|
+
"attributes": [{
|
|
81435
|
+
"name": "sort",
|
|
81436
|
+
"value": {
|
|
81437
|
+
"values": [{
|
|
81438
|
+
"value": "id"
|
|
81439
|
+
}, {
|
|
81440
|
+
"value": "base"
|
|
81441
|
+
}, {
|
|
81442
|
+
"value": "target"
|
|
81443
|
+
}]
|
|
81444
|
+
}
|
|
81445
|
+
}, {
|
|
81446
|
+
"name": "linter",
|
|
81447
|
+
"value": {
|
|
81448
|
+
"ignore": ["get", "sort_parameter_default", "common_parameter_types"]
|
|
81449
|
+
}
|
|
81450
|
+
}]
|
|
80792
81451
|
}],
|
|
80793
81452
|
"attributes": [{
|
|
80794
81453
|
"name": "docs",
|
|
@@ -80796,7 +81455,8 @@
|
|
|
80796
81455
|
"module": "general"
|
|
80797
81456
|
}
|
|
80798
81457
|
}],
|
|
80799
|
-
"path": "/channel/:
|
|
81458
|
+
"path": "/channel/:channel_id/currency/pairs",
|
|
81459
|
+
"description": "Represents an organization-specific currency conversion rate at a point in time."
|
|
80800
81460
|
}, {
|
|
80801
81461
|
"type": "channel_default_bank_account",
|
|
80802
81462
|
"plural": "channel_default_bank_accounts",
|
|
@@ -81497,6 +82157,12 @@
|
|
|
81497
82157
|
"type": "date-time-iso8601",
|
|
81498
82158
|
"location": "Query",
|
|
81499
82159
|
"required": false,
|
|
82160
|
+
"description": "If specified, we return all pending payout transactions where created_at >= the provided timestamp"
|
|
82161
|
+
}, {
|
|
82162
|
+
"name": "updated_since",
|
|
82163
|
+
"type": "date-time-iso8601",
|
|
82164
|
+
"location": "Query",
|
|
82165
|
+
"required": false,
|
|
81500
82166
|
"description": "If specified, we return all pending payout transactions where updated_at >= the provided timestamp"
|
|
81501
82167
|
}, {
|
|
81502
82168
|
"name": "limit",
|
|
@@ -83233,6 +83899,54 @@
|
|
|
83233
83899
|
"type": "country_of_origin",
|
|
83234
83900
|
"plural": "country_of_origins",
|
|
83235
83901
|
"operations": [{
|
|
83902
|
+
"method": "GET",
|
|
83903
|
+
"path": "/:organization/shopify/merchant/config/country/of/origin",
|
|
83904
|
+
"parameters": [{
|
|
83905
|
+
"name": "organization",
|
|
83906
|
+
"type": "string",
|
|
83907
|
+
"location": "Path",
|
|
83908
|
+
"required": true,
|
|
83909
|
+
"description": "Refers to your organization's account identifier"
|
|
83910
|
+
}],
|
|
83911
|
+
"responses": [{
|
|
83912
|
+
"code": {
|
|
83913
|
+
"integer": {
|
|
83914
|
+
"value": 200
|
|
83915
|
+
}
|
|
83916
|
+
},
|
|
83917
|
+
"type": "country_of_origin",
|
|
83918
|
+
"description": "Successful response",
|
|
83919
|
+
"attributes": []
|
|
83920
|
+
}, {
|
|
83921
|
+
"code": {
|
|
83922
|
+
"integer": {
|
|
83923
|
+
"value": 401
|
|
83924
|
+
}
|
|
83925
|
+
},
|
|
83926
|
+
"type": "unit",
|
|
83927
|
+
"description": "Authorization failed",
|
|
83928
|
+
"attributes": []
|
|
83929
|
+
}, {
|
|
83930
|
+
"code": {
|
|
83931
|
+
"integer": {
|
|
83932
|
+
"value": 404
|
|
83933
|
+
}
|
|
83934
|
+
},
|
|
83935
|
+
"type": "unit",
|
|
83936
|
+
"description": "Resource was not found",
|
|
83937
|
+
"attributes": []
|
|
83938
|
+
}, {
|
|
83939
|
+
"code": {
|
|
83940
|
+
"integer": {
|
|
83941
|
+
"value": 422
|
|
83942
|
+
}
|
|
83943
|
+
},
|
|
83944
|
+
"type": "generic_error",
|
|
83945
|
+
"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.",
|
|
83946
|
+
"attributes": []
|
|
83947
|
+
}],
|
|
83948
|
+
"attributes": []
|
|
83949
|
+
}, {
|
|
83236
83950
|
"method": "PUT",
|
|
83237
83951
|
"path": "/:organization/shopify/merchant/config/country/of/origin",
|
|
83238
83952
|
"parameters": [{
|
|
@@ -90639,6 +91353,116 @@
|
|
|
90639
91353
|
"type": "organization_onboarding_state",
|
|
90640
91354
|
"plural": "organization_onboarding_states",
|
|
90641
91355
|
"operations": [{
|
|
91356
|
+
"method": "PUT",
|
|
91357
|
+
"path": "/channel/:channel/organization/:organization/activate",
|
|
91358
|
+
"parameters": [{
|
|
91359
|
+
"name": "channel",
|
|
91360
|
+
"type": "string",
|
|
91361
|
+
"location": "Path",
|
|
91362
|
+
"required": true
|
|
91363
|
+
}, {
|
|
91364
|
+
"name": "organization",
|
|
91365
|
+
"type": "string",
|
|
91366
|
+
"location": "Path",
|
|
91367
|
+
"required": true,
|
|
91368
|
+
"description": "Refers to your organization's account identifier"
|
|
91369
|
+
}],
|
|
91370
|
+
"responses": [{
|
|
91371
|
+
"code": {
|
|
91372
|
+
"integer": {
|
|
91373
|
+
"value": 201
|
|
91374
|
+
}
|
|
91375
|
+
},
|
|
91376
|
+
"type": "organization_onboarding_state",
|
|
91377
|
+
"description": "Operation succeeded and the resource was created",
|
|
91378
|
+
"attributes": []
|
|
91379
|
+
}, {
|
|
91380
|
+
"code": {
|
|
91381
|
+
"integer": {
|
|
91382
|
+
"value": 401
|
|
91383
|
+
}
|
|
91384
|
+
},
|
|
91385
|
+
"type": "unit",
|
|
91386
|
+
"description": "Authorization failed",
|
|
91387
|
+
"attributes": []
|
|
91388
|
+
}, {
|
|
91389
|
+
"code": {
|
|
91390
|
+
"integer": {
|
|
91391
|
+
"value": 404
|
|
91392
|
+
}
|
|
91393
|
+
},
|
|
91394
|
+
"type": "unit",
|
|
91395
|
+
"description": "Resource was not found",
|
|
91396
|
+
"attributes": []
|
|
91397
|
+
}, {
|
|
91398
|
+
"code": {
|
|
91399
|
+
"integer": {
|
|
91400
|
+
"value": 422
|
|
91401
|
+
}
|
|
91402
|
+
},
|
|
91403
|
+
"type": "generic_error",
|
|
91404
|
+
"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.",
|
|
91405
|
+
"attributes": []
|
|
91406
|
+
}],
|
|
91407
|
+
"attributes": []
|
|
91408
|
+
}, {
|
|
91409
|
+
"method": "PUT",
|
|
91410
|
+
"path": "/channel/:channel/organization/:organization/deactivate",
|
|
91411
|
+
"parameters": [{
|
|
91412
|
+
"name": "channel",
|
|
91413
|
+
"type": "string",
|
|
91414
|
+
"location": "Path",
|
|
91415
|
+
"required": true
|
|
91416
|
+
}, {
|
|
91417
|
+
"name": "organization",
|
|
91418
|
+
"type": "string",
|
|
91419
|
+
"location": "Path",
|
|
91420
|
+
"required": true,
|
|
91421
|
+
"description": "Refers to your organization's account identifier"
|
|
91422
|
+
}],
|
|
91423
|
+
"responses": [{
|
|
91424
|
+
"code": {
|
|
91425
|
+
"integer": {
|
|
91426
|
+
"value": 201
|
|
91427
|
+
}
|
|
91428
|
+
},
|
|
91429
|
+
"type": "organization_onboarding_state",
|
|
91430
|
+
"description": "Operation succeeded and the resource was created",
|
|
91431
|
+
"attributes": []
|
|
91432
|
+
}, {
|
|
91433
|
+
"code": {
|
|
91434
|
+
"integer": {
|
|
91435
|
+
"value": 401
|
|
91436
|
+
}
|
|
91437
|
+
},
|
|
91438
|
+
"type": "unit",
|
|
91439
|
+
"description": "Authorization failed",
|
|
91440
|
+
"attributes": []
|
|
91441
|
+
}, {
|
|
91442
|
+
"code": {
|
|
91443
|
+
"integer": {
|
|
91444
|
+
"value": 404
|
|
91445
|
+
}
|
|
91446
|
+
},
|
|
91447
|
+
"type": "unit",
|
|
91448
|
+
"description": "Resource was not found",
|
|
91449
|
+
"attributes": []
|
|
91450
|
+
}, {
|
|
91451
|
+
"code": {
|
|
91452
|
+
"integer": {
|
|
91453
|
+
"value": 422
|
|
91454
|
+
}
|
|
91455
|
+
},
|
|
91456
|
+
"type": "generic_error",
|
|
91457
|
+
"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.",
|
|
91458
|
+
"attributes": []
|
|
91459
|
+
}],
|
|
91460
|
+
"attributes": [],
|
|
91461
|
+
"body": {
|
|
91462
|
+
"type": "deactivation_put_form",
|
|
91463
|
+
"attributes": []
|
|
91464
|
+
}
|
|
91465
|
+
}, {
|
|
90642
91466
|
"method": "GET",
|
|
90643
91467
|
"path": "/:organization/onboarding/state",
|
|
90644
91468
|
"parameters": [{
|
|
@@ -90797,7 +91621,7 @@
|
|
|
90797
91621
|
"module": "general"
|
|
90798
91622
|
}
|
|
90799
91623
|
}],
|
|
90800
|
-
"path": "
|
|
91624
|
+
"path": ""
|
|
90801
91625
|
}, {
|
|
90802
91626
|
"type": "organization_payout",
|
|
90803
91627
|
"plural": "organization_payouts",
|
|
@@ -90984,6 +91808,12 @@
|
|
|
90984
91808
|
"type": "date-time-iso8601",
|
|
90985
91809
|
"location": "Query",
|
|
90986
91810
|
"required": false,
|
|
91811
|
+
"description": "If specified, we return all pending payout transactions where created_at >= the provided timestamp"
|
|
91812
|
+
}, {
|
|
91813
|
+
"name": "updated_since",
|
|
91814
|
+
"type": "date-time-iso8601",
|
|
91815
|
+
"location": "Query",
|
|
91816
|
+
"required": false,
|
|
90987
91817
|
"description": "If specified, we return all pending payout transactions where updated_at >= the provided timestamp"
|
|
90988
91818
|
}, {
|
|
90989
91819
|
"name": "limit",
|
|
@@ -93254,13 +94084,19 @@
|
|
|
93254
94084
|
"plural": "sessions",
|
|
93255
94085
|
"operations": [{
|
|
93256
94086
|
"method": "POST",
|
|
93257
|
-
"path": "/sessions/
|
|
94087
|
+
"path": "/sessions/organizations/:organization",
|
|
93258
94088
|
"parameters": [{
|
|
93259
94089
|
"name": "organization",
|
|
93260
94090
|
"type": "string",
|
|
93261
94091
|
"location": "Path",
|
|
93262
94092
|
"required": true,
|
|
93263
94093
|
"description": "Refers to your organization's account identifier"
|
|
94094
|
+
}, {
|
|
94095
|
+
"name": "context",
|
|
94096
|
+
"type": "string",
|
|
94097
|
+
"location": "Query",
|
|
94098
|
+
"required": false,
|
|
94099
|
+
"description": "The session context"
|
|
93264
94100
|
}],
|
|
93265
94101
|
"responses": [{
|
|
93266
94102
|
"code": {
|
|
@@ -93294,7 +94130,7 @@
|
|
|
93294
94130
|
}
|
|
93295
94131
|
}, {
|
|
93296
94132
|
"method": "GET",
|
|
93297
|
-
"path": "/sessions
|
|
94133
|
+
"path": "/sessions/:session",
|
|
93298
94134
|
"parameters": [{
|
|
93299
94135
|
"name": "session",
|
|
93300
94136
|
"type": "string",
|
|
@@ -93329,12 +94165,18 @@
|
|
|
93329
94165
|
}]
|
|
93330
94166
|
}, {
|
|
93331
94167
|
"method": "PUT",
|
|
93332
|
-
"path": "/sessions
|
|
94168
|
+
"path": "/sessions/:session",
|
|
93333
94169
|
"parameters": [{
|
|
93334
94170
|
"name": "session",
|
|
93335
94171
|
"type": "string",
|
|
93336
94172
|
"location": "Path",
|
|
93337
94173
|
"required": true
|
|
94174
|
+
}, {
|
|
94175
|
+
"name": "context",
|
|
94176
|
+
"type": "string",
|
|
94177
|
+
"location": "Query",
|
|
94178
|
+
"required": false,
|
|
94179
|
+
"description": "The session context"
|
|
93338
94180
|
}],
|
|
93339
94181
|
"responses": [{
|
|
93340
94182
|
"code": {
|
|
@@ -93377,7 +94219,7 @@
|
|
|
93377
94219
|
}
|
|
93378
94220
|
}, {
|
|
93379
94221
|
"method": "DELETE",
|
|
93380
|
-
"path": "/sessions
|
|
94222
|
+
"path": "/sessions/:session",
|
|
93381
94223
|
"parameters": [{
|
|
93382
94224
|
"name": "session",
|
|
93383
94225
|
"type": "string",
|
|
@@ -93415,7 +94257,7 @@
|
|
|
93415
94257
|
"attributes": []
|
|
93416
94258
|
}, {
|
|
93417
94259
|
"method": "PUT",
|
|
93418
|
-
"path": "/sessions
|
|
94260
|
+
"path": "/sessions/:session/clear",
|
|
93419
94261
|
"parameters": [{
|
|
93420
94262
|
"name": "session",
|
|
93421
94263
|
"type": "string",
|
|
@@ -93460,7 +94302,7 @@
|
|
|
93460
94302
|
"description": "Clears the session geo parameters"
|
|
93461
94303
|
}, {
|
|
93462
94304
|
"method": "PUT",
|
|
93463
|
-
"path": "/sessions
|
|
94305
|
+
"path": "/sessions/:session/organizations/:organization",
|
|
93464
94306
|
"parameters": [{
|
|
93465
94307
|
"name": "session",
|
|
93466
94308
|
"type": "string",
|
|
@@ -93472,6 +94314,12 @@
|
|
|
93472
94314
|
"location": "Path",
|
|
93473
94315
|
"required": true,
|
|
93474
94316
|
"description": "Refers to your organization's account identifier"
|
|
94317
|
+
}, {
|
|
94318
|
+
"name": "context",
|
|
94319
|
+
"type": "string",
|
|
94320
|
+
"location": "Query",
|
|
94321
|
+
"required": false,
|
|
94322
|
+
"description": "The session context"
|
|
93475
94323
|
}],
|
|
93476
94324
|
"responses": [{
|
|
93477
94325
|
"code": {
|
|
@@ -93505,12 +94353,18 @@
|
|
|
93505
94353
|
}
|
|
93506
94354
|
}, {
|
|
93507
94355
|
"method": "PUT",
|
|
93508
|
-
"path": "/sessions
|
|
94356
|
+
"path": "/sessions/:session/reset",
|
|
93509
94357
|
"parameters": [{
|
|
93510
94358
|
"name": "session",
|
|
93511
94359
|
"type": "string",
|
|
93512
94360
|
"location": "Path",
|
|
93513
94361
|
"required": true
|
|
94362
|
+
}, {
|
|
94363
|
+
"name": "context",
|
|
94364
|
+
"type": "string",
|
|
94365
|
+
"location": "Query",
|
|
94366
|
+
"required": false,
|
|
94367
|
+
"description": "The session context"
|
|
93514
94368
|
}],
|
|
93515
94369
|
"responses": [{
|
|
93516
94370
|
"code": {
|
|
@@ -93554,19 +94408,13 @@
|
|
|
93554
94408
|
}
|
|
93555
94409
|
}, {
|
|
93556
94410
|
"method": "POST",
|
|
93557
|
-
"path": "/sessions/organizations/:organization",
|
|
94411
|
+
"path": "/sessions/shopify/organizations/:organization",
|
|
93558
94412
|
"parameters": [{
|
|
93559
94413
|
"name": "organization",
|
|
93560
94414
|
"type": "string",
|
|
93561
94415
|
"location": "Path",
|
|
93562
94416
|
"required": true,
|
|
93563
94417
|
"description": "Refers to your organization's account identifier"
|
|
93564
|
-
}, {
|
|
93565
|
-
"name": "context",
|
|
93566
|
-
"type": "string",
|
|
93567
|
-
"location": "Query",
|
|
93568
|
-
"required": false,
|
|
93569
|
-
"description": "The session context"
|
|
93570
94418
|
}],
|
|
93571
94419
|
"responses": [{
|
|
93572
94420
|
"code": {
|
|
@@ -93600,7 +94448,7 @@
|
|
|
93600
94448
|
}
|
|
93601
94449
|
}, {
|
|
93602
94450
|
"method": "GET",
|
|
93603
|
-
"path": "/sessions/:session",
|
|
94451
|
+
"path": "/sessions/shopify/:session",
|
|
93604
94452
|
"parameters": [{
|
|
93605
94453
|
"name": "session",
|
|
93606
94454
|
"type": "string",
|
|
@@ -93635,18 +94483,12 @@
|
|
|
93635
94483
|
}]
|
|
93636
94484
|
}, {
|
|
93637
94485
|
"method": "PUT",
|
|
93638
|
-
"path": "/sessions/:session",
|
|
94486
|
+
"path": "/sessions/shopify/:session",
|
|
93639
94487
|
"parameters": [{
|
|
93640
94488
|
"name": "session",
|
|
93641
94489
|
"type": "string",
|
|
93642
94490
|
"location": "Path",
|
|
93643
94491
|
"required": true
|
|
93644
|
-
}, {
|
|
93645
|
-
"name": "context",
|
|
93646
|
-
"type": "string",
|
|
93647
|
-
"location": "Query",
|
|
93648
|
-
"required": false,
|
|
93649
|
-
"description": "The session context"
|
|
93650
94492
|
}],
|
|
93651
94493
|
"responses": [{
|
|
93652
94494
|
"code": {
|
|
@@ -93689,7 +94531,7 @@
|
|
|
93689
94531
|
}
|
|
93690
94532
|
}, {
|
|
93691
94533
|
"method": "DELETE",
|
|
93692
|
-
"path": "/sessions/:session",
|
|
94534
|
+
"path": "/sessions/shopify/:session",
|
|
93693
94535
|
"parameters": [{
|
|
93694
94536
|
"name": "session",
|
|
93695
94537
|
"type": "string",
|
|
@@ -93727,7 +94569,7 @@
|
|
|
93727
94569
|
"attributes": []
|
|
93728
94570
|
}, {
|
|
93729
94571
|
"method": "PUT",
|
|
93730
|
-
"path": "/sessions/:session/clear",
|
|
94572
|
+
"path": "/sessions/shopify/:session/clear",
|
|
93731
94573
|
"parameters": [{
|
|
93732
94574
|
"name": "session",
|
|
93733
94575
|
"type": "string",
|
|
@@ -93772,7 +94614,7 @@
|
|
|
93772
94614
|
"description": "Clears the session geo parameters"
|
|
93773
94615
|
}, {
|
|
93774
94616
|
"method": "PUT",
|
|
93775
|
-
"path": "/sessions/:session/organizations/:organization",
|
|
94617
|
+
"path": "/sessions/shopify/:session/organizations/:organization",
|
|
93776
94618
|
"parameters": [{
|
|
93777
94619
|
"name": "session",
|
|
93778
94620
|
"type": "string",
|
|
@@ -93784,12 +94626,6 @@
|
|
|
93784
94626
|
"location": "Path",
|
|
93785
94627
|
"required": true,
|
|
93786
94628
|
"description": "Refers to your organization's account identifier"
|
|
93787
|
-
}, {
|
|
93788
|
-
"name": "context",
|
|
93789
|
-
"type": "string",
|
|
93790
|
-
"location": "Query",
|
|
93791
|
-
"required": false,
|
|
93792
|
-
"description": "The session context"
|
|
93793
94629
|
}],
|
|
93794
94630
|
"responses": [{
|
|
93795
94631
|
"code": {
|
|
@@ -93823,18 +94659,12 @@
|
|
|
93823
94659
|
}
|
|
93824
94660
|
}, {
|
|
93825
94661
|
"method": "PUT",
|
|
93826
|
-
"path": "/sessions/:session/reset",
|
|
94662
|
+
"path": "/sessions/shopify/:session/reset",
|
|
93827
94663
|
"parameters": [{
|
|
93828
94664
|
"name": "session",
|
|
93829
94665
|
"type": "string",
|
|
93830
94666
|
"location": "Path",
|
|
93831
94667
|
"required": true
|
|
93832
|
-
}, {
|
|
93833
|
-
"name": "context",
|
|
93834
|
-
"type": "string",
|
|
93835
|
-
"location": "Query",
|
|
93836
|
-
"required": false,
|
|
93837
|
-
"description": "The session context"
|
|
93838
94668
|
}],
|
|
93839
94669
|
"responses": [{
|
|
93840
94670
|
"code": {
|